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.

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

Jump to bottom

SQL: documentation improvements and updates #36918

Merged
merged 4 commits into from
Dec 21, 2018
Merged

SQL: documentation improvements and updates #36918

merged 4 commits into from
Dec 21, 2018

Conversation

astefan
Copy link
Contributor

@astefan astefan commented Dec 20, 2018

  • Added Limitations page
  • Made the aggregations page follow the common template for functions
  • Modified all tables to have the first row's cells content centered. The header option was ignored and all tables that had the cells content centered for the header row were actually not working as expected.
  • Polishing in other various sections

@astefan
* Added Limitations page
2068e9d 
* Made the aggregations page follow the common template for functions
* Modified all tables to have the first row's cells content centered
* Polishing in other various sections
@astefan astefan added >docs General docs changes v7.0.0 :Analytics/SQL SQL querying v6.6.0 v6.7.0 labels Dec 20, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search

matriv
matriv approved these changes Dec 21, 2018
View reviewed changes
Copy link
Contributor

@matriv matriv left a comment

Choose a reason for hiding this comment

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

LGTM. Nice work on making the docs consistent and making the start for a limitations page!
Left some comments mostly about phrasing.

docs/reference/sql/functions/date-time.asciidoc
@@ -139,15 +132,8 @@ include-tagged::{sql-specs}/docs.csv-spec[curTsFunction]
include-tagged::{sql-specs}/docs.csv-spec[curTsFunctionPrecision]
--------------------------------------------------

Typically this function is used for relative date/time filtering:
Copy link
Contributor

Choose a reason for hiding this comment

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

I would keep this also here for current_timestamp

docs/reference/sql/limitations.asciidoc Outdated
=== Nested fields in `SYS COLUMNS` and `DESCRIBE TABLE`

{es} has a special type of relationship fields called `nested` fields. In {es-sql} they can be used by referencing their inner
sub-fields. These being said, though, `SYS COLUMNS` and `DESCRIBE TABLE` will still display them having the type `NESTED`
Copy link
Contributor

Choose a reason for hiding this comment

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

I would change that to: Even though SYS_COLUMNS and..., they cannot be used...

docs/reference/sql/limitations.asciidoc Outdated
[float]
=== Multi-nested fields

{es-sql} doesn't support multi-nested documents. This refers to queries that make reference to more than one nested field in an index.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would rephrase: ... multi-nested documents, so a query cannot reference more than one ...

docs/reference/sql/limitations.asciidoc Outdated
[float]
=== Paginating nested inner hits

When SELECTing a nested field, pagination will not work as expected {es-sql} returning __at least__ the page size records. This is like
Copy link
Contributor

Choose a reason for hiding this comment

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

...expected, {es-sql} will return...

Copy link
Contributor

Choose a reason for hiding this comment

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

Also: This is because of the way...

costin
costin approved these changes Dec 21, 2018
View reviewed changes
Copy link
Member

@costin costin left a comment

Choose a reason for hiding this comment

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

LGTM

@astefan astefan merged commit 09fa827 into elastic:master Dec 21, 2018
@astefan astefan deleted the docs_improvements branch December 21, 2018 21:26
jasontedor added a commit to ywelsch/elasticsearch that referenced this pull request Dec 21, 2018
@jasontedor
Merge remote-tracking branch 'elastic/master' into pr/36137
8de54b8 
* elastic/master: (539 commits)
  SQL: documentation improvements and updates (elastic#36918)
  [DOCS] Merges list of discovery and cluster formation settings (elastic#36909)
  Only compress responses if request was compressed (elastic#36867)
  Remove duplicate paragraph (elastic#36942)
  Fix URI to cluster stats endpoint on specific nodes (elastic#36784)
  Fix typo in unitTest task (elastic#36930)
  RecoveryMonitor#lastSeenAccessTime should be volatile (elastic#36781)
  [CCR] Add `ccr.auto_follow_coordinator.wait_for_timeout` setting (elastic#36714)
  Scripting: Remove deprecated params.ctx (elastic#36848)
  Refactor the REST actions to clarify what endpoints are deprecated. (elastic#36869)
  Add JDK 12 to CI rotation (elastic#36915)
  Improve error message for 6.x style realm settings (elastic#36876)
  Send clear session as routable remote request (elastic#36805)
  [DOCS] Remove redundant ILM attributes (elastic#36808)
  SQL: Fix bug regarding histograms usage in scripting (elastic#36866)
  Update index mappings when ccr restore complete (elastic#36879)
  Docs: Bump version to alpha2 after release
  Enable IPv6 URIs in reindex from remote (elastic#36874)
  Watcher: Remove unused local variable in doExecute (elastic#36655)
  [DOCS] Synchs titles of X-Pack APIs
  ...
astefan added a commit that referenced this pull request Dec 21, 2018
@astefan
SQL: documentation improvements and updates (#36918)
36f03f3 
* Added Limitations page
* Made the aggregations page follow the common template for functions
* Modified all tables to have the first row's cells content centered
* Polishing in other various sections

(cherry picked from commit 09fa827)
astefan added a commit that referenced this pull request Dec 21, 2018
@astefan
SQL: documentation improvements and updates (#36918)
7ee75f9 
* Added Limitations page
* Made the aggregations page follow the common template for functions
* Modified all tables to have the first row's cells content centered
* Polishing in other various sections

(cherry picked from commit 09fa827)
jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request Dec 21, 2018
@jasontedor
Merge branch 'master' into package-ingest-geoip-as-a-module
30d92d1 
* master: (31 commits)
  Move ingest-geoip default databases out of config (elastic#36949)
  [ILM][DOCS] add extra scenario to policy update docs (elastic#36871)
  [Painless] Add String Casting Tests (elastic#36945)
  SQL: documentation improvements and updates (elastic#36918)
  [DOCS] Merges list of discovery and cluster formation settings (elastic#36909)
  Only compress responses if request was compressed (elastic#36867)
  Remove duplicate paragraph (elastic#36942)
  Fix URI to cluster stats endpoint on specific nodes (elastic#36784)
  Fix typo in unitTest task (elastic#36930)
  RecoveryMonitor#lastSeenAccessTime should be volatile (elastic#36781)
  [CCR] Add `ccr.auto_follow_coordinator.wait_for_timeout` setting (elastic#36714)
  Scripting: Remove deprecated params.ctx (elastic#36848)
  Refactor the REST actions to clarify what endpoints are deprecated. (elastic#36869)
  Add JDK 12 to CI rotation (elastic#36915)
  Improve error message for 6.x style realm settings (elastic#36876)
  Send clear session as routable remote request (elastic#36805)
  [DOCS] Remove redundant ILM attributes (elastic#36808)
  SQL: Fix bug regarding histograms usage in scripting (elastic#36866)
  Update index mappings when ccr restore complete (elastic#36879)
  Docs: Bump version to alpha2 after release
  ...
@astefan astefan mentioned this pull request Dec 22, 2018
Closed
@matriv matriv mentioned this pull request Dec 22, 2018
Closed
@jimczi jimczi added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@costin costin costin approved these changes

@matriv matriv matriv approved these changes

Assignees
No one assigned
Labels
:Analytics/SQL SQL querying >docs General docs changes v6.6.0 v6.7.0 v7.0.0-beta1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@astefan @elasticmachine @costin @matriv @jimczi