Python Command-line Clients and API (deriva-py)

API Guides

• Deriva Python APIs
  • ERMrest Query and Data Manipulation
    • Features
    • Limitations
    • Tutorials
  • ERMrest Model Management
    • Features
    • Limitations
    • Examples
      • Add Schema to Catalog
      • Add Table to Schema
      • Add a Vocabulary Term Table
      • Add Column to Table
      • Remove a Column from a Table
      • Alter a Table
  • ERMrest Catalog
    • Catalog Binding
    • Client Credentials
    • High-Level API Factories
    • Low-Level HTTP Methods
    • HTTP Caching

API Reference

• Source Code and Module Documentation (deriva package)
  • Subpackages
    • deriva.config package
      • Submodules
      • deriva.config.acl_config module
        • ACLSpec
          • ACLSpec.validate()
        • ACLSpecList
        • AclCLI
        • AclConfig
          • AclConfig.ACL_TYPES
          • AclConfig.GC_NAME
          • AclConfig.GLOBUS_PREFIX
          • AclConfig.NC_NAME
          • AclConfig.ROBOT_PREFIX_FORMAT
          • AclConfig.add_node_acl()
          • AclConfig.add_node_acl_binding()
          • AclConfig.apply_acls()
          • AclConfig.create_or_validate_group_table()
          • AclConfig.create_or_validate_schema()
          • AclConfig.create_table()
          • AclConfig.dumps()
          • AclConfig.expand_acl_binding()
          • AclConfig.expand_acl_definition()
          • AclConfig.expand_acl_definitions()
          • AclConfig.expand_group()
          • AclConfig.expand_groups()
          • AclConfig.expand_projection()
          • AclConfig.expand_projection_column()
          • AclConfig.get_group()
          • AclConfig.make_speclist()
          • AclConfig.save_groups()
          • AclConfig.set_acls()
          • AclConfig.set_catalog_acls()
          • AclConfig.set_column_acls()
          • AclConfig.set_fkey_acls()
          • AclConfig.set_node_acl()
          • AclConfig.set_node_acl_bindings()
          • AclConfig.set_schema_acls()
          • AclConfig.set_table_acls()
          • AclConfig.validate_globus_group()
          • AclConfig.validate_group()
          • AclConfig.validate_webauthn_robot()
        • NoForeignKeyError
        • Table
          • Table.ERMREST_DEFAULT_COLS
          • Table.find_keys()
          • Table.getBaseEntityURL()
          • Table.getColumn()
          • Table.getDefaultCols()
          • Table.getRow()
          • Table.getRowFilter()
          • Table.insertRows()
          • Table.row_has_key()
          • Table.updateRow()
          • Table.upsertRow()
          • Table.upsertRows()
        • main()
      • deriva.config.annotation_config module
        • AttrConfig
          • AttrConfig.apply_annotations()
          • AttrConfig.find_best_column_specs()
          • AttrConfig.find_best_fkey_specs()
          • AttrConfig.find_best_schema_specs()
          • AttrConfig.find_best_table_specs()
          • AttrConfig.find_corresponding_fkey()
          • AttrConfig.find_named_column()
          • AttrConfig.find_named_schema()
          • AttrConfig.find_named_table()
          • AttrConfig.make_speclist()
          • AttrConfig.node_name()
          • AttrConfig.set_attributes()
          • AttrConfig.set_catalog_annotations()
          • AttrConfig.set_column_annotations()
          • AttrConfig.set_fkey_annotations()
          • AttrConfig.set_node_annotations()
          • AttrConfig.set_schema_annotations()
          • AttrConfig.set_table_annotations()
        • AttrSpec
          • AttrSpec.validate_annotation()
        • AttrSpecList
          • AttrSpecList.SPEC_TYPES
          • AttrSpecList.add_list()
          • AttrSpecList.annotation_list()
        • NoForeignKeyError
        • main()
      • deriva.config.base_config module
        • BaseSpec
          • BaseSpec.ATTRIBUTE_TYPES
          • BaseSpec.column_entry_matches()
          • BaseSpec.config_format()
          • BaseSpec.foreign_key_entry_matches()
          • BaseSpec.get_pattern()
          • BaseSpec.has_node_key()
          • BaseSpec.is_exact_spec()
          • BaseSpec.is_node_spec()
          • BaseSpec.make_pat_name()
          • BaseSpec.matches()
          • BaseSpec.schema_entry_matches()
          • BaseSpec.set_keys()
          • BaseSpec.table_entry_matches()
          • BaseSpec.validate()
          • BaseSpec.validate_node_types()
        • BaseSpecList
          • BaseSpecList.add_list()
          • BaseSpecList.add_spec()
          • BaseSpecList.find_best_column_spec()
          • BaseSpecList.find_best_foreign_key_name_spec()
          • BaseSpecList.find_best_foreign_key_spec()
          • BaseSpecList.find_best_schema_spec()
          • BaseSpecList.find_best_single_foreign_key_spec()
          • BaseSpecList.find_best_table_spec()
          • BaseSpecList.find_catalog_spec()
          • BaseSpecList.get_specs()
        • ConfigBaseCLI
          • ConfigBaseCLI.check_schema_table_args()
          • ConfigBaseCLI.get_schema_arg_list()
          • ConfigBaseCLI.get_table_arg()
        • ConfigUtil
          • ConfigUtil.find_toplevel_node()
      • deriva.config.dump_catalog_annotations module
        • Annotations
          • Annotations.add_catalog_annotations()
          • Annotations.add_column_annotations()
          • Annotations.add_foreign_key_annotations()
          • Annotations.add_schema_annotations()
          • Annotations.add_table_annotations()
          • Annotations.check_consolidation()
          • Annotations.consolidated_column_annotation()
          • Annotations.consolidated_foreign_key_annotation()
          • Annotations.consolidated_schema_annotation()
          • Annotations.consolidated_table_annotation()
          • Annotations.dumps()
          • Annotations.find_relevant_annotations()
          • Annotations.munge_specs()
          • Annotations.types_list()
        • main()
      • Module contents
    • deriva.core package
      • Subpackages
        • deriva.core.utils package
          • Submodules
          • deriva.core.utils.core_utils module
            • AttrDict
              • AttrDict.update()
            • ConcurrentUpdate
            • NotModified
            • TimeoutHTTPAdapter
              • TimeoutHTTPAdapter.send()
            • add_logging_level()
            • bootstrap()
            • calculate_optimal_transfer_shape()
            • copy_config()
            • format_credential()
            • format_exception()
            • get_new_requests_session()
            • get_oauth_scopes_for_host()
            • get_transfer_summary()
            • init_logging()
            • json_item_handler()
            • load_cookies_from_file()
            • lock_file()
            • make_dirs()
            • read_config()
            • read_credential()
            • resource_path()
            • stob()
            • topo_sorted()
            • urlquote()
            • urlquote_dcctx()
            • write_config()
            • write_credential()
          • deriva.core.utils.hash_utils module
            • compute_file_hashes()
            • compute_hashes()
            • decodeBase64toHex()
          • deriva.core.utils.mime_utils module
            • add_types()
            • guess_content_type()
            • parse_content_disposition()
          • deriva.core.utils.version_utils module
            • get_installed_version()
            • is_compatible()
          • deriva.core.utils.webauthn_utils module
            • get_wallet_entries()
          • Module contents
            • eprint()
      • Submodules
      • deriva.core.annotation module
        • validate()
      • deriva.core.base_cli module
        • BaseCLI
          • BaseCLI.parse_cli()
          • BaseCLI.parse_tuple()
          • BaseCLI.remove_options()
        • KeyValuePairArgs
      • deriva.core.datapath module
        • Array
        • ArrayD
        • Avg
        • Bin
        • Cnt
        • CntD
        • DataPathException
        • Max
        • Min
        • Sum
      • deriva.core.deriva_binding module
        • DerivaBinding
          • DerivaBinding.check_path()
          • DerivaBinding.delete()
          • DerivaBinding.get()
          • DerivaBinding.get_authn_session()
          • DerivaBinding.get_server_uri()
          • DerivaBinding.head()
          • DerivaBinding.post()
          • DerivaBinding.post_authn_session()
          • DerivaBinding.put()
          • DerivaBinding.set_credentials()
        • DerivaClientContext
          • DerivaClientContext.encoded()
          • DerivaClientContext.merged()
          • DerivaClientContext.prune()
          • DerivaClientContext.set_defaults()
        • DerivaPathError
      • deriva.core.deriva_server module
      • deriva.core.ermrest_catalog module
        • DerivaServer
          • DerivaServer.connect_ermrest()
          • DerivaServer.connect_ermrest_alias()
          • DerivaServer.create_ermrest_alias()
          • DerivaServer.create_ermrest_catalog()
        • ErmrestAlias
          • ErmrestAlias.alias_id
          • ErmrestAlias.check_path()
          • ErmrestAlias.connect()
          • ErmrestAlias.create()
          • ErmrestAlias.delete_ermrest_alias()
          • ErmrestAlias.retrieve()
          • ErmrestAlias.update()
        • ErmrestCatalog
          • ErmrestCatalog.alias_target
          • ErmrestCatalog.catalog_id
          • ErmrestCatalog.clone_catalog()
          • ErmrestCatalog.connect()
          • ErmrestCatalog.create()
          • ErmrestCatalog.delete()
          • ErmrestCatalog.delete_ermrest_catalog()
          • ErmrestCatalog.deriva_server
          • ErmrestCatalog.exists()
          • ErmrestCatalog.getAsFile()
          • ErmrestCatalog.getCatalogModel()
          • ErmrestCatalog.getCatalogSchema()
          • ErmrestCatalog.getDefaultColumns()
          • ErmrestCatalog.getPathBuilder()
          • ErmrestCatalog.getTableColumns()
          • ErmrestCatalog.getTableSchema()
          • ErmrestCatalog.get_as_file()
          • ErmrestCatalog.latest_snapshot()
          • ErmrestCatalog.resolve_rid()
          • ErmrestCatalog.splitQualifiedCatalogName()
          • ErmrestCatalog.table_schemas
          • ErmrestCatalog.validateRowColumns()
        • ErmrestCatalogMutationError
        • ErmrestSnapshot
          • ErmrestSnapshot.snaptime
        • ResolveRidResult
          • ResolveRidResult.datapath
          • ResolveRidResult.rid
          • ResolveRidResult.table
      • deriva.core.ermrest_config module
      • deriva.core.ermrest_model module
        • ArrayType
          • ArrayType.prejson()
          • ArrayType.sqlite3_ddl()
        • Column
          • Column.alter()
          • Column.apply()
          • Column.asset
          • Column.catalog
          • Column.clear()
          • Column.column_display
          • Column.define()
          • Column.display
          • Column.drop()
          • Column.generated
          • Column.immutable
          • Column.prejson()
          • Column.prejson_colref()
          • Column.required
          • Column.sqlite3_ddl()
          • Column.uri_path
        • DomainType
          • DomainType.prejson()
          • DomainType.sqlite3_ddl()
        • FindAssociationResult
        • ForeignKey
          • ForeignKey.alter()
          • ForeignKey.apply()
          • ForeignKey.catalog
          • ForeignKey.clear()
          • ForeignKey.column_map
          • ForeignKey.columns
          • ForeignKey.define()
          • ForeignKey.digest_referenced_columns()
          • ForeignKey.drop()
          • ForeignKey.foreign_key
          • ForeignKey.name
          • ForeignKey.name_in_model()
          • ForeignKey.names
          • ForeignKey.prejson()
          • ForeignKey.uri_path
        • Key
          • Key.alter()
          • Key.apply()
          • Key.catalog
          • Key.clear()
          • Key.columns
          • Key.define()
          • Key.drop()
          • Key.name
          • Key.name_in_model()
          • Key.names
          • Key.prejson()
          • Key.sqlite3_ddl()
          • Key.uri_path
        • KeyedList
          • KeyedList.append()
        • Model
          • Model.apply()
          • Model.bulk_upload
          • Model.catalog
          • Model.chaise_config
          • Model.clear()
          • Model.column()
          • Model.column_defaults
          • Model.configure_baseline_catalog()
          • Model.configure_baseline_ermrest_client()
          • Model.configure_baseline_ermrest_group()
          • Model.create_schema()
          • Model.digest_fkeys()
          • Model.display
          • Model.export_2019
          • Model.export_fragment_definitions
          • Model.fkey()
          • Model.fromcatalog()
          • Model.fromfile()
          • Model.generated
          • Model.immutable
          • Model.non_deletable
          • Model.prejson()
          • Model.table()
          • Model.uri_path
        • NoChange
        • Quantifier
          • Quantifier.all
          • Quantifier.any
        • Schema
          • Schema.alter()
          • Schema.apply()
          • Schema.catalog
          • Schema.clear()
          • Schema.column_defaults
          • Schema.create_table()
          • Schema.define()
          • Schema.define_www()
          • Schema.display
          • Schema.drop()
          • Schema.export_2019
          • Schema.export_fragment_definitions
          • Schema.generated
          • Schema.immutable
          • Schema.non_deletable
          • Schema.prejson()
          • Schema.uri_path
        • Table
          • Table.alter()
          • Table.alternatives
          • Table.apply()
          • Table.catalog
          • Table.citation
          • Table.clear()
          • Table.column_defaults
          • Table.columns
          • Table.create_column()
          • Table.create_fkey()
          • Table.create_key()
          • Table.create_reference()
          • Table.default_key_column_search_order
          • Table.define()
          • Table.define_asset()
          • Table.define_association()
          • Table.define_page()
          • Table.define_vocabulary()
          • Table.display
          • Table.drop()
          • Table.export_2019
          • Table.export_fragment_definitions
          • Table.find_associations()
          • Table.fkey_by_column_map()
          • Table.fkeys_by_columns()
          • Table.generated
          • Table.google_dataset
          • Table.immutable
          • Table.indexing_preferences
          • Table.is_association()
          • Table.key_by_columns()
          • Table.non_deletable
          • Table.prejson()
          • Table.source_definitions
          • Table.sqlite3_ddl()
          • Table.sqlite3_table_name()
          • Table.system_column_defs()
          • Table.system_fkey_defs()
          • Table.system_key_defs()
          • Table.table_display
          • Table.uri_path
          • Table.visible_columns
          • Table.visible_foreign_keys
          • Table.viz_3d_display
        • Type
          • Type.prejson()
          • Type.sqlite3_ddl()
        • UpdateMappings
          • UpdateMappings.deferred
          • UpdateMappings.immediate
          • UpdateMappings.no_update
        • equivalent()
        • find_tables_with_foreign_keys()
        • make_id()
        • make_type()
        • object_annotation()
        • presence_annotation()
        • sql_identifier()
        • sql_literal()
        • strip_nochange()
      • deriva.core.hatrac_cli module
        • DerivaHatracCLI
          • DerivaHatracCLI.delacl()
          • DerivaHatracCLI.delobj()
          • DerivaHatracCLI.getacl()
          • DerivaHatracCLI.getobj()
          • DerivaHatracCLI.list()
          • DerivaHatracCLI.main()
          • DerivaHatracCLI.mkdir()
          • DerivaHatracCLI.putobj()
          • DerivaHatracCLI.rmdir()
          • DerivaHatracCLI.setacl()
        • DerivaHatracCLIException
        • ResourceException
        • UsageException
        • main()
      • deriva.core.hatrac_store module
        • HatracHashMismatch
        • HatracJobAborted
        • HatracJobPaused
        • HatracJobTimeout
        • HatracStore
          • HatracStore.cancel_upload_job()
          • HatracStore.content_equals()
          • HatracStore.create_namespace()
          • HatracStore.create_upload_job()
          • HatracStore.del_acl()
          • HatracStore.del_obj()
          • HatracStore.delete_namespace()
          • HatracStore.finalize_upload_job()
          • HatracStore.get_acl()
          • HatracStore.get_obj()
          • HatracStore.get_upload_job()
          • HatracStore.is_valid_namespace()
          • HatracStore.put_loc()
          • HatracStore.put_obj()
          • HatracStore.put_obj_chunked()
          • HatracStore.retrieve_namespace()
          • HatracStore.set_acl()
      • deriva.core.polling_ermrest_catalog module
        • PollingErmrestCatalog
          • PollingErmrestCatalog.blocking_poll()
          • PollingErmrestCatalog.state_change_once()
      • Module contents
        • get_credential()
        • get_credential()
        • read_credential()
        • write_credential()
        • read_config()
        • write_config()
        • core.DEFAULT_CONFIG_PATH
        • core.DEFAULT_CONFIG_FILE
        • core.DEFAULT_CREDENTIAL_FILE
        • core.DEFAULT_GLOBUS_CREDENTIAL_FILE
    • deriva.transfer package
      • Subpackages
        • deriva.transfer.download package
          • Subpackages
            • deriva.transfer.download.processors package
              • Subpackages
                • deriva.transfer.download.processors.postprocess package
                  • Submodules
                  • deriva.transfer.download.processors.postprocess.identifier_post_processor module
                  • deriva.transfer.download.processors.postprocess.transfer_post_processor module
                  • deriva.transfer.download.processors.postprocess.workspace_post_processor module
                  • Module contents
                • deriva.transfer.download.processors.query package
                  • Submodules
                  • deriva.transfer.download.processors.query.bag_fetch_query_processor module
                  • deriva.transfer.download.processors.query.base_query_processor module
                  • deriva.transfer.download.processors.query.file_download_query_processor module
                  • Module contents
                • deriva.transfer.download.processors.transform package
                  • Module contents
              • Submodules
              • deriva.transfer.download.processors.base_processor module
                • BaseProcessor
                  • BaseProcessor.create_paths()
                  • BaseProcessor.default_callback()
                  • BaseProcessor.make_file_output_values()
                  • BaseProcessor.process()
                  • BaseProcessor.should_abort()
              • Module contents
                • find_post_processor()
                • find_processor()
                • find_query_processor()
                • find_transform_processor()
                • is_processor_whitelisted()
          • Submodules
          • deriva.transfer.download.deriva_download module
            • DerivaDownload
              • DerivaDownload.check_payload_size()
              • DerivaDownload.download()
              • DerivaDownload.set_config()
              • DerivaDownload.set_credentials()
              • DerivaDownload.set_dcctx_cid()
            • GenericDownloader
              • GenericDownloader.LOCAL_PATH_KEY
              • GenericDownloader.REMOTE_PATHS_KEY
              • GenericDownloader.SERVICE_URL_KEY
          • deriva.transfer.download.deriva_download_cli module
            • DerivaDownloadCLI
              • DerivaDownloadCLI.download()
              • DerivaDownloadCLI.get_downloader()
              • DerivaDownloadCLI.main()
          • Module contents
            • DerivaDownloadAuthenticationError
            • DerivaDownloadAuthorizationError
            • DerivaDownloadBaggingError
            • DerivaDownloadConfigurationError
            • DerivaDownloadError
            • DerivaDownloadTimeoutError
        • deriva.transfer.upload package
          • Submodules
          • deriva.transfer.upload.deriva_upload module
            • DerivaUpload
              • DerivaUpload.DefaultConfigFileName
              • DerivaUpload.DefaultServerListFileName
              • DerivaUpload.DefaultTransferStateBaseName
              • DerivaUpload.DefaultTransferStateFileName
              • DerivaUpload.acquire_dependent_locks()
              • DerivaUpload.archive_preprocessing_enabled()
              • DerivaUpload.cancel()
              • DerivaUpload.cleanup()
              • DerivaUpload.cleanupTransferState()
              • DerivaUpload.defaultFileCallback()
              • DerivaUpload.delTransferState()
              • DerivaUpload.delete_dependent_locks()
              • DerivaUpload.find_file_in_dir_hierarchy()
              • DerivaUpload.getAssetMapping()
              • DerivaUpload.getCatalogTable()
              • DerivaUpload.getConfigPath()
              • DerivaUpload.getCurrentConfigFilePath()
              • DerivaUpload.getDefaultConfigFilePath()
              • DerivaUpload.getDefaultServer()
              • DerivaUpload.getDeployedConfigFilePath()
              • DerivaUpload.getDeployedConfigPath()
              • DerivaUpload.getFileDisplayName()
              • DerivaUpload.getFileHashes()
              • DerivaUpload.getFileSize()
              • DerivaUpload.getFileStatusAsArray()
              • DerivaUpload.getRemoteConfig()
              • DerivaUpload.getServers()
              • DerivaUpload.getTransferState()
              • DerivaUpload.getTransferStateFileName()
              • DerivaUpload.getTransferStateStatus()
              • DerivaUpload.getUpdatedConfig()
              • DerivaUpload.getVersion()
              • DerivaUpload.getVersionCompatibility()
              • DerivaUpload.guessContentType()
              • DerivaUpload.initialize()
              • DerivaUpload.interpolateDict()
              • DerivaUpload.interrupt_handler()
              • DerivaUpload.isFileNewer()
              • DerivaUpload.isVersionCompatible()
              • DerivaUpload.loadTransferState()
              • DerivaUpload.pruneDict()
              • DerivaUpload.reset()
              • DerivaUpload.scanDirectory()
              • DerivaUpload.setConfig()
              • DerivaUpload.setCredentials()
              • DerivaUpload.setServer()
              • DerivaUpload.setTransferState()
              • DerivaUpload.set_dcctx_cid()
              • DerivaUpload.uploadFile()
              • DerivaUpload.uploadFiles()
              • DerivaUpload.validateFile()
              • DerivaUpload.writeTransferState()
            • Enum
            • FileUploadState
              • FileUploadState.asdict()
            • GenericUploader
              • GenericUploader.getConfigPath()
              • GenericUploader.getServers()
              • GenericUploader.getVersion()
              • GenericUploader.setServers()
            • UploadEntry
          • deriva.transfer.upload.deriva_upload_cli module
            • DerivaUploadCLI
              • DerivaUploadCLI.main()
              • DerivaUploadCLI.upload()
          • Module contents
            • DerivaUploadAuthenticationError
            • DerivaUploadCatalogCreateError
            • DerivaUploadCatalogUpdateError
            • DerivaUploadConfigurationError
            • DerivaUploadError
        • deriva.transfer.backup package
          • Submodules
          • deriva.transfer.backup.deriva_backup module
            • DerivaBackup
              • DerivaBackup.BASE_ASSET_OUTPUT_PATH
              • DerivaBackup.BASE_CONFIG
              • DerivaBackup.BASE_DATA_OUTPUT_PATH
              • DerivaBackup.BASE_DATA_QUERY_PATH
              • DerivaBackup.BASE_SCHEMA_QUERY_PROC
              • DerivaBackup.download()
              • DerivaBackup.generate_asset_configs()
          • deriva.transfer.backup.deriva_backup_cli module
            • DerivaBackupCLI
              • DerivaBackupCLI.get_downloader()
          • Module contents
            • DerivaBackupAuthenticationError
            • DerivaBackupAuthorizationError
            • DerivaBackupConfigurationError
            • DerivaBackupError
        • deriva.transfer.restore package
          • Submodules
          • deriva.transfer.restore.deriva_restore module
            • DerivaRestore
              • DerivaRestore.BASE_ASSETS_INPUT_PATH
              • DerivaRestore.BASE_DATA_INPUT_PATH
              • DerivaRestore.RESTORE_STATE_URL
              • DerivaRestore.check_column_compatibility()
              • DerivaRestore.cleanup_restored_catalog()
              • DerivaRestore.copy_cdef()
              • DerivaRestore.copy_kdef()
              • DerivaRestore.copy_sdef()
              • DerivaRestore.copy_tdef_core()
              • DerivaRestore.copy_tdef_fkeys()
              • DerivaRestore.get_json_recordset()
              • DerivaRestore.get_table_path()
              • DerivaRestore.load_json_file()
              • DerivaRestore.open_json_stream_file()
              • DerivaRestore.prune_parts()
              • DerivaRestore.restore()
              • DerivaRestore.set_config()
              • DerivaRestore.set_credentials()
              • DerivaRestore.upload_assets()
          • deriva.transfer.restore.deriva_restore_cli module
            • DerivaRestoreCLI
              • DerivaRestoreCLI.main()
          • Module contents
            • DerivaRestoreAuthenticationError
            • DerivaRestoreAuthorizationError
            • DerivaRestoreConfigurationError
            • DerivaRestoreError
      • Module contents
    • deriva.seo package
      • Submodules
      • deriva.seo.sitemap_builder module
        • SitemapBuilder
          • SitemapBuilder.add_fkey_times()
          • SitemapBuilder.add_table_spec()
          • SitemapBuilder.ermrest_time_to_float()
          • SitemapBuilder.get_column()
          • SitemapBuilder.get_table()
          • SitemapBuilder.populate_spec()
          • SitemapBuilder.set_table_spec_data()
          • SitemapBuilder.write_sitemap()
  • Module contents

Command Line Interfaces

• deriva-acl-config
  • Using deriva-acl-config to configure ACLs
  • Config file format
    • The groups stanza
    • The group_list_table stanza
    • The acl_definitions stanza
    • The acl_bindings stanza
    • The catalog_acls stanza
    • The schema_acls stanza
    • The table_acls stanza
    • The column_acls stanza
    • The foreign_key_acls stanza
  • Security Considerations
• deriva-annotation-config
  • Using deriva-annotation-config to configure annotations
  • Config file format
    • The known_attributes stanza
    • The schema_annotations stanza
    • The table_annotations stanza
    • The column_annotations stanza
    • The foreign_key_annotations stanza
• deriva-hatrac-cli
  • Features
  • Common options
    • Hostname
    • Authentication
  • Namespace operation examples
    • List
    • Create Namespace
    • Delete Namespace
  • Object operation examples
    • Put an object
    • Get an object
    • Delete an object
  • ACL operation examples
    • Get ACLs
    • Set ACLs
    • Delete ACLs
• deriva-download-cli
  • Features
  • Command-Line options
    • Positional arguments:
      • <host>
      • <config file>
      • <output dir>
    • Optional arguments:
      • --token
      • --credential-file
      • --catalog
  • Configuration file format
    • Example configuration file:
    • Configuration file element: catalog
    • Configuration file element: bag
    • Configuration file element: env
  • Supported processors
  • Processor details
    • env
    • csv
    • json
    • json-stream
    • download
    • fetch
  • Supported transform_processors
  • Transform Processor details
    • strsub
    • interpolation
    • cat
• deriva-sitemap-cli
  • Using deriva-sitemap-cli to create sitemaps
  • Examples
• deriva-backup-cli
  • Features
  • Command-Line options
    • Positional arguments:
      • <host>
      • <input path>
    • Optional arguments:
      • --token
      • --oauth2-token
      • --credential-file
      • --catalog
      • --no-data
      • --no-schema
      • --no-bag
      • --bag-archiver {zip,tgz,bz2}
      • --include-assets {full,references}
      • --exclude-data <schema>, <schema:table>, ...
• deriva-restore-cli
  • Features
  • Command-Line options
    • Positional arguments:
      • <host>
      • <input path>
    • Optional arguments:
      • --token
      • --oauth2-token
      • --credential-file
      • --catalog
      • --no-data
      • --no-schema
      • --no-assets
      • --no-annotations
      • --no-policy
      • --no-bag-materialize
      • --weak-bag-validation
      • --exclude-object <schema>, <schema:table>, ...
      • --exclude-data <schema>, <schema:table>, ...