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  /  Collection CRUD Functions

11.3 Collection CRUD Functions

CollectionFindFunction

The syntax for this function in EBNF is:

Press CTRL+C to copy
CollectionFindFunction ::= '.find(' SearchConditionStr? ')' ( '.fields(' ProjectedDocumentExprStr ')' )? ( '.groupBy(' SearchExprStrList ')' )? ( '.having(' SearchConditionStr ')' )? ( '.sort(' SortExprStrList ')' )? ( '.limit(' NumberOfRows ')' ( '.offset(' NumberOfRows ')' )? )? ( '.lockExclusive(' LockContention ')' | '.lockShared(' LockContention ')' )? ( '.bind(' PlaceholderValues ')' )* ( '.execute()' )?

Figure 11.9 CollectionFindFunction

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

CollectionModifyFunction

The syntax for this function shown in EBNF is:

Press CTRL+C to copy
CollectionModifyFunction ::= '.modify(' SearchConditionStr ')' ( '.set(' DocPath ',' ExprOrLiteral ')' | '.unset(' DocPath ( ',' DocPath )* ')' | '.arrayInsert(' DocPath ',' ExprOrLiteral ')' | '.arrayAppend(' DocPath ',' ExprOrLiteral ')' | '.patch(' DocumentOrJSON ')' )+ ( '.sort(' SortExprStrList ')' )? ( '.limit(' NumberOfRows ')' )? ( '.bind(' PlaceholderValues ')' )* ( '.execute()' )?

Figure 11.10 CollectionModifyFunction

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

CollectionAddFunction

The syntax for this function shown in EBNF is:

Press CTRL+C to copy
CollectionAddFunction ::= ( '.add(' ( DocumentOrJSON | '[' DocumentOrJSON ( ',' DocumentOrJSON )* ']' )? ')' )+ ( '.execute()' )?

Figure 11.11 CollectionAddFunction

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

CollectionRemoveFunction

The syntax for this function shown in EBNF is:

Press CTRL+C to copy
CollectionRemoveFunction ::= '.remove(' SearchConditionStr ')' ( '.sort(' SortExprStrList ')' )? ( '.limit(' NumberOfRows ')' )? ( '.bind(' PlaceholderValues ')' )* ( '.execute()' )?

Figure 11.12 CollectionRemoveFunction

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