[DOCS] Document async SQL APIs #75078
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
Contributor
Author
|
@elasticmachine update branch |
Contributor
Author
|
@elasticmachine update branch |
jrodewig
added
:Analytics/SQL
elasticmachine
added
Team:QL (Deprecated)
Collaborator
|
Pinging @elastic/clients-team (Team:Clients) |
Collaborator
|
Pinging @elastic/es-ql (Team:QL) |
Collaborator
|
Pinging @elastic/es-docs (Team:Docs) |
jrodewig
added
the
auto-backport
bpintea
approved these changes
Jul 8, 2021
| ==== {api-query-parms-title} | ||
|
|
||
| `delimiter`:: | ||
| (Optional, string) Separator for CSV results. Defaults to `,`. The API only |
| @@ -0,0 +1,51 @@ | |||
| { | |||
Contributor
There was a problem hiding this comment.
It should be clear that this is different from sql.query.json, but don't know if clear enough that all these are async SQL APIs. Up to you, not sure if there's a conversion about this.
Contributor
Author
There was a problem hiding this comment.
Thanks @bpintea. I used the same naming scheme we have for EQL:
However, I'll add async to the SQL versions so its a bit more clear.
Contributor
|
LGTM! |
Contributor
Author
|
@elasticmachine ok to test |
jrodewig
removed
the
auto-backport
This was referenced Jul 12, 2021
elasticsearchmachine
pushed a commit
to elasticsearchmachine/elasticsearch
that referenced
this pull request
Jul 12, 2021
Adds formal API docs and JSON specs for the following APIs: * Get async SQL search * Get async SQL search status * Delete async SQL search Closes elastic#74845
elasticsearchmachine
pushed a commit
to elasticsearchmachine/elasticsearch
that referenced
this pull request
Jul 12, 2021
Adds formal API docs and JSON specs for the following APIs: * Get async SQL search * Get async SQL search status * Delete async SQL search Closes elastic#74845
Collaborator
elasticsearchmachine
added a commit
that referenced
this pull request
Jul 12, 2021
Adds formal API docs and JSON specs for the following APIs: * Get async SQL search * Get async SQL search status * Delete async SQL search Closes #74845 Co-authored-by: James Rodewig <[email protected]>
elasticsearchmachine
added a commit
that referenced
this pull request
Jul 12, 2021
Adds formal API docs and JSON specs for the following APIs: * Get async SQL search * Get async SQL search status * Delete async SQL search Closes #74845 Co-authored-by: James Rodewig <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds formal API docs and JSON specs for the following APIs:
I plan to migrate some other existing APIs (SQL search, translate, clear cursor) to this page in a separate PR.
Closes #74845
Previews