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

DOC-9552: Add N1QL hint section #2477

Merged
merged 25 commits into from Feb 24, 2022
Merged

Conversation

simon-dew
Copy link
Collaborator

@simon-dew simon-dew commented Feb 21, 2022

The following draft documentation is ready for review:

Docs issue: DOC-9552

@simon-dew simon-dew marked this pull request as ready for review February 21, 2022 20:54
@simon-dew
Copy link
Collaborator Author

simon-dew commented Feb 21, 2022

  • Remove EXPLAIN from example 8

@dhaggart
Copy link

dhaggart commented Feb 21, 2022

  • If it were me, I wouldn't separate '/*' and '+' (and '--' and '+') in the syntax diagrams - '/*+' and '--+' being clearer and less likely for someone to inadvertently insert whitespace before the plus.
  • (Also the break-out for individual literal characters in the JSON syntax (text) for individual directives is confusing, e.g. '"' 'ordered' '"' ':' 'true', since JSON syntax would actually just be: "ordered":true.)

@miaobingjie
Copy link

miaobingjie commented Feb 22, 2022

Under "Optimizer Hints":

  • I would agree with Donald here, having '/*' (or '--') and '+' separate implies there could be potential white space in between which is not true.
  • Example 4: There is no comma after the keyspace name in INDEX hint, just a space

Under "Keyspace Hints":

  • USE_NL - Simple Syntax: remove this sentence : "You may only use this hint once within the hint comment." you can have multiple USE_NL hints so you can either do USE_NL (a b c) or USE_NL(a) USE_NL(b) USE_NL(c)
  • Example 3: the hint specified as USE_NL airline, should be USE_NL(airline)
  • USE_HASH - Simple Syntax: remote this sentence: "You may only use this hint once within the hint comment."
  • Example 4: this hint specified as USE_HASH ailine/PROBE, should be USE_HASH(airline/PROBE)

@simon-dew simon-dew merged commit 69a664e into couchbase:release/7.1 Feb 24, 2022
@simon-dew simon-dew deleted the DOC-9552 branch February 24, 2022 11:51
simon-dew added a commit to simon-dew/docs-server that referenced this pull request Feb 28, 2022
* Remove unneeded images: application continuity images, CURL buttons

* Move screenshots, diagrams, icons to images folder

* Move image sources to source folder

* Update image references

* Driveby fixes for CURL() function

* Replace equations with STEM markup

* Use query diagrams from Learn section

* Add hints EBNF

* Add refs to hint comments in legacy syntax

* Add hint comments to SELECT syntax

* Update query syntax diagrams

* Update hint syntax diagrams

* Add optimizer hints overview

* Add query hints

* Add keyspace hints

* Update nav

* DOC-9057: Document Join enumeration support in CBO

* Update syntax diagrams after review

* Update examples after review
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants