Chapter 11 CRUD EBNF Definitions
Previous		Next

Chapter 11 CRUD EBNF Definitions

Table of Contents

11.1 Session Objects and Functions
11.2 Schema Objects and Functions
11.3 Collection CRUD Functions
11.4 Collection Index Management Functions
11.5 Table CRUD Functions
11.6 Result Functions
11.7 Other EBNF Definitions

This chapter provides a visual reference guide to the objects and functions available in the X DevAPI. For more information on the specific objects and functions available in the language you are using which implements the X DevAPI, see the Additional Documentation.

11.1 Session Objects and Functions

XSession

Figure 11.1 XSession

NodeSession

Figure 11.2 NodeSession

SqlExecute

Figure 11.3 SqlExecute

SQLPlaceholderValues

Figure 11.4 SQLPlaceholderValues

SQLPlaceholderName

Figure 11.5 SQLPlaceholderName

SQLLiteral

Figure 11.6 SQLLiteral

11.2 Schema Objects and Functions

Schema

Figure 11.7 Schema

Collection

Figure 11.8 Collection

Table

Figure 11.9 Table

11.3 Collection CRUD Functions

CollectionFindFunction

Figure 11.10 CollectionFindFunction

CollectionModifyFunction

Figure 11.11 CollectionModifyFunction

CollectionAddFunction

Figure 11.12 CollectionAddFunction

CollectionRemoveFunction

Figure 11.13 CollectionRemoveFunction

11.4 Collection Index Management Functions

CollectionCreateIndex

Figure 11.14 CollectionCreateIndex

CollectionDropIndex

Figure 11.15 CollectionDropIndex

11.5 Table CRUD Functions

TableSelectFunction

Table.select() and collection.find() use different methods for sorting results. Table.select() follows the SQL language naming and calls the sort method orderBy(). Collection.find() does not. Use the method sort() to sort the results returned by Collection.find(). Proximity with the SQL standard is considered more important than API uniformity here.

Figure 11.16 TableSelectFunction

TableInsertFunction

Figure 11.17 TableInsertFunction

TableUpdateFunction

Figure 11.18 TableUpdateFunction

TableDeleteFunction

Figure 11.19 TableDeleteFunction

11.6 Result Functions

Result

Figure 11.20 Result

DocResult

Figure 11.21 DocResult

RowResult

Figure 11.22 RowResult

Column

Figure 11.23 Column

SqlResult

Figure 11.24 SqlResult

11.7 Other EBNF Definitions

SearchConditionStr

Figure 11.25 SearchConditionStr

SearchExprStrList

Figure 11.26 SearchExprStrList

ProjectedSearchExprStrList

Figure 11.27 ProjectedSearchExprStrList

SortExprStrList

Figure 11.28 SortExprStrList

ExprOrLiteral

Figure 11.29 ExprOrLiteral

ExprOrLiterals

Figure 11.30 ExprOrLiterals

ExprOrLiteralOrOperand

Figure 11.31 ExprOrLiteralOrOperand

PlaceholderValues

Figure 11.32 PlaceholderValues

PlaceholderName

Figure 11.33 PlaceholderName

CollectionFields

Figure 11.34 CollectionFields

CollectionField

Figure 11.35 CollectionField

DocPath

Figure 11.36 DocPath

Literal

Figure 11.37 Literal

Expression

Figure 11.38 Expression

Document

An API call expecting a JSON document allows the use of many data types to describe the document. Depending on the X DevAPI implementation and language any of the following data types can be used:

String
Native JSON
JSON equivalent syntax
DbDoc
Generated Doc Classes

All implementations allow expressing an document by the special DbDoc type and as a string. Consult your language's Connector reference for more details, see Additional Documentation.

Figure 11.39 Document