Index

A

add_qc_evaluation() (aind_data_access_api.document_db.MetadataDbClient method) add_qc_evaluations_to_docdb() (in module aind_data_access_api.helpers.data_schema) aggregate_docdb_records() (aind_data_access_api.document_db.Client method) aind_data_access_api module aind_data_access_api.credentials module aind_data_access_api.document_db module aind_data_access_api.document_db_ssh module aind_data_access_api.helpers module

aind_data_access_api.helpers.data_schema module aind_data_access_api.helpers.docdb module aind_data_access_api.rds_tables module aind_data_access_api.secrets module aind_data_access_api.utils module AnalysisDbClient (class in aind_data_access_api.document_db) append_df_to_table() (aind_data_access_api.rds_tables.Client method) aws_secrets_name (aind_data_access_api.credentials.CoreCredentials attribute) AWSConfigSettingsSource (class in aind_data_access_api.credentials)

B

boto (aind_data_access_api.document_db.Client property)

build_docdb_location_to_id_map() (in module aind_data_access_api.utils)

C

Client (class in aind_data_access_api.document_db) (class in aind_data_access_api.rds_tables) close() (aind_data_access_api.document_db.Client method) (aind_data_access_api.document_db_ssh.DocumentDbSSHClient method)

collection (aind_data_access_api.document_db_ssh.DocumentDbSSHClient property) (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute) CoreCredentials (class in aind_data_access_api.credentials)

D

database (aind_data_access_api.credentials.CoreCredentials attribute) (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute) dbname (aind_data_access_api.rds_tables.RDSCredentials attribute) delete_many_records() (aind_data_access_api.document_db.Client method)

delete_one_record() (aind_data_access_api.document_db.Client method) deregister_asset() (aind_data_access_api.document_db.MetadataDbClient method) DocumentDbSSHClient (class in aind_data_access_api.document_db_ssh) DocumentDbSSHCredentials (class in aind_data_access_api.document_db_ssh) does_metadata_record_exist_in_docdb() (in module aind_data_access_api.utils)

E

execute_query() (aind_data_access_api.rds_tables.Client method)

F

fetch_records_by_filter_list() (aind_data_access_api.document_db.Client method) (in module aind_data_access_api.utils)

from_secrets_manager() (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials class method)

G

generate_data_summary() (aind_data_access_api.document_db.MetadataDbClient method) get_field_by_id() (in module aind_data_access_api.helpers.docdb) get_field_value() (aind_data_access_api.credentials.JsonConfigSettingsSource method) get_id_from_name() (in module aind_data_access_api.helpers.docdb) get_name_from_id() (in module aind_data_access_api.helpers.docdb) get_parameter() (in module aind_data_access_api.secrets) get_projection_by_id() (in module aind_data_access_api.helpers.docdb) get_projection_by_name() (in module aind_data_access_api.helpers.docdb) get_quality_control_by_id() (in module aind_data_access_api.helpers.data_schema)

get_quality_control_by_name() (in module aind_data_access_api.helpers.data_schema) get_quality_control_by_names() (in module aind_data_access_api.helpers.data_schema) get_quality_control_status_df() (in module aind_data_access_api.helpers.data_schema) get_quality_control_value_df() (in module aind_data_access_api.helpers.data_schema) get_record_by_id() (in module aind_data_access_api.helpers.docdb) get_record_by_name() (in module aind_data_access_api.helpers.docdb) get_record_from_docdb() (in module aind_data_access_api.utils) get_s3_bucket_and_prefix() (in module aind_data_access_api.utils) get_s3_location() (in module aind_data_access_api.utils) get_secret() (in module aind_data_access_api.secrets)

H

host (aind_data_access_api.credentials.CoreCredentials attribute) (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute) (aind_data_access_api.rds_tables.RDSCredentials attribute)

I

insert_one_docdb_record() (aind_data_access_api.document_db.Client method)

J

JsonConfigSettingsSource (class in aind_data_access_api.credentials)

M

MetadataDbClient (class in aind_data_access_api.document_db) model_config (aind_data_access_api.credentials.CoreCredentials attribute) (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute) (aind_data_access_api.rds_tables.RDSCredentials attribute) module aind_data_access_api aind_data_access_api.credentials aind_data_access_api.document_db aind_data_access_api.document_db_ssh aind_data_access_api.helpers aind_data_access_api.helpers.data_schema aind_data_access_api.helpers.docdb aind_data_access_api.rds_tables aind_data_access_api.secrets aind_data_access_api.utils

O

overwrite_table_with_df() (aind_data_access_api.rds_tables.Client method)

P

paginate_docdb() (in module aind_data_access_api.utils) password (aind_data_access_api.credentials.CoreCredentials attribute) (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute) (aind_data_access_api.rds_tables.RDSCredentials attribute)

port (aind_data_access_api.credentials.CoreCredentials attribute) (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute) (aind_data_access_api.rds_tables.RDSCredentials attribute) prepare_field_value() (aind_data_access_api.credentials.JsonConfigSettingsSource method)

R

RDSCredentials (class in aind_data_access_api.rds_tables) read_table() (aind_data_access_api.rds_tables.Client method) register_asset() (aind_data_access_api.document_db.MetadataDbClient method)

register_co_result() (aind_data_access_api.document_db.MetadataDbClient method) retrieve_docdb_records() (aind_data_access_api.document_db.Client method) retrieve_schema_records() (aind_data_access_api.document_db.SchemaDbClient method)

S

SchemaDbClient (class in aind_data_access_api.document_db) session (aind_data_access_api.document_db.Client property) settings_customise_sources() (aind_data_access_api.credentials.CoreCredentials class method) ssh_host (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute)

ssh_local_bind_address (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute) ssh_password (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute) ssh_port (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute) ssh_username (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute) start() (aind_data_access_api.document_db_ssh.DocumentDbSSHClient method)

U

upsert_list_of_docdb_records() (aind_data_access_api.document_db.Client method) upsert_one_docdb_record() (aind_data_access_api.document_db.Client method)

username (aind_data_access_api.credentials.CoreCredentials attribute) (aind_data_access_api.document_db_ssh.DocumentDbSSHCredentials attribute) (aind_data_access_api.rds_tables.RDSCredentials attribute)

V

validate_database_name() (aind_data_access_api.rds_tables.RDSCredentials method)

validate_qc() (in module aind_data_access_api.helpers.data_schema)