Skip to content

Conversation

salvatore-campagna
Copy link
Contributor

@salvatore-campagna salvatore-campagna commented Aug 29, 2024

After all synthetic source improvements we introduced, documentation
needs to be updated to reflect the fact that it works for all field types
no matter the values of parameters like doc_values, store or
ignore_malformed.

Note that in this PR we only target removing incorrect information.
Better documentation about new functionality will be added as part
of another PR.

Resolves #112351

@salvatore-campagna salvatore-campagna added >docs General docs changes :StorageEngine/Logs You know, for Logs v8.16.0 labels Aug 29, 2024
@salvatore-campagna salvatore-campagna self-assigned this Aug 29, 2024
Copy link
Contributor

Documentation preview:

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-storage-engine (Team:StorageEngine)

@lkts
Copy link
Contributor

lkts commented Aug 29, 2024

This does not fix all of #112351, does it? So it should not be closed.

@salvatore-campagna
Copy link
Contributor Author

salvatore-campagna commented Oct 17, 2024

I will remove the following entries in another PR so that we can backport it easily
to relevant versions where synthetic source is GA.

IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
(indices that have `index.mode` set to `time_series`). For other indices
synthetic `_source` is in technical preview. Features in technical preview may
be changed or removed in a future release. Elastic will work to fix
any issues, but features in technical preview are not subject to the support SLA
of official GA features.

<<copy-to,`copy_to`>> or with <<doc-values,`doc_values`>> disabled.
default configuration.

Synthetic source always sorts `boolean` fields. For example:
Copy link
Contributor

Choose a reason for hiding this comment

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

Another note for a follow up is to replace "always sorts" with "may sort" or "does not preserve order" in cases like this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can have a single page that captures all this.

Copy link
Contributor Author

@salvatore-campagna salvatore-campagna Oct 18, 2024

Choose a reason for hiding this comment

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

I will just say "may change" because usually that statement is followed by an example where the order actually is different. So I think the sentence is relevant to understand the example.

Copy link
Member

@martijnvg martijnvg left a comment

Choose a reason for hiding this comment

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

LGTM

@salvatore-campagna salvatore-campagna merged commit ebd363d into elastic:main Oct 18, 2024
5 checks passed
@salvatore-campagna salvatore-campagna added auto-backport Automatically create backport pull requests when merged v8.16.0 v8.16.1 labels Oct 18, 2024
salvatore-campagna added a commit to salvatore-campagna/elasticsearch that referenced this pull request Oct 18, 2024
* docs: update synthetic source docs

* fix: also doc values false works

* Revert "fix: also doc values false works"

This reverts commit 0895a76.

* fix: update synthetic source documentation

* fix: all field types support it

* fix: no need to explicitly mention it

* fix: synthetic source sorting

* fix: may instead of might

(cherry picked from commit ebd363d)
salvatore-campagna added a commit to salvatore-campagna/elasticsearch that referenced this pull request Oct 18, 2024
* docs: update synthetic source docs

* fix: also doc values false works

* Revert "fix: also doc values false works"

This reverts commit 0895a76.

* fix: update synthetic source documentation

* fix: all field types support it

* fix: no need to explicitly mention it

* fix: synthetic source sorting

* fix: may instead of might

(cherry picked from commit ebd363d)
@salvatore-campagna
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
8.x
8.16

Questions ?

Please refer to the Backport tool documentation

georgewallace pushed a commit to georgewallace/elasticsearch that referenced this pull request Oct 25, 2024
* docs: update synthetic source docs

* fix: also doc values false works

* Revert "fix: also doc values false works"

This reverts commit 0895a76.

* fix: update synthetic source documentation

* fix: all field types support it

* fix: no need to explicitly mention it

* fix: synthetic source sorting

* fix: may instead of might
jfreden pushed a commit to jfreden/elasticsearch that referenced this pull request Nov 4, 2024
* docs: update synthetic source docs

* fix: also doc values false works

* Revert "fix: also doc values false works"

This reverts commit 0895a76.

* fix: update synthetic source documentation

* fix: all field types support it

* fix: no need to explicitly mention it

* fix: synthetic source sorting

* fix: may instead of might
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes :StorageEngine/Logs You know, for Logs Team:Docs Meta label for docs team Team:StorageEngine v8.16.0 v8.16.1 v8.17.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update synthetic source documentation for all field types
5 participants