Skip to content

Added documentation for the plugins.query.field_type_tolerance setting (#1300)#3118

Merged
penghuo merged 5 commits intoopensearch-project:mainfrom
Bit-Quill:issue-1300-documentation
Oct 31, 2024
Merged

Added documentation for the plugins.query.field_type_tolerance setting (#1300)#3118
penghuo merged 5 commits intoopensearch-project:mainfrom
Bit-Quill:issue-1300-documentation

Conversation

@normanj-bitquill
Copy link
Copy Markdown
Contributor

Description

Add documentation for the plugins.query.field_type_tolerance setting.

Related Issues

Resolves #1300

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • New functionality has javadoc added.
  • New functionality has a user manual doc added.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff.
  • Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Norman Jordan <norman.jordan@improving.com>
@normanj-bitquill normanj-bitquill changed the title Added documentation for the plugins.query.field_type_tolerance setting Added documentation for the plugins.query.field_type_tolerance setting (#1300) Oct 24, 2024

Update Settings Request::

sh$ curl -sS -H 'Content-Type: application/json' -X PUT 'localhost:9200/_cluster/settings?pretty' \
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could u follow plugins.query.size_limit setting doc style.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Used that style for the commands to update the setting.

This setting controls whether preserve arrays. If this setting is set to false, then an array is reduced
to the first non array value of any level of nesting.

If you have an index with the following value for a field::
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have reworked the documentation. It still does not actually run the queries, although they are run for other files such as user/beyond/partiql.rst.

Copy link
Copy Markdown
Collaborator

@penghuo penghuo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could u add limitation of this setting. for instance, expression will failed.

Signed-off-by: Norman Jordan <norman.jordan@improving.com>
Signed-off-by: Norman Jordan <norman.jordan@improving.com>
@normanj-bitquill
Copy link
Copy Markdown
Contributor Author

normanj-bitquill commented Oct 28, 2024

could u add limitation of this setting. for instance, expression will failed.

@penghuo I added a limitations section.

Signed-off-by: Norman Jordan <norman.jordan@improving.com>
Signed-off-by: Norman Jordan <norman.jordan@improving.com>
Copy link
Copy Markdown
Collaborator

@penghuo penghuo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx!

@dai-chen dai-chen added the documentation Improvements or additions to documentation label Oct 30, 2024
@penghuo penghuo merged commit 9bb4c08 into opensearch-project:main Oct 31, 2024
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 31, 2024
#1300) (#3118)

Signed-off-by: Norman Jordan <norman.jordan@improving.com>
(cherry picked from commit 9bb4c08)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
penghuo pushed a commit that referenced this pull request Nov 1, 2024
#1300) (#3118) (#3143)

(cherry picked from commit 9bb4c08)

Signed-off-by: Norman Jordan <norman.jordan@improving.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 2.x documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DISCUSSION] Properly support array values in new engine

3 participants