Amazon QLDB PartiQL reference conventions - Amazon Quantum Ledger Database (Amazon QLDB)

Amazon QLDB PartiQL reference conventions

Important

End of support notice: Existing customers will be able to use Amazon QLDB until end of support on 07/31/2025. For more details, see Migrate an Amazon QLDB Ledger to Amazon Aurora PostgreSQL.

This section explains the conventions that are used to write the syntax for the PartiQL commands, functions, and expressions described in the Amazon QLDB PartiQL reference. These conventions are not to be confused with the syntax and semantics of the PartiQL query language itself.

Character Description
CAPS Words in capital letters are keywords.
[ ] Brackets denote optional arguments or clauses. Multiple arguments in brackets indicate that you can choose any number of the arguments. In addition, arguments in brackets on separate lines indicate that the QLDB parser expects the arguments to be in the order that they're listed in the syntax.
| Pipes indicate that you can choose between the arguments.
red italics Words in red italics indicate placeholders. Insert the appropriate value in place of the word in red italics.
. . . An ellipsis indicates that you can repeat the preceding element.
' Values in single quotation marks indicate that you must enter the single quotes. In PartiQL, single quotes denote string values, or field names in Amazon Ion structures.
" Values in double quotation marks indicate that you must enter the double quotes. In PartiQL, double quotes denote quoted identifiers.
` Values in backticks indicate that you must enter the backticks. In PartiQL, backticks denote Ion literal values.