DeprecationWarning: Passing transport options in the API method is deprecated. Use 'Elasticsearch.options()' instead.

[winnie0101]

When I use Search(index='test').filter('term', test='test').params(opaque_id='test',).execute(), I want to distinguish different search requests.
However, this triggers a DeprecationWarning: Passing transport options in the API method is deprecated. Use 'Elasticsearch.options()' instead.
Is it possible to fix this to avoid the warning?

It's is my package version:

• elasticsearch: 8.15.1
• elasticsearch-dsl: 8.15.4

[miguelgrinberg]

@winnie0101 If you pass an Elasticsearch client instance explicitly to your searches, then you can configure your options as recommended in the deprecation warning.

Here is an example:

client = Elasticsearch(...)
s = Search(
    using=client.options(opaque_id='test'),
    index='test'
)
s = s.filter('term', test='test')

for hit in s.execute():
    # ...

[winnie0101]

@miguelgrinberg Thanks for the reply!
Yeah, I know that can pass in an Elasticsearch client instance, but most of the time we’re just used to using the default connection (connections.create_connection(...)). So I was wondering — is there any plan to suppress that warning so we can stick with the default connection style?
Or do you generally recommend always passing in a client instance when running into stuff like this?

[miguelgrinberg]

The change that adds the deprecation message that you are seeing was made about 4 years ago and even though I wasn't involved with this project at the time the intention was to drive people away from mixing transport and client related options, in part because there can be naming collisions between them. I guess everything we've done in the past can be revisited or even reverted if warranted, but at this time making changes in this area is not in our plans, and the warning would eventually turn into an error when this feature is finally removed (although I do not know when this will happen).

I should add that it is possible to set up a default connection that includes an opaque id if that is what you need. Something like this:

from elasticsearch.dsl import connections

client = Elasticsearch(...).options(opaque_id='test')
connections.add_connection('default', client)

From this point on, the default connection that you provided will be used.

[winnie0101]

I think I roughly understand — this is meant to distinguish between the transport and the client. However, I personally believe that opaque_id should be request-level, and shouldn’t require creating a new client instance. Ideally, the DSL object could also support passing a transport parameter via a new function.

Because I can’t adjust the log level in our production environment and I’m concerned about missing important warnings, I’ve decided to pass in my own client to avoid generating warning messages.

Looking forward to seeing the solution in the future.
Thanks for your kind response!