Skip to content

docs: list indexed fields #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
helen-m-lin merged 1 commit into from
Nov 10, 2025
Merged

docs: list indexed fields #192

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/source/ExamplesDocDBRestApi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,20 @@ REST API using the provided Python client.
Querying Metadata
~~~~~~~~~~~~~~~~~~~~~~

.. note::

There are a several indexed fields in the DocDB metadata collection to support
efficient query execution by limiting the number of documents to be scanned.
Please use these fields in your filter queries whenever possible.

Currently, the following fields are indexed in the v1 (``metadata_index/data_assets``)
collection: ``_id``, ``name``, ``location``, ``subject.subject_id``,
``data_description.project_name``, and ``data_description.modality.abbreviation``.

The same fields are indexed in the v2 (``metadata_index_v2/data_assets``) collection,
other than spelling for the modality field (``data_description.modalities.abbreviation``).


Count Example 1: Get # of records with a certain subject_id
-----------------------------------------------------------

Expand Down