Global

Members

(readonly) DataModel :number

Enum to identify data-model types and parser modes.
Type:
  • number
Source:
Example
DataModel.TABLE
DataModel.DOCUMENT

(readonly) LockContention :number

Enum to identify row locking modes.
Type:
  • number
Source:
Example
LockContention.NOWAIT
LockContention.SKIP_LOCKED

Type Definitions

DocumentOrJSON

Literal object or JSON counterpart.
Type:
  • Object | string
Source:
Example
// literal object
{ foo: 'bar' }
// JSON string
'{ "foo": "bar" }'

SearchConditionStr

Expression that establishes the filtering criteria.
Type:
  • string
Source:
See:

URI

URI object configuration.
Type:
  • Object
Properties:
Name Type Attributes Description
host string <optional>
MySQL server hostname or IP address
port number <optional>
X Protocol port number
user string <optional>
Username
password string <optional>
Password
auth string <optional>
Client authentication method (default: PLAIN)
socketFactory SocketFactory <optional>
Socket factory (not needed except for tests)
ssl boolean <optional>
Enable SSL/TLS (default: true)
sslOptions Object <optional>
tls.TLSSocket options (see https://nodejs.org/api/tls.html#tls_new_tls_tlssocket_socket_options)
Source: