Documentation Home
X DevAPI User Guide
Download this Manual
PDF (US Ltr) - 1.4Mb
PDF (A4) - 1.4Mb


X DevAPI User Guide  /  CRUD EBNF Definitions  /  Schema Objects and Functions

11.2 Schema Objects and Functions

Schema

The syntax for this function shown in EBNF is:

Press CTRL+C to copy
Schema ::= '.getName()' | '.existsInDatabase()' | '.getSession()' | '.getCollection(' StringLiteral ')' | '.getCollections()' | '.getCollectionAsTable(' StringLiteral ')' | '.dropCollection(' StringLiteral ')' | '.getTable(' StringLiteral ')' | '.getTables()' | '.createCollection(' StringLiteral ')'

Figure 11.6 Schema

Image shows the syntax in EBNF form as described in the preceding text.

Collection

The syntax for this function shown in EBNF is:

Press CTRL+C to copy
Collection ::= '.getSchema()' | '.getName()' | '.getSession()' | '.existsInDatabase()' | '.replaceOne(' DocumentId ',' DocumentOrJSON ')' | '.addOrReplaceOne(' DocumentId ',' DocumentOrJSON ')' | '.getOne(' DocumentId ')' | '.removeOne(' DocumentId ')' | CollectionFindFunction | CollectionModifyFunction | CollectionAddFunction | CollectionRemoveFunction | CollectionCreateIndex | CollectionDropIndex

Figure 11.7 Collection

Image shows the syntax in EBNF form as described in the preceding text.

Table

The syntax for this function shown in EBNF is:

Press CTRL+C to copy
Table ::= '.getSchema()' | '.getName()' | '.getSession()' | '.existsInDatabase()' | '.isView()' | TableSelectFunction | TableUpdateFunction | TableInsertFunction | TableDeleteFunction

Figure 11.8 Table

Image shows the syntax in EBNF form as described in the preceding text.