src

• aind_data_access_api package
  • Subpackages
    • aind_data_access_api.helpers package
      • Submodules
      • aind_data_access_api.helpers.data_schema module
      • aind_data_access_api.helpers.docdb module
      • Module contents
  • Submodules
  • aind_data_access_api.credentials module
    • AWSConfigSettingsSource
    • CoreCredentials
      • CoreCredentials.aws_secrets_name
      • CoreCredentials.database
      • CoreCredentials.host
      • CoreCredentials.model_config
      • CoreCredentials.password
      • CoreCredentials.port
      • CoreCredentials.settings_customise_sources()
      • CoreCredentials.username
    • JsonConfigSettingsSource
      • JsonConfigSettingsSource.get_field_value()
      • JsonConfigSettingsSource.prepare_field_value()
  • aind_data_access_api.document_db module
    • AnalysisDbClient
    • Client
      • Client.aggregate_docdb_records()
      • Client.boto
      • Client.close()
      • Client.delete_many_records()
      • Client.delete_one_record()
      • Client.fetch_records_by_filter_list()
      • Client.insert_one_docdb_record()
      • Client.retrieve_docdb_records()
      • Client.session
      • Client.upsert_list_of_docdb_records()
      • Client.upsert_one_docdb_record()
    • MetadataDbClient
      • MetadataDbClient.add_qc_evaluation()
      • MetadataDbClient.deregister_asset()
      • MetadataDbClient.generate_data_summary()
      • MetadataDbClient.register_asset()
      • MetadataDbClient.register_co_result()
    • SchemaDbClient
      • SchemaDbClient.retrieve_schema_records()
  • aind_data_access_api.document_db_ssh module
    • DocumentDbSSHClient
      • DocumentDbSSHClient.close()
      • DocumentDbSSHClient.collection
      • DocumentDbSSHClient.start()
    • DocumentDbSSHCredentials
      • DocumentDbSSHCredentials.collection
      • DocumentDbSSHCredentials.database
      • DocumentDbSSHCredentials.from_secrets_manager()
      • DocumentDbSSHCredentials.host
      • DocumentDbSSHCredentials.model_config
      • DocumentDbSSHCredentials.password
      • DocumentDbSSHCredentials.port
      • DocumentDbSSHCredentials.ssh_host
      • DocumentDbSSHCredentials.ssh_local_bind_address
      • DocumentDbSSHCredentials.ssh_password
      • DocumentDbSSHCredentials.ssh_port
      • DocumentDbSSHCredentials.ssh_username
      • DocumentDbSSHCredentials.username
  • aind_data_access_api.rds_tables module
    • Client
      • Client.append_df_to_table()
      • Client.execute_query()
      • Client.overwrite_table_with_df()
      • Client.read_table()
    • RDSCredentials
      • RDSCredentials.dbname
      • RDSCredentials.host
      • RDSCredentials.model_config
      • RDSCredentials.password
      • RDSCredentials.port
      • RDSCredentials.username
      • RDSCredentials.validate_database_name()
  • aind_data_access_api.secrets module
    • get_parameter()
    • get_secret()
  • aind_data_access_api.utils module
    • build_docdb_location_to_id_map()
    • does_metadata_record_exist_in_docdb()
    • fetch_records_by_filter_list()
    • get_record_from_docdb()
    • get_s3_bucket_and_prefix()
    • get_s3_location()
    • paginate_docdb()
  • Module contents