Skip to content

[ENH]: add API to list all databases for tenant #3432

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

Jump to bottom
Merged
merged 1 commit into from
Jan 10, 2025
Merged

[ENH]: add API to list all databases for tenant #3432

merged 1 commit into from
Jan 10, 2025

Conversation

codetheweb
Copy link
Contributor

@codetheweb codetheweb commented Jan 8, 2025 •
edited
Loading

Description of changes

Adds a method to the admin client to list all databases for a tenant. Has limit/offset parameters similar to how listing collections works.

The implementation for distributed Chroma is in a separate PR, next in this stack: #3440.

See https://github.com/chroma-core/hosted-chroma/issues/900 for main tracking issue.

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

Updated.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 8, 2025

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@codetheweb codetheweb marked this pull request as ready for review January 8, 2025 01:15
@codetheweb codetheweb requested a review from atroyn January 8, 2025 01:15
atroyn
atroyn suggested changes Jan 8, 2025
View reviewed changes
Copy link
Contributor

@atroyn atroyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we want the tests to cover the case where we have multiple tenants, since we want to be sure that we are correctly listing only the databases in a particular tenant.

Otherwise, implementation LGTM.

@codetheweb codetheweb requested a review from atroyn January 8, 2025 17:59
atroyn
atroyn reviewed Jan 8, 2025
View reviewed changes
chromadb/test/api/test_list_databases.py Outdated
for i in range(10):
admin_client.create_database(f"test_list_databases_is_tenant_scoped_{i}")

databases = admin_client.list_databases(None, None, "new_tenant")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably put some databases in the other tenant to list as well.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably be a fixture we reuse in each test.

atroyn
atroyn suggested changes Jan 8, 2025
View reviewed changes
Copy link
Contributor

@atroyn atroyn left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the tests could be still further extended. I'm thinking about protecting us against the scenario where one day someone lists databases and because of a bug we wrote gets other people's databases as well.

@codetheweb codetheweb mentioned this pull request Jan 8, 2025
Merged
1 task
@codetheweb codetheweb requested a review from atroyn January 8, 2025 19:39
@codetheweb codetheweb force-pushed the feat-list-databases-api branch from ff322a0 to 37701ee Compare January 9, 2025 00:18
@codetheweb Graphite App
Copy link
Contributor Author

codetheweb commented Jan 9, 2025 •
edited
Loading

This stack of pull requests is managed by Graphite. Learn more about stacking.

@codetheweb codetheweb mentioned this pull request Jan 9, 2025
Merged
1 task
atroyn
atroyn reviewed Jan 9, 2025
View reviewed changes
Copy link
Contributor

@atroyn atroyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks basically good to go, maybe some minor test improvements.

@codetheweb codetheweb requested a review from atroyn January 9, 2025 21:16
@codetheweb codetheweb force-pushed the feat-list-databases-api branch from f2fc604 to b9bdfe2 Compare January 9, 2025 21:55
@codetheweb codetheweb mentioned this pull request Jan 9, 2025
Merged
1 task
@codetheweb codetheweb force-pushed the feat-list-databases-api branch from b9bdfe2 to 8b3a2e8 Compare January 9, 2025 23:10
@codetheweb codetheweb force-pushed the feat-list-databases-api branch from 7d766c5 to 8b3a2e8 Compare January 9, 2025 23:29
@codetheweb Graphite App
Copy link
Contributor Author

codetheweb commented Jan 10, 2025 •
edited
Loading

Merge activity

  • Jan 9, 7:38 PM EST: A user started a stack merge that includes this pull request via Graphite.
  • Jan 9, 7:39 PM EST: A user merged this pull request with Graphite.

@codetheweb codetheweb merged commit 457f855 into main Jan 10, 2025
155 of 157 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@atroyn atroyn atroyn approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@codetheweb @atroyn