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
      • deriva.config.annotation_config module
      • deriva.config.base_config module
      • deriva.config.dump_catalog_annotations module
      • Module contents
    • deriva.core package
      • Subpackages
        • deriva.core.utils package
          • Submodules
          • deriva.core.utils.core_utils module
          • deriva.core.utils.hash_utils module
          • deriva.core.utils.mime_utils module
          • deriva.core.utils.version_utils module
          • deriva.core.utils.webauthn_utils module
          • Module contents
      • Submodules
      • deriva.core.annotation module
      • deriva.core.base_cli module
      • deriva.core.datapath module
      • deriva.core.deriva_binding module
      • deriva.core.deriva_server module
      • deriva.core.ermrest_catalog module
      • deriva.core.ermrest_config module
      • deriva.core.ermrest_model module
      • deriva.core.hatrac_cli module
      • deriva.core.hatrac_store module
      • deriva.core.polling_ermrest_catalog module
      • Module contents
    • 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
              • Module contents
          • Submodules
          • deriva.transfer.download.deriva_download module
          • deriva.transfer.download.deriva_download_cli module
          • Module contents
        • deriva.transfer.upload package
          • Submodules
          • deriva.transfer.upload.deriva_upload module
          • deriva.transfer.upload.deriva_upload_cli module
          • Module contents
        • deriva.transfer.backup package
          • Submodules
          • deriva.transfer.backup.deriva_backup module
          • deriva.transfer.backup.deriva_backup_cli module
          • Module contents
        • deriva.transfer.restore package
          • Submodules
          • deriva.transfer.restore.deriva_restore module
          • deriva.transfer.restore.deriva_restore_cli module
          • Module contents
      • Module contents
    • deriva.seo package
      • Submodules
      • deriva.seo.sitemap_builder module
  • 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>, ...