IntenseWebs/pgadmin4
3
0
Fork 0
mirror of https://github.com/pgadmin-org/pgadmin4.git synced 2025-02-25 18:55:31 -06:00
Code Issues Packages Projects Releases Wiki Activity

Added docstrings for some newly created functions.

Browse Source
This commit is contained in:
Akshay Joshi
2020-07-15 18:07:54 +05:30
parent 522ddad72b
commit 5d8c79da38
9 changed files with 222 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
web/pgadmin/browser/server_groups/servers/databases/schemas/fts_configurations/__init__.py
View File

@@ -643,6 +643,12 @@ class FtsConfigurationView(PGChildNodeView, SchemaDiffObjectCompare):
)
def _get_sql_for_create(self, data, schema):
"""
This function is used to get the create sql.
:param data:
:param schema:
:return:
"""
# Replace schema oid with schema name
new_data = data.copy()
new_data['schema'] = schema
@@ -662,6 +668,12 @@ class FtsConfigurationView(PGChildNodeView, SchemaDiffObjectCompare):
@staticmethod
def _replace_schema_oid_with_schema_name(new_schema, new_data):
"""
This function is used to replace schema oid with schema name.
:param new_schema:
:param new_data:
:return:
"""
if 'schema' in new_data:
new_data['schema'] = new_schema

12
web/pgadmin/browser/server_groups/servers/databases/schemas/fts_dictionaries/__init__.py
View File

@@ -639,6 +639,12 @@ class FtsDictionaryView(PGChildNodeView, SchemaDiffObjectCompare):
)
def _get_sql_for_create(self, data, schema):
"""
This function is used to get the create sql.
:param data:
:param schema:
:return:
"""
# Replace schema oid with schema name
new_data = data.copy()
new_data['schema'] = schema
@@ -658,6 +664,12 @@ class FtsDictionaryView(PGChildNodeView, SchemaDiffObjectCompare):
return sql
def _check_template_name_and_schema_name(self, data, old_data):
"""
This function is used to check the template and schema name.
:param data:
:param old_data:
:return:
"""
if 'schema' not in data:
data['schema'] = old_data['schema']

13
web/pgadmin/browser/server_groups/servers/databases/schemas/fts_parsers/__init__.py
View File

@@ -585,11 +585,22 @@ class FtsParserView(PGChildNodeView, SchemaDiffObjectCompare):
@staticmethod
def _replace_schema_oid_with_name(new_data, new_schema):
"""
This function is used to replace schema oid with schema name.
:param new_data:
:param new_schema:
:return:
"""
if 'schema' in new_data:
new_data['schema'] = new_schema
def _get_sql_for_create(self, data, schema):
# Replace schema oid with schema name
"""
This function is used to get the create sql.
:param data:
:param schema:
:return:
"""
new_data = data.copy()
new_data['schema'] = schema

18
web/pgadmin/browser/server_groups/servers/databases/schemas/fts_templates/__init__.py
View File

@@ -543,10 +543,14 @@ class FtsTemplateView(PGChildNodeView, SchemaDiffObjectCompare):
status=200
)
def _replace_schema_oid_with_name(self, new_schema, old_data,
new_data):
# Replace schema oid with schema name
def _replace_schema_oid_with_name(self, new_schema, old_data, new_data):
"""
This function is used to Replace schema oid with schema name
:param new_schema:
:param old_data:
:param new_data:
:return:
"""
if 'schema' in new_data:
new_data['schema'] = new_schema
@@ -564,6 +568,12 @@ class FtsTemplateView(PGChildNodeView, SchemaDiffObjectCompare):
return False, ''
def _get_sql_for_create(self, data, schema):
"""
This function is used to get the create sql.
:param data:
:param schema:
:return:
"""
# Replace schema oid with schema name
new_data = data.copy()
new_data['schema'] = schema

138
web/pgadmin/browser/server_groups/servers/databases/schemas/functions/__init__.py
View File

@@ -249,22 +249,24 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
@staticmethod
def _create_wrap_data(req, key, data):
"""
This function is used to create data required by validate_request().
:param req:
:param key:
:param data:
:return:
"""
list_params = []
if request.method == 'GET':
list_params = ['arguments', 'variables', 'proacl',
'seclabels', 'acl', 'args']
if (
key in list_params and req[key] != '' and
req[key] is not None
):
if key in list_params and req[key] != '' and req[key] is not None:
# Coverts string into python list as expected.
data[key] = json.loads(req[key], encoding='utf-8')
elif (
key == 'proretset' or key == 'proisstrict' or
key == 'prosecdef' or key == 'proiswindow' or
key == 'proleakproof'
):
elif (key == 'proretset' or key == 'proisstrict' or
key == 'prosecdef' or key == 'proiswindow' or
key == 'proleakproof'):
if req[key] == 'true' or req[key] is True:
data[key] = True
else:
@@ -275,13 +277,22 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
@staticmethod
def _remove_parameters_for_c_lang(req, req_args):
# We need to remove 'prosrc' from the required arguments list
# if language is 'c'.
"""
This function is used to remove 'prosrc' from the required
arguments list if language is 'c'.
:param req:
:param req_args:
:return:
"""
if req['lanname'] == 'c' and 'prosrc' in req_args:
req_args.remove('prosrc')
@staticmethod
def _get_request_data():
"""
This function is used to get the request data.
:return:
"""
if request.data:
req = json.loads(request.data, encoding='utf-8')
else:
@@ -471,6 +482,12 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
)
def _get_argument_values(self, data):
"""
This function is used to get the argument values for
function/procedure.
:param data:
:return:
"""
proargtypes = [ptype for ptype in data['proargtypenames'].split(",")] \
if data['proargtypenames'] else []
proargmodes = data['proargmodes'] if data['proargmodes'] else \
@@ -489,6 +506,15 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
def _params_list_for_display(self, proargmodes_fltrd, proargtypes,
proargnames, proargdefaultvals):
"""
This function is used to prepare dictionary of arguments to
display on UI.
:param proargmodes_fltrd:
:param proargtypes:
:param proargnames:
:param proargdefaultvals:
:return:
"""
# Insert null value against the parameters which do not have
# default values.
if len(proargmodes_fltrd) > len(proargdefaultvals):
@@ -510,6 +536,14 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
def _display_properties_argument_list(self, proargmodes_fltrd,
proargtypes, proargnames,
proargdefaultvals):
"""
This function is used to prepare list of arguments to display on UI.
:param proargmodes_fltrd:
:param proargtypes:
:param proargnames:
:param proargdefaultvals:
:return:
"""
proargs = [self._map_arguments_list(
proargmodes_fltrd[i] if len(proargmodes_fltrd) > i else '',
proargtypes[i] if len(proargtypes) > i else '',
@@ -968,12 +1002,26 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
@staticmethod
def _check_argtype(args, args_without_name, a):
"""
This function is used to check the arg type.
:param args:
:param args_without_name:
:param a:
:return:
"""
if 'argtype' in a:
args += a['argtype']
args_without_name.append(a['argtype'])
return args, args_without_name
def _get_arguments(self, args_list, args, args_without_name):
"""
This function is used to get the arguments.
:param args_list:
:param args:
:param args_without_name:
:return:
"""
cnt = 1
for a in args_list:
if (
@@ -1002,6 +1050,11 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
cnt += 1
def _parse_privilege_data(self, resp_data):
"""
This function is used to parse the privilege data.
:param resp_data:
:return:
"""
# Parse privilege data
if 'acl' in resp_data:
resp_data['acl'] = parse_priv_to_db(resp_data['acl'], ['X'])
@@ -1010,8 +1063,12 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
resp_data['revoke_all'] = self._set_revoke_all(
resp_data['acl'])
def _get_schema_name_from_iod(self, resp_data):
# Get Schema Name from its OID.
def _get_schema_name_from_oid(self, resp_data):
"""
This function is used to get te schema name from OID.
:param resp_data:
:return:
"""
if 'pronamespace' in resp_data:
resp_data['pronamespace'] = self._get_schema(
resp_data['pronamespace'])
@@ -1063,7 +1120,7 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
)
# Get Schema Name from its OID.
self._get_schema_name_from_iod(resp_data)
self._get_schema_name_from_oid(resp_data)
sql = render_template("/".join([self.sql_template_path,
'get_definition.sql']
@@ -1099,7 +1156,7 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
object_type = 'function'
# Get Schema Name from its OID.
self._get_schema_name_from_iod(resp_data)
self._get_schema_name_from_oid(resp_data)
# Parse privilege data
self._parse_privilege_data(resp_data)
@@ -1181,9 +1238,13 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
@staticmethod
def _update_arguments_for_get_sql(data, old_data):
# If Function Definition/Arguments are changed then merge old
# Arguments with changed ones for Create/Replace Function
# SQL statement
"""
If Function Definition/Arguments are changed then merge old
Arguments with changed ones for Create/Replace Function SQL statement
:param data:
:param old_data:
:return:
"""
if 'arguments' in data and len(data['arguments']) > 0:
for arg in data['arguments']['changed']:
for old_arg in old_data['arguments']:
@@ -1196,6 +1257,12 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
@staticmethod
def _delete_variable_in_edit_mode(data, del_variables):
"""
This function is used to create variables that marked for delete.
:param data:
:param del_variables:
:return:
"""
if 'variables' in data and 'deleted' in data['variables']:
for v in data['variables']['deleted']:
del_variables[v['name']] = v['value']
@@ -1203,6 +1270,15 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
@staticmethod
def _prepare_final_dict(data, old_data, chngd_variables, del_variables,
all_ids_dict):
"""
This function is used to prepare the final dict.
:param data:
:param old_data:
:param chngd_variables:
:param del_variables:
:param all_ids_dict:
:return:
"""
# In case of schema diff we don't want variables from
# old data
if not all_ids_dict['is_schema_diff']:
@@ -1225,6 +1301,11 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
@staticmethod
def _parser_privilege(data):
"""
This function is used to parse the privilege data.
:param data:
:return:
"""
if 'acl' in data:
for key in ['added', 'deleted', 'changed']:
if key in data['acl']:
@@ -1233,6 +1314,12 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
@staticmethod
def _merge_variable_changes(data, chngd_variables):
"""
This function is used to merge the changed variables.
:param data:
:param chngd_variables:
:return:
"""
if 'variables' in data and 'changed' in data['variables']:
for v in data['variables']['changed']:
chngd_variables[v['name']] = v['value']
@@ -1243,6 +1330,11 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
@staticmethod
def _merge_variables(data):
"""
This function is used to prepare the merged variables.
:param data:
:return:
"""
if 'variables' in data and 'changed' in data['variables']:
for v in data['variables']['changed']:
data['merged_variables'].append(v)
@@ -1253,6 +1345,14 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
def _get_sql_for_edit_mode(self, data, parallel_dict, all_ids_dict,
vol_dict):
"""
This function is used to get the sql for edit mode.
:param data:
:param parallel_dict:
:param all_ids_dict:
:param vol_dict:
:return:
"""
if 'proparallel' in data and data['proparallel']:
data['proparallel'] = parallel_dict[data['proparallel']]
@@ -1352,7 +1452,7 @@ class FunctionView(PGChildNodeView, DataTypeReader, SchemaDiffObjectCompare):
parallel_dict = {'u': 'UNSAFE', 's': 'SAFE', 'r': 'RESTRICTED'}
# Get Schema Name from its OID.
self._get_schema_name_from_iod(data)
self._get_schema_name_from_oid(data)
if 'provolatile' in data:
data['provolatile'] = vol_dict[data['provolatile']]\

18
web/pgadmin/browser/server_groups/servers/databases/schemas/tables/__init__.py
View File

@@ -602,8 +602,12 @@ class TableView(BaseTableView, DataTypeReader, VacuumSettings,
@staticmethod
def _check_rlspolicy_support(res):
# Check whether 'rlspolicy' in response as it supported for
# version 9.5 and above
"""
This function is used to check whether 'rlspolicy' in response
as it supported for version 9.5 and above
:param res:
:return:
"""
if 'rlspolicy' in res['rows'][0]:
# Set the value of rls policy
if res['rows'][0]['rlspolicy'] == "true":
@@ -895,6 +899,11 @@ class TableView(BaseTableView, DataTypeReader, VacuumSettings,
return internal_server_error(errormsg=str(e))
def _parser_data_input_from_client(self, data):
"""
This function is used to parse the data.
:param data:
:return:
"""
# Parse privilege data coming from client according to database format
if 'relacl' in data:
data['relacl'] = parse_priv_to_db(data['relacl'], self.acl)
@@ -919,6 +928,11 @@ class TableView(BaseTableView, DataTypeReader, VacuumSettings,
c['remote_table'] = table
def _check_for_table_partitions(self, data):
"""
This function is used to check for table partition.
:param data:
:return:
"""
partitions_sql = ''
if self.is_table_partitioned(data):
data['relkind'] = 'p'

12
web/pgadmin/browser/server_groups/servers/databases/schemas/tables/indexes/__init__.py
View File

@@ -538,6 +538,12 @@ class IndexesView(PGChildNodeView, SchemaDiffObjectCompare):
@staticmethod
def _check_for_error(required_args, data):
"""
This function is used to check for any error.
:param required_args:
:param data:
:return:
"""
for arg in required_args:
err_msg = None
if arg == 'columns' and len(data['columns']) < 1:
@@ -1038,6 +1044,12 @@ class IndexesView(PGChildNodeView, SchemaDiffObjectCompare):
@staticmethod
def _check_for_create_req(required_create_keys, diff_dict):
"""
This function is used to check whether create required or not.
:param required_create_keys:
:param diff_dict:
:return:
"""
create_req = False
for key in required_create_keys:
if key in diff_dict and \

20
web/pgadmin/browser/server_groups/servers/databases/schemas/tables/indexes/utils.py
View File

@@ -60,6 +60,13 @@ def get_parent(conn, tid, template_path=None):
def _get_column_property_display_data(row, col_str, data):
"""
This function is used to get the columns data.
:param row:
:param col_str:
:param data:
:return:
"""
if row['collnspname']:
col_str += ' COLLATE ' + row['collnspname']
if row['opcname']:
@@ -162,7 +169,16 @@ def get_include_details(conn, idx, data, template_path=None):
return data
def _get_sql_with_index_none(data, template_path, conn, mode, name):
def _get_create_sql(data, template_path, conn, mode, name):
"""
This function is used to get the sql where index is None
:param data:
:param template_path:
:param conn:
:param mode:
:param name:
:return:
"""
required_args = {
'name': 'Name',
'columns': 'Columns'
@@ -245,7 +261,7 @@ def get_sql(conn, **kwargs):
data=data, o_data=old_data, conn=conn
)
else:
sql = _get_sql_with_index_none(data, template_path, conn, mode, name)
sql = _get_create_sql(data, template_path, conn, mode, name)
return sql, name

10
web/pgadmin/browser/server_groups/servers/databases/schemas/tables/utils.py
View File

@@ -856,15 +856,19 @@ class BaseTableView(PGChildNodeView, BasePartitionTable):
@staticmethod
def validate_constrains(key, data):
"""
This function is used to validate the constraints.
:param key:
:param data:
:return:
"""
if key == 'primary_key' or key == 'unique_constraint':
if 'columns' in data and len(data['columns']) > 0:
return True
else:
return False
elif key == 'foreign_key':
return BaseTableView._check_foreign_key()
return BaseTableView._check_foreign_key(data)
elif key == 'check_constraint':
return BaseTableView._check_constraint(data)