Skip to content

[Backport 2.19-dev] Run settings doctests last and remove per-doc “rollback” sections #4480

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
penghuo merged 1 commit into from
Oct 9, 2025
Merged

[Backport 2.19-dev] Run settings doctests last and remove per-doc “rollback” sections #4480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion docs/category.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"bash": [
"user/ppl/interfaces/endpoint.rst",
"user/ppl/interfaces/protocol.rst",
"user/ppl/admin/settings.rst",
"user/optimization/optimization.rst",
"user/admin/settings.rst"
],
Expand Down Expand Up @@ -64,5 +63,8 @@
"user/ppl/functions/string.rst",
"user/ppl/general/datatypes.rst",
"user/ppl/general/identifiers.rst"
],
"bash_settings": [
"user/ppl/admin/settings.rst"
]
}
43 changes: 0 additions & 43 deletions docs/user/ppl/admin/settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,22 +73,6 @@ PPL query::
"status": 400
}

Example 3
---------

You can reset the setting to default value like this.

PPL query::

sh$ curl -sS -H 'Content-Type: application/json' \
... -X PUT localhost:9200/_plugins/_query/settings \
... -d '{"transient" : {"plugins.ppl.enabled" : null}}'
{
"acknowledged": true,
"persistent": {},
"transient": {}
}

plugins.query.memory_limit
==========================

Expand Down Expand Up @@ -147,17 +131,6 @@ Change the size_limit to 1000::
"transient": {}
}

Rollback to default value::

sh$ curl -sS -H 'Content-Type: application/json' \
... -X PUT localhost:9200/_plugins/_query/settings \
... -d '{"persistent" : {"plugins.query.size_limit" : null}}'
{
"acknowledged": true,
"persistent": {},
"transient": {}
}

Note: the legacy settings of ``opendistro.query.size_limit`` is deprecated, it will fallback to the new settings if you request an update with the legacy name.

plugins.calcite.all_join_types.allowed
Expand Down Expand Up @@ -270,22 +243,6 @@ PPL query::
Example 2
---------

Reset to default (unlimited) by setting to null:

PPL query::

sh$ curl -sS -H 'Content-Type: application/json' \
... -X PUT localhost:9200/_plugins/_query/settings \
... -d '{"transient" : {"plugins.ppl.values.max.limit" : null}}'
{
"acknowledged": true,
"persistent": {},
"transient": {}
}

Example 3
---------

Set to 0 explicitly for unlimited values:

PPL query::
Expand Down
10 changes: 9 additions & 1 deletion doctest/test_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,16 +365,24 @@ def create_cli_suite(filepaths, parser, setup_func):
# Entry point for unittest discovery
def load_tests(loader, suite, ignore):
tests = []
settings_tests = []
category_manager = CategoryManager()

for category_name in category_manager.get_all_categories():
docs = category_manager.get_category_files(category_name)
if not docs:
continue

tests.append(get_test_suite(category_manager, category_name, get_doc_filepaths(docs)))
suite = get_test_suite(category_manager, category_name, get_doc_filepaths(docs))
if 'settings' in category_name:
settings_tests.append(suite)
else:
tests.append(suite)

random.shuffle(tests)
if settings_tests:
random.shuffle(settings_tests)
tests.extend(settings_tests)
return DocTests(tests)

def get_test_suite(category_manager: CategoryManager, category_name, filepaths):
Expand Down
Loading