Skip to content

Add param passing notes to documentation on Search.delete #1970

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

Closed

Conversation

lunalucadou
Copy link

@lunalucadou lunalucadou commented Mar 27, 2025

Earlier today I was trying to pass wait_for_completion=True to Search.delete but found Search.delete does not support **kwargs.

I was going to just add support for **kwargs (it would be a fairly trivial change), but after seeing #1115 and #1395, it seems the preferred way is to call Search.params first. However, this is not called out in the documentation for Search.delete, so I instead opted to add it to the documentation.

While I was at it, I noticed Search.scan and FacetedSearch.params had broken links so I fixed those as well.

Edit: Closing in favor of MR on the other repo: elastic/elasticsearch-py#2861

… links

The preferred way of passing parameters to `Search.delete` appears to be calling `Search.params` first,
but this is only ever discussed in GitHub issues like elastic#1115 and elastic#1395.

To help anyone else who has stumbled across this, I added a note about this to the documentation.

I also went ahead and updated the links for the `Search.scan` and `FacetedSearch.params` methods to the most recent versions since they were 404ing.
Copy link

❌ Author of the following commits did not sign a Contributor Agreement:
d2c644a

Please, read and sign the above mentioned agreement if you want to contribute to this project

@lunalucadou
Copy link
Author

I have signed the CLA. Do I need to attach the PDF to verify this?

@miguelgrinberg
Copy link
Collaborator

Thanks!

First of all, when the CLA checker doesn't detect you have signed it means that you are using a different email address on this PR than the one you used to sign.

Second, note that we are not going to continue the development of this package here. Instead, starting from the 8.18 release due in April this package is going to be deprecated and all the DSL code will be integrated with the main Python client (https://github.com/elastic/elasticsearch-py).

Would you like to submit this change over there? The DSL files are all in the elasticsearch/dsl subdirectory, with the same structure as in here. I can also apply the change myself if you prefer.

@lunalucadou
Copy link
Author

Ah, I have a different email in my git config for an internal gitlab instance. I'll redo the CLA and port the changes to the new repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants