Skip to content

[Feature Request] Provide an API to wait for the index creation #25

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.

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

Open
AlekSi opened this issue Jan 27, 2025 · 5 comments
Open

[Feature Request] Provide an API to wait for the index creation #25

AlekSi opened this issue Jan 27, 2025 · 5 comments
Assignees
Milestone

Comments

@AlekSi
Copy link
Contributor

AlekSi commented Jan 27, 2025

Purpose of the feature.
Currently, there is no non-internal API for waiting for the index creation; the usage documentdb_api.create_indexes_background's result is undocumented. FerretDB has to use an internal documentdb_api_internal.create_indexes_non_concurrently API.

Describe the solution you'd like
There is a non-internal documented API for that.
Alternatively, there is a non-internal documented API for creating indexes in the foreground.

Describe alternatives you've considered
Continue using the internal API.
Use documentdb_api_internal.check_build_index_status, which is also internal and not documented.

Additional context
None.

@AlekSi AlekSi added the enhancement New feature or request label Jan 27, 2025
@safern
Copy link
Member

safern commented Jan 27, 2025

cc: @amitprabhudesai

@sivethe sivethe assigned diipak-bisht and unassigned diipak-bisht Jan 28, 2025
@safern safern added this to the 0.101-0 milestone Jan 28, 2025
@safern safern added api approved and removed enhancement New feature or request labels Jan 31, 2025
@safern
Copy link
Member

safern commented Jan 31, 2025

We've decided to move check_build_index_status to the public schema to be able to wait on the foreground for a background index build rather than exposing the create_indexes_non_concurrently which needs to hold a connection and could be long running operation and we have been moving away from it slowly.

FYI: @visridha

@AlekSi
Copy link
Contributor Author

AlekSi commented Feb 1, 2025

Please make sure that this API is something we can actually use. Right now, it has some opaque parameters.

@safern
Copy link
Member

safern commented Feb 5, 2025

Assigning @amitprabhudesai as this is useless until we fix:
#36

@safern safern assigned amitprabhudesai and unassigned safern Feb 5, 2025
@safern safern modified the milestones: 0.101-0, 0.102-0 Feb 10, 2025
@AlekSi
Copy link
Contributor Author

AlekSi commented Mar 19, 2025

Do we know how the API will look like?

@safern safern modified the milestones: 0.102-0, 0.103-0 Mar 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants