Skip to content
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.

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

Add up-to-date docs for near-realtime search #40644

Closed
DaveCTurner opened this issue Mar 29, 2019 · 4 comments · Fixed by #57560
Closed

Add up-to-date docs for near-realtime search #40644

DaveCTurner opened this issue Mar 29, 2019 · 4 comments · Fixed by #57560
Assignees
Labels
:Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes help wanted adoptme Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team

Comments

@DaveCTurner
Copy link
Contributor

The very first basic concept is that Elasticsearch is a near-realtime NRT search platform, but this is not defined in more depth in the reference manual. We receive questions (with low but nonzero frequency) of the form "I wrote a document and got an ack and then tried to search for it and it wasn’t there" and it'd be good if there was somewhere in the docs that answers this question so we could just share a link.

Today our options are:

I think it'd be great if we could rework this into a single place in the reference docs that describes what NRT means as a concept, and how refreshes happen in Elasticsearch. Although it isn't really anything to do with replication, the replication overview is really more about the read and write models and I think that documenting the visibility semantics could fit here.

Additionally, it's not very clear that update-by-query and delete-by-query rely on searches, and therefore depend on which documents have been refreshed.

/cc @elastic/docs

@DaveCTurner DaveCTurner added >docs General docs changes help wanted adoptme :Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. labels Mar 29, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed

@wchrisdean
Copy link
Contributor

[doc issue triage]

@rjernst rjernst added Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team labels May 4, 2020
@lockewritesdocs
Copy link
Contributor

@DaveCTurner, I opened #57560 to address this issue. Regarding this statement:

Although it isn't really anything to do with replication, the replication overview is really more about the read and write models and I think that documenting the visibility semantics could fit here.

Are you hoping to condense the concepts of the read/write model into the topic for near-real time search? Namely describing how ES uses a replication group for writes and a coordinator node for reads, both of which can impact the refresh? I just want to ensure that I understand your intention.

@DaveCTurner
Copy link
Contributor Author

I think a separate page is fine, no need to combine this with the replication overview. However, I think we should mention something about refreshes on the replication overview page too, to avoid any doubt that there must be a refresh in between writing a document and being able to read it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes help wanted adoptme Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants