MySQL Connector/Node.js X DevAPI Reference

Tutorials

Mixins

Binding
CollectionOrdering
DatabaseObject
Grouping
Limiting
Locking
Skipping
TableFiltering
TableOrdering

Type Definitions

DocPath

A document field name definition as represented by a string or an X DevAPI expression instance.
Type:
Example
// string
'foo.bar.baz'
'$.foo.bar'
'foo[0].bar'
// X DevAPI expression
mysqlx.expr('foo.bar.baz')
mysqlx.expr('$.foo.bar')
mysqlx.expr('foo[0].baz')

DocPaths

One or more field document path.
Type:

DocumentOrJSON

A document definition as represented by a plain JavaScript object, a JSON string or an X DevAPI expression instance.
Type:
Example
// literal object
{ foo: 'bar' }
// JSON string
'{ "foo": "bar" }'
// X DevAPI expression
mysqlx.expr('{"foo":"bar"}')

DocumentsOrJSON

One or more document definitions.
Type:

ExprOrLiteral

A document definition as represented by a plain JavaScript object, a JSON string or an X DevAPI expression instance.
Type:
Example
// primitive JavaScript values
'foo'
true
false
3
1.234
// X DevAPI expression literal
mysqlx.expr('{"foo":"bar"}')

ProjectedDocumentExprStr

A document field name and optional alias to include as part of a result set.
Type:
Example
// string
foo.bar.baz as path
foo[2].bar as path
foo.*.bar as path
// X DevAPI expression
mysqlx.expr('foo.bar.baz as path')
mysqlx.expr('foo[2].bar as path')
mysqlx.expr('foo.*.bar as path')
mysqlx.expr('{ "foobar": concat(foo, bar) }')

ProjectedDocumentsExprStr

One or more document field names and corresponding optional aliases.
Type:

ProjectedSearchExprStr

A column name and optional alias to include as part of a result set.
Type:
Example
// string
foo as baz
bar as qux
// X DevAPI expression
mysqlx.expr('foo as bar', { mode: mysqlx.Mode.TABLE })
mysqlx.expr('bar as qux', { mode: mysqlx.Mode.TABLE })
mysqlx.expr('{ "foobar": concat(foo, bar) }', { mode: mysqlx.Mode.TABLE })

ProjectedSearchExprStrList

One or more column names and corresponding optional aliases.
Type:

SearchConditionStr

Expression that establishes the filtering criteria.
Type:
See:

SearchExprStr

Expression that establishes the elements to include in an aggregation.
Type:

SearchExprStrList

One or more expressions that establishes an aggregation.
Type:
See:

SortExprStr

A column name and optional alias to include as part of a result set.
Type:

SortExprStrList

One or more column names and corresponding optional aliases.
Type:
See:

TableField

A column name definition as represented by a string or an X DevAPI expression instance.
Type:
  • string
Example
'foo.bar.baz->>"$qux.quux"'

TableFields

One or more document definitions.
Type:

int64

An integer value that can loose precision, in which case it can potentially be represented by a BigInt or a string.
Type:
  • bigint | number | string