A newer version of this documentation is available.

View Latest

Conventions

  • reference
    +
    The N1QL syntax descriptions in the documentation use some notational conventions that you need to be familiar with.
    Table 1. Notational conventions for N1QL syntax
    Convention Notation Example Description

    Upper case

    SELECT

    Indicates keywords, which are required in the syntax.

    Single or double quotes

    ' or "

    '(', ')', ','

    Indicate that the punctuation mark(s) between the quotes are required in the syntax.

    Square brackets

    [ ]

    [ NOT ] BETWEEN

    Indicate that the elements between the square brackets are optional.

    Pipe

    |

    AND | OR

    Separates alternatives.

    Parentheses

    ( )

    USING ( GSI | FTS )

    Delimit alternatives where necessary.

    Square brackets and asterisk

    [ ]*

    [ element ]*

    Indicate that the elements between the square brackets may be repeated zero, one, or many times.