Skip to content

Commit daa9604

Browse files
committed
docs: update MetadataDbClient examples
1 parent 92ca51e commit daa9604

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

docs/source/ExamplesDocDBRestApi.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@ Count Example 1: Get # of records with a certain subject_id
1818
from aind_data_access_api.document_db import MetadataDbClient
1919
2020
API_GATEWAY_HOST = "api.allenneuraldynamics.org"
21-
DATABASE = "metadata_index"
22-
COLLECTION = "data_assets"
21+
# Default database and collection names are set in the client
22+
# DATABASE = "metadata_index"
23+
# COLLECTION = "data_assets"
2324
2425
docdb_api_client = MetadataDbClient(
2526
host=API_GATEWAY_HOST,
26-
database=DATABASE,
27-
collection=COLLECTION,
27+
# database=DATABASE,
28+
# collection=COLLECTION,
2829
)
2930
3031
filter = {"subject.subject_id": "731015"}
@@ -136,8 +137,6 @@ It's possible to attach a custom Session to retry certain requests errors:
136137
from aind_data_access_api.document_db import MetadataDbClient
137138
138139
API_GATEWAY_HOST = "api.allenneuraldynamics.org"
139-
DATABASE = "metadata_index"
140-
COLLECTION = "data_assets"
141140
142141
retry = Retry(
143142
total=5,
@@ -151,8 +150,6 @@ It's possible to attach a custom Session to retry certain requests errors:
151150
152151
with MetadataDbClient(
153152
host=API_GATEWAY_HOST,
154-
database=DATABASE,
155-
collection=COLLECTION,
156153
session=session,
157154
) as docdb_api_client:
158155
records = docdb_api_client.retrieve_docdb_records(limit=10)

docs/source/UserGuide.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,14 @@ REST API
5454
from aind_data_access_api.document_db import MetadataDbClient
5555
5656
API_GATEWAY_HOST = "api.allenneuraldynamics.org"
57-
DATABASE = "metadata_index"
58-
COLLECTION = "data_assets"
57+
# Default database and collection names are set in the client
58+
# DATABASE = "metadata_index"
59+
# COLLECTION = "data_assets"
5960
6061
docdb_api_client = MetadataDbClient(
6162
host=API_GATEWAY_HOST,
62-
database=DATABASE,
63-
collection=COLLECTION,
63+
# database=DATABASE,
64+
# collection=COLLECTION,
6465
)
6566
6667
filter = {"subject.subject_id": "731015"}

0 commit comments

Comments
 (0)