Skip to content

[8.10] Add Synonyms and Query rules APIs #2300

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

Merged
merged 3 commits into from
Sep 21, 2023
Merged

[8.10] Add Synonyms and Query rules APIs #2300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
830894e
Auto-generated code for 8.10
pquentin Sep 14, 2023
d99a582
Fix auto generation for Synonyms and Query Ruleset APIs
pquentin Sep 14, 2023
b333bd4
Update client to reflect elasticsearch-specification#2276
pquentin Sep 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/sphinx/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,12 @@ Nodes
.. autoclass:: NodesClient
:members:

Query rules
-----------

.. autoclass:: QueryRulesetClient
:members:

Rollup Indices
--------------

Expand Down Expand Up @@ -192,6 +198,12 @@ SQL
.. autoclass:: SqlClient
:members:

Synonyms
--------

.. autoclass:: SynonymsClient
:members:

TLS/SSL
-------

Expand Down
325 changes: 193 additions & 132 deletions elasticsearch/_async/client/__init__.py
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions elasticsearch/_async/client/async_search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ async def delete(
Deletes an async search by ID. If the search is still running, the search request
will be cancelled. Otherwise, the saved search results are deleted.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/async-search.html>`_

:param id: A unique identifier for the async search.
"""
Expand Down Expand Up @@ -82,7 +82,7 @@ async def get(
Retrieves the results of a previously submitted async search request given its
ID.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/async-search.html>`_

:param id: A unique identifier for the async search.
:param keep_alive: Specifies how long the async search should be available in
Expand Down Expand Up @@ -139,7 +139,7 @@ async def status(
Retrieves the status of a previously submitted async search request given its
ID.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/async-search.html>`_

:param id: A unique identifier for the async search.
"""
Expand Down Expand Up @@ -310,7 +310,7 @@ async def submit(
"""
Executes a search request asynchronously.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/async-search.html>`_

:param index: A comma-separated list of index names to search; use `_all` or
empty string to perform the operation on all indices
Expand Down
8 changes: 4 additions & 4 deletions elasticsearch/_async/client/autoscaling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ async def delete_autoscaling_policy(
Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
Direct use is not supported.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-delete-autoscaling-policy.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/autoscaling-delete-autoscaling-policy.html>`_

:param name: the name of the autoscaling policy
"""
Expand Down Expand Up @@ -76,7 +76,7 @@ async def get_autoscaling_capacity(
Gets the current autoscaling capacity based on the configured autoscaling policy.
Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/autoscaling-get-autoscaling-capacity.html>`_
"""
__path = "/_autoscaling/capacity"
__query: t.Dict[str, t.Any] = {}
Expand Down Expand Up @@ -109,7 +109,7 @@ async def get_autoscaling_policy(
Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
Direct use is not supported.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/autoscaling-get-autoscaling-capacity.html>`_

:param name: the name of the autoscaling policy
"""
Expand Down Expand Up @@ -149,7 +149,7 @@ async def put_autoscaling_policy(
Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
Direct use is not supported.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-put-autoscaling-policy.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/autoscaling-put-autoscaling-policy.html>`_

:param name: the name of the autoscaling policy
:param policy:
Expand Down
141 changes: 80 additions & 61 deletions elasticsearch/_async/client/cat.py
View file
Open in desktop

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions elasticsearch/_async/client/ccr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ async def delete_auto_follow_pattern(
"""
Deletes auto-follow patterns.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-delete-auto-follow-pattern.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-delete-auto-follow-pattern.html>`_

:param name: The name of the auto follow pattern.
"""
Expand Down Expand Up @@ -96,7 +96,7 @@ async def follow(
"""
Creates a new follower index configured to follow the referenced leader index.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-put-follow.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-put-follow.html>`_

:param index: The name of the follower index
:param leader_index:
Expand Down Expand Up @@ -180,7 +180,7 @@ async def follow_info(
Retrieves information about all follower indices, including parameters and status
for each follower index

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-get-follow-info.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-get-follow-info.html>`_

:param index: A comma-separated list of index patterns; use `_all` to perform
the operation on all indices
Expand Down Expand Up @@ -218,7 +218,7 @@ async def follow_stats(
Retrieves follower stats. return shard-level stats about the following tasks
associated with each shard for the specified indices.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-get-follow-stats.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-get-follow-stats.html>`_

:param index: A comma-separated list of index patterns; use `_all` to perform
the operation on all indices
Expand Down Expand Up @@ -261,7 +261,7 @@ async def forget_follower(
"""
Removes the follower retention leases from the leader.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-post-forget-follower.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-post-forget-follower.html>`_

:param index: the name of the leader index for which specified follower retention
leases should be removed
Expand Down Expand Up @@ -312,7 +312,7 @@ async def get_auto_follow_pattern(
Gets configured auto-follow patterns. Returns the specified auto-follow pattern
collection.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-get-auto-follow-pattern.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-get-auto-follow-pattern.html>`_

:param name: Specifies the auto-follow pattern collection that you want to retrieve.
If you do not specify a name, the API returns information for all collections.
Expand Down Expand Up @@ -350,7 +350,7 @@ async def pause_auto_follow_pattern(
"""
Pauses an auto-follow pattern

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-pause-auto-follow-pattern.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-pause-auto-follow-pattern.html>`_

:param name: The name of the auto follow pattern that should pause discovering
new indices to follow.
Expand Down Expand Up @@ -388,7 +388,7 @@ async def pause_follow(
Pauses a follower index. The follower index will not fetch any additional operations
from the leader index.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-post-pause-follow.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-post-pause-follow.html>`_

:param index: The name of the follower index that should pause following its
leader index.
Expand Down Expand Up @@ -452,7 +452,7 @@ async def put_auto_follow_pattern(
cluster. Newly created indices on the remote cluster matching any of the specified
patterns will be automatically configured as follower indices.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-put-auto-follow-pattern.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-put-auto-follow-pattern.html>`_

:param name: The name of the collection of auto-follow patterns.
:param remote_cluster: The remote cluster containing the leader indices to match
Expand Down Expand Up @@ -566,7 +566,7 @@ async def resume_auto_follow_pattern(
"""
Resumes an auto-follow pattern that has been paused

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-resume-auto-follow-pattern.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-resume-auto-follow-pattern.html>`_

:param name: The name of the auto follow pattern to resume discovering new indices
to follow.
Expand Down Expand Up @@ -619,7 +619,7 @@ async def resume_follow(
"""
Resumes a follower index that has been paused

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-post-resume-follow.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-post-resume-follow.html>`_

:param index: The name of the follow index to resume following.
:param max_outstanding_read_requests:
Expand Down Expand Up @@ -693,7 +693,7 @@ async def stats(
"""
Gets all stats related to cross-cluster replication.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-get-stats.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-get-stats.html>`_
"""
__path = "/_ccr/stats"
__query: t.Dict[str, t.Any] = {}
Expand Down Expand Up @@ -726,7 +726,7 @@ async def unfollow(
Stops the following task associated with a follower index and removes index metadata
and settings associated with cross-cluster replication.

`<https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-post-unfollow.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ccr-post-unfollow.html>`_

:param index: The name of the follower index that should be turned into a regular
index.
Expand Down
Loading