deriva.config package

Submodules

deriva.config.acl_config module

class deriva.config.acl_config.ACLSpec(specdict)

Bases: BaseSpec

validate()

class deriva.config.acl_config.ACLSpecList(dictlist=None)

Bases: BaseSpecList

class deriva.config.acl_config.AclCLI

Bases: ConfigBaseCLI

class deriva.config.acl_config.AclConfig(server, catalog_id, config_file, credentials, schema_name=None, table_name=None, verbose=False)

Bases: object

ACL_TYPES = ['catalog_acl', 'schema_acls', 'table_acls', 'column_acls', 'foreign_key_acls']

GC_NAME = 'groups'

GLOBUS_PREFIX = 'https://auth.globus.org/'

NC_NAME = 'name'

ROBOT_PREFIX_FORMAT = 'https://{server}/webauthn_robot/'

add_node_acl(node, acl_name)

add_node_acl_binding(node, table_node, binding_name)

apply_acls()

create_or_validate_group_table()

create_or_validate_schema(schema_name)

create_table(schema_name, table_name, table_spec, comment=None)

dumps()

Dump a serialized (string) representation of the config.

expand_acl_binding(binding, table_node)

expand_acl_definition(acl_name)

expand_acl_definitions()

expand_group(group_name)

expand_groups()

expand_projection(proj, table_node)

expand_projection_column(col_name, table_node)

get_group(group_name)

make_speclist(name)

save_groups()

set_acls()

set_catalog_acls(catalog)

set_column_acls(column, table)

set_fkey_acls(fkey, table)

set_node_acl(node, spec)

set_node_acl_bindings(node, table_node, binding_list, invalidate_list)

set_schema_acls(schema)

set_table_acls(table)

validate_globus_group(group)

validate_group(group)

validate_webauthn_robot(group)

exception deriva.config.acl_config.NoForeignKeyError

Bases: ValueError

class deriva.config.acl_config.Table(d)

Bases: AttrDict

ERMREST_DEFAULT_COLS = ['RID', 'RCB', 'RMB', 'RCT', 'RMT']

find_keys()

getBaseEntityURL()

getColumn(name)

getDefaultCols(add_ermrest_defaults=True)

getRow(catalog, row, filters)

getRowFilter(row)

insertRows(catalog, rows)

row_has_key(row, key)

updateRow(catalog, row)

upsertRow(catalog, row)

upsertRows(catalog, rows)

deriva.config.acl_config.main()

deriva.config.annotation_config module

class deriva.config.annotation_config.AttrConfig(server, catalog_id, config_file, credentials, verbose=False, schema_name=None, table_name=None)

Bases: object

apply_annotations()

find_best_column_specs(schema_name, table_name, column_name)

find_best_fkey_specs(fkey)

find_best_schema_specs(schema_name)

find_best_table_specs(schema_name, table_name)

find_corresponding_fkey(table, base_fkey)

find_named_column(table, column_name)

find_named_schema(catalog, schema_name)

find_named_table(schema, table_name)

make_speclist(name)

node_name(node)

set_attributes()

set_catalog_annotations()

set_column_annotations(column, saved_column)

set_fkey_annotations(fkey, saved_fkey)

set_node_annotations(node, specs, saved_node)

set_schema_annotations(schema, saved_schema)

set_table_annotations(table, saved_table)

class deriva.config.annotation_config.AttrSpec(specdict, managed_annotations, ignore_unmanaged, ignored_annotations)

Bases: BaseSpec

validate_annotation()

class deriva.config.annotation_config.AttrSpecList(known_attrs, specdict, strict=False)

Bases: BaseSpecList

SPEC_TYPES = ['catalog_annotations', 'schema_annotations', 'table_annotations', 'column_annotations', 'foreign_key_annotations']

add_list(dictlist)

annotation_list(orig_list)

exception deriva.config.annotation_config.NoForeignKeyError

Bases: ValueError

deriva.config.annotation_config.main()

deriva.config.base_config module

class deriva.config.base_config.BaseSpec(specdict, speclist, spectype, validate_node_types_only=False)

Bases: dict

ATTRIBUTE_TYPES = ['schema', 'table', 'column', 'foreign_key']

column_entry_matches(schema_name, table_name, column_name, exact=False, key=None)

config_format()

foreign_key_entry_matches(table_schema_name, table_name, fkey_schema_name, fkey_name, exact=False, key=None)

get_pattern(base)

has_node_key(key)

is_exact_spec()

is_node_spec()

classmethod make_pat_name(base)

matches(base, value, exact=False, key=None)

schema_entry_matches(schema_name, exact=False, key=None)

set_keys()

table_entry_matches(schema_name, table_name, exact=False, key=None)

validate()

validate_node_types()

class deriva.config.base_config.BaseSpecList(type, dictlist=None, strict=True)

Bases: object

add_list(dictlist)

add_spec(spec)

find_best_column_spec(schema_name, table_name, column_name, key=None)

find_best_foreign_key_name_spec(table_schema_name, table_name, fkey_schema_name, fkey_name, key)

find_best_foreign_key_spec(table_schema_name, table_name, names, key=None)

find_best_schema_spec(schema_name, key=None)

find_best_single_foreign_key_spec(schema_name, table_name, fkey_name, key=None)

find_best_table_spec(schema_name, table_name, key=None)

find_catalog_spec(key)

get_specs()

class deriva.config.base_config.ConfigBaseCLI(description, epilog, version)

Bases: BaseCLI

classmethod check_schema_table_args(args)

classmethod get_schema_arg_list(args)

classmethod get_table_arg(args)

class deriva.config.base_config.ConfigUtil

Bases: object

classmethod find_toplevel_node(catalog_config, schema_name, table_name)

deriva.config.dump_catalog_annotations module

class deriva.config.dump_catalog_annotations.Annotations(server, catalog, credentials, config)

Bases: object

add_catalog_annotations(catalog)

add_column_annotations(table, column)

add_foreign_key_annotations(fkey)

add_schema_annotations(schema)

add_table_annotations(table)

check_consolidation(matches, value)

consolidated_column_annotation(annotation)

consolidated_foreign_key_annotation(annotation)

consolidated_schema_annotation(annotation)

consolidated_table_annotation(annotation)

dumps()

find_relevant_annotations(annotations)

munge_specs(annotation_list)

types_list()

deriva.config.dump_catalog_annotations.main()

Module contents