replace es with client

Author: iuliaferoli

docs/examples/3d1ff6097e2359f927c88c2ccdb36252.asciidoc

@@ -2,6 +2,6 @@
 
 [source, python]
 ----
-resp = es.info()
+resp = client.info()
 print(resp)
 ----

docs/guide/configuration.asciidoc

@@ -20,7 +20,7 @@ If you have your own CA bundle to use you can configure via the `ca_certs` param
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(
+client = Elasticsearch(
     "https://...",
     ca_certs="/path/to/certs.pem"
 )
@@ -32,7 +32,7 @@ In Python 3.9 and earlier only the leaf certificate will be verified but in Pyth
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(
+client = Elasticsearch(
     "https://...",
     ssl_assert_fingerprint=(
         "315f5bdb76d078c43b8ac0064e4a0164612b1fce77c869345bfc94c75894edd3"
@@ -44,7 +44,7 @@ To disable certificate verification use the `verify_certs=False` parameter. This
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(
+client = Elasticsearch(
     "https://...",
     verify_certs=False
 )
@@ -59,7 +59,7 @@ Configuring the minimum TLS version to connect to is done via the `ssl_version`
 ------------------------------------
 import ssl
 
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     ssl_version=ssl.TLSVersion.TLSv1_2
 )
@@ -72,7 +72,7 @@ Elasticsearch can be configured to authenticate clients via TLS client certifica
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     client_cert="/path/to/cert.pem",
     client_key="/path/to/key.pem",
@@ -93,7 +93,7 @@ import ssl
 ctx = ssl.create_default_context()
 ctx.load_verify_locations(...)
 
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     ssl_context=ctx
 )
@@ -110,7 +110,7 @@ the `Accept-Encoding: gzip` HTTP header. By default compression is disabled.
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     http_compress=True  # Enable compression!
 )
@@ -130,13 +130,13 @@ Setting `request_timeout` to `None` will disable timeouts.
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     request_timeout=10  # 10 second timeout
 )
 
 # Search request will timeout in 5 seconds
-es.options(request_timeout=5).search(...)
+client.options(request_timeout=5).search(...)
 ------------------------------------
 
 [discrete]
@@ -148,7 +148,7 @@ In the example below there are three different configurable timeouts for the `cl
 
 [source,python]
 ------------------------------------
-es.options(
+client.options(
     # Amount of time to wait for an HTTP response to start.
     request_timeout=30
 ).cluster.health(
@@ -170,13 +170,13 @@ The maximum number of retries per request can be configured via the `max_retries
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     max_retries=5
 )
 
 # For this API request we disable retries with 'max_retries=0'
-es.options(max_retries=0).index(
+client.options(max_retries=0).index(
     index="blogs",
     document={
         "title": "..."
@@ -191,11 +191,11 @@ Connection errors are automatically retried if retries are enabled. Retrying req
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     retry_on_timeout=True
 )
-es.options(retry_on_timeout=False).info()
+client.options(retry_on_timeout=False).info()
 ------------------------------------
 
 [discrete]
@@ -205,13 +205,13 @@ By default if retries are enabled `retry_on_status` is set to `(429, 502, 503, 5
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     retry_on_status=()
 )
 
 # Retry this API on '500 Internal Error' statuses
-es.options(retry_on_status=[500]).index(
+client.options(retry_on_status=[500]).index(
     index="blogs",
     document={
         "title": "..."
@@ -228,14 +228,14 @@ A good example where this is useful is setting up or cleaning up resources in a
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(...)
+client = Elasticsearch(...)
 
 # API request is robust against the index not existing:
-resp = es.options(ignore_status=404).indices.delete(index="delete-this")
+resp = client.options(ignore_status=404).indices.delete(index="delete-this")
 resp.meta.status  # Can be either '2XX' or '404'
 
 # API request is robust against the index already existing:
-resp = es.options(ignore_status=[400]).indices.create(
+resp = client.options(ignore_status=[400]).indices.create(
     index="create-this",
     mapping={
         "properties": {"field": {"type": "integer"}}
@@ -322,7 +322,7 @@ You can specify a node selector pattern via the `node_selector_class` parameter.
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     node_selector_class="round_robin"
 )
@@ -337,7 +337,7 @@ from elastic_transport import NodeSelector
 class CustomSelector(NodeSelector):
     def select(nodes): ...
 
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     node_selector_class=CustomSelector
 )
@@ -374,7 +374,7 @@ class JsonSetSerializer(JsonSerializer):
             return list(data)
         return super().default(data)
 
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     # Serializers are a mapping of 'mimetype' to Serializer class.
     serializers={"application/json": JsonSetSerializer()}
@@ -397,7 +397,7 @@ For all of the built-in HTTP node implementations like `urllib3`, `requests`, an
 ------------------------------------
 from elasticsearch import Elasticsearch
 
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     node_class="requests"
 )
@@ -413,7 +413,7 @@ from elastic_transport import Urllib3HttpNode
 class CustomHttpNode(Urllib3HttpNode):
     ...
 
-es = Elasticsearch(
+client = Elasticsearch(
     ...
     node_class=CustomHttpNode
 )
@@ -426,7 +426,7 @@ Each node contains its own pool of HTTP connections to allow for concurrent requ
 
 [source,python]
 ------------------------------------
-es = Elasticsearch(
+client = Elasticsearch(
     ...,
     connections_per_node=5
 )

docs/guide/connecting.asciidoc

@@ -251,21 +251,21 @@ or via the per-request `.options()` method:
 from elasticsearch import Elasticsearch
 
 # Authenticate from the constructor
-es = Elasticsearch(
+client = Elasticsearch(
     "https://localhost:9200",
     ca_certs="/path/to/http_ca.crt",
     basic_auth=("username", "password")
 )
 
 # Authenticate via the .options() method:
-es.options(
+client.options(
     basic_auth=("username", "password")
 ).indices.get(index="*")
 
 # You can persist the authenticated client to use
 # later or use for multiple API calls:
-auth_client = es.options(
-    api_key=("api-key-id", "api-key-secret")
+auth_client = client.options(
+    api_key=("api-key")
 )
 for i in range(10):
     auth_client.index(
@@ -287,7 +287,7 @@ username and password within a tuple:
 from elasticsearch import Elasticsearch
 
 # Adds the HTTP header 'Authorization: Basic <base64 username:password>'
-es = Elasticsearch(
+client = Elasticsearch(
     "https://localhost:9200",
     ca_certs="/path/to/http_ca.crt",
     basic_auth=("username", "password")
@@ -309,7 +309,7 @@ and https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-ap
 from elasticsearch import Elasticsearch
 
 # Adds the HTTP header 'Authorization: Bearer token-value'
-es = Elasticsearch(
+client = Elasticsearch(
     "https://localhost:9200",
     bearer_auth="token-value"
 )
@@ -329,10 +329,10 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-cre
 from elasticsearch import Elasticsearch
 
 # Adds the HTTP header 'Authorization: ApiKey <base64 api_key.id:api_key.api_key>'
-es = Elasticsearch(
+client = Elasticsearch(
     "https://localhost:9200",
     ca_certs="/path/to/http_ca.crt",
-    api_key=("api_key.id", "api_key.api_key")
+    api_key=("api_key")
 )
 ----
 

docs/sphinx/async.rst

@@ -27,10 +27,10 @@ and are used in the same way as other APIs, just with an extra ``await``:
     import asyncio
     from elasticsearch import AsyncElasticsearch
 
-    es = AsyncElasticsearch()
+    client = AsyncElasticsearch()
 
     async def main():
-        resp = await es.search(
+        resp = await client.search(
             index="documents",
             body={"query": {"match_all": {}}},
             size=20,
@@ -97,20 +97,20 @@ For example if using FastAPI that might look like this:
     from elasticsearch import AsyncElasticsearch
 
     ELASTICSEARCH_URL = os.environ["ELASTICSEARCH_URL"]
-    es = None
+    client = None
 
     @asynccontextmanager
     async def lifespan(app: FastAPI):
-        global es
-        es = AsyncElasticsearch(ELASTICSEARCH_URL)
+        global client
+        client = AsyncElasticsearch(ELASTICSEARCH_URL)
         yield
-        await es.close()
+        await client.close()
 
     app = FastAPI(lifespan=lifespan)
 
     @app.get("/")
     async def main():
-        return await es.info()
+        return await client.info()
 
 You can run this example by saving it to ``main.py`` and executing
 ``ELASTICSEARCH_URL=http://localhost:9200 uvicorn main:app``.
@@ -140,7 +140,7 @@ Bulk and Streaming Bulk
     from elasticsearch import AsyncElasticsearch
     from elasticsearch.helpers import async_bulk
 
-    es = AsyncElasticsearch()
+    client = AsyncElasticsearch()
 
     async def gendata():
         mywords = ['foo', 'bar', 'baz']
@@ -151,7 +151,7 @@ Bulk and Streaming Bulk
             }
 
     async def main():
-        await async_bulk(es, gendata())
+        await async_bulk(client, gendata())
 
     loop = asyncio.get_event_loop()
     loop.run_until_complete(main())
@@ -164,7 +164,7 @@ Bulk and Streaming Bulk
     from elasticsearch import AsyncElasticsearch
     from elasticsearch.helpers import async_streaming_bulk
 
-    es = AsyncElasticsearch()
+    client = AsyncElasticsearch()
 
     async def gendata():
         mywords = ['foo', 'bar', 'baz']
@@ -175,7 +175,7 @@ Bulk and Streaming Bulk
             }
 
     async def main():
-        async for ok, result in async_streaming_bulk(es, gendata()):
+        async for ok, result in async_streaming_bulk(client, gendata()):
             action, result = result.popitem()
             if not ok:
                 print("failed to %s document %s" % ())
@@ -194,11 +194,11 @@ Scan
     from elasticsearch import AsyncElasticsearch
     from elasticsearch.helpers import async_scan
 
-    es = AsyncElasticsearch()
+    client = AsyncElasticsearch()
 
     async def main():
         async for doc in async_scan(
-            client=es,
+            client=client,
             query={"query": {"match": {"title": "python"}}},
             index="orders-*"
         ):

docs/sphinx/index.rst

@@ -50,22 +50,22 @@ Example Usage
     from datetime import datetime
     from elasticsearch import Elasticsearch
 
-    es = Elasticsearch("http://localhost:9200")
+    client = Elasticsearch(cloud_id="YOUR_CLOUD_ID", api_key="YOUR_API_KEY")
 
     doc = {
         "author": "kimchy",
         "text": "Elasticsearch: cool. bonsai cool.",
         "timestamp": datetime.now(),
     }
-    resp = es.index(index="test-index", id=1, document=doc)
+    resp = client.index(index="test-index", id=1, document=doc)
     print(resp["result"])
 
-    resp = es.get(index="test-index", id=1)
+    resp = client.get(index="test-index", id=1)
     print(resp["_source"])
 
-    es.indices.refresh(index="test-index")
+    client.indices.refresh(index="test-index")
 
-    resp = es.search(index="test-index", query={"match_all": {}})
+    resp = client.search(index="test-index", query={"match_all": {}})
     print("Got {} hits:".format(resp["hits"]["total"]["value"]))
     for hit in resp["hits"]["hits"]:
         print("{timestamp} {author} {text}".format(**hit["_source"]))