Encloses the functions and classes available to interact with a MySQL Server using the traditional MySQL Protocol.
More...
Encloses the functions and classes available to interact with a MySQL Server using the traditional MySQL Protocol.
Use this module to create a session using the traditional MySQL Protocol, for example for MySQL Servers where the X Protocol is not available.
Note that the API interface on this module is very limited, even you can load schemas, tables and views as objects there are no operations available on them.
The purpose of this module is to allow SQL Execution on MySQL Servers where the X Protocol is not enabled.
To use the properties and functions available on this module you first need to import it.
mysql-js> var mysql =
require(
'mysql');
mysql-js> var mySession = mysql.getClassicSession('admin@localhost');
Any require(String module_name_or_path)
Loads the specified JavaScript module.
Definition: mod_shell.cc:70
When running the shell in interactive mode, this module is automatically imported.
◆ getClassicSession()
| ClassicSession getClassicSession |
( |
ConnectionData |
connectionData, |
|
|
String |
password |
|
) |
| |
Opens a classic MySQL protocol session to a MySQL server.
- Parameters
-
| connectionData | The connection data for the session |
| password | Optional password for the session |
- Returns
- A ClassicSession
A ClassicSession object uses the traditional MySQL Protocol to allow executing operations on the connected MySQL Server.
The connection data may be specified in the following formats:
- A URI string
- A dictionary with the connection options
A basic URI string has the following format:
[scheme://][user[:password]@]<host[:port]|socket>[/schema][?option=value&option=value...]
Connection Options
The following options are valid for use either in a URI or in a dictionary:
- ssl-mode: The SSL mode to be used in the connection.
- ssl-ca: The path to the X509 certificate authority file in PEM format.
- ssl-capath: The path to the directory that contains the X509 certificate authority files in PEM format.
- ssl-cert: The path to the SSL public key certificate file in PEM format.
- ssl-key: The path to the SSL private key file in PEM format.
- ssl-crl: The path to file that contains certificate revocation lists.
- ssl-crlpath: The path of directory that contains certificate revocation list files.
- ssl-cipher: The list of permissible encryption ciphers for connections that use TLS protocols up through TLSv1.2.
- tls-version: List of protocols permitted for secure connections.
- tls-ciphers: List of TLS v1.3 ciphers to use.
- auth-method: Authentication method.
- get-server-public-key: Request public key from the server required for RSA key pair-based password exchange. Use when connecting to MySQL 8.0 servers with classic MySQL sessions with SSL mode DISABLED.
- server-public-key-path: The path name to a file containing a client-side copy of the public key required by the server for RSA key pair-based password exchange. Use when connecting to MySQL 8.0 servers with classic MySQL sessions with SSL mode DISABLED.
- connect-timeout: The connection timeout in milliseconds. If not provided a default timeout of 10 seconds will be used. Specifying a value of 0 disables the connection timeout.
- compression: Enable compression in client/server protocol.
- compression-algorithms: Use compression algorithm in server/client protocol.
- compression-level: Use this compression level in the client/server protocol.
- connection-attributes: List of connection attributes to be registered at the PERFORMANCE_SCHEMA connection attributes tables.
- local-infile: Enable/disable LOAD DATA LOCAL INFILE.
- net-buffer-length: The buffer size for TCP/IP and socket communication.
- plugin-authentication-kerberos-client-mode: (Windows) Allows defining the kerberos client mode (SSPI, GSSAPI) when using kerberos authentication.
- oci-config-file: Allows defining the OCI configuration file for OCI authentication.
- authentication-oci-client-config-profile: Allows defining the OCI profile used from the configuration for client side OCI authentication.
- authentication-openid-connect-client-id-token-file: Allows defining the file path to an OpenId Connect authorization token file when using OpenId Connect authentication.
When these options are defined in a URI, their values must be URL encoded.
The following options are also valid when a dictionary is used:
Base Connection Options
- uri: a URI string.
- scheme: the protocol to be used on the connection.
- user: the MySQL user name to be used on the connection.
- password: the password to be used on the connection.
- host: the hostname or IP address to be used on the connection.
- port: the port to be used in a TCP connection.
- socket: the socket file name to be used on a connection through unix sockets.
- schema: the schema to be selected once the connection is done.
SSH Tunnel Connection Options
- ssh: a SSHURI string used when SSH tunnel is required.
- ssh-password: the password the be used on the SSH connection.
- ssh-identity-file: the key file to be used on the SSH connection.
- ssh-identity-file-password: the SSH key file password.
- ssh-config-file: the SSH configuration file, default is the value of shell.options['ssh.configFile']
- Attention
- The connection options have precedence over options specified in the connection options uri
The connection options are case insensitive and can only be defined once.
If an option is defined more than once, an error will be generated.
Detailed description of the connection data format is available at Connection Data
◆ getSession()
| ClassicSession getSession |
( |
ConnectionData |
connectionData, |
|
|
String |
password |
|
) |
| |
Opens a classic MySQL protocol session to a MySQL server.
- Parameters
-
| connectionData | The connection data for the session |
| password | Optional password for the session |
- Returns
- A ClassicSession
A ClassicSession object uses the traditional MySQL Protocol to allow executing operations on the connected MySQL Server.
The connection data may be specified in the following formats:
- A URI string
- A dictionary with the connection options
A basic URI string has the following format:
[scheme://][user[:password]@]<host[:port]|socket>[/schema][?option=value&option=value...]
Connection Options
The following options are valid for use either in a URI or in a dictionary:
- ssl-mode: The SSL mode to be used in the connection.
- ssl-ca: The path to the X509 certificate authority file in PEM format.
- ssl-capath: The path to the directory that contains the X509 certificate authority files in PEM format.
- ssl-cert: The path to the SSL public key certificate file in PEM format.
- ssl-key: The path to the SSL private key file in PEM format.
- ssl-crl: The path to file that contains certificate revocation lists.
- ssl-crlpath: The path of directory that contains certificate revocation list files.
- ssl-cipher: The list of permissible encryption ciphers for connections that use TLS protocols up through TLSv1.2.
- tls-version: List of protocols permitted for secure connections.
- tls-ciphers: List of TLS v1.3 ciphers to use.
- auth-method: Authentication method.
- get-server-public-key: Request public key from the server required for RSA key pair-based password exchange. Use when connecting to MySQL 8.0 servers with classic MySQL sessions with SSL mode DISABLED.
- server-public-key-path: The path name to a file containing a client-side copy of the public key required by the server for RSA key pair-based password exchange. Use when connecting to MySQL 8.0 servers with classic MySQL sessions with SSL mode DISABLED.
- connect-timeout: The connection timeout in milliseconds. If not provided a default timeout of 10 seconds will be used. Specifying a value of 0 disables the connection timeout.
- compression: Enable compression in client/server protocol.
- compression-algorithms: Use compression algorithm in server/client protocol.
- compression-level: Use this compression level in the client/server protocol.
- connection-attributes: List of connection attributes to be registered at the PERFORMANCE_SCHEMA connection attributes tables.
- local-infile: Enable/disable LOAD DATA LOCAL INFILE.
- net-buffer-length: The buffer size for TCP/IP and socket communication.
- plugin-authentication-kerberos-client-mode: (Windows) Allows defining the kerberos client mode (SSPI, GSSAPI) when using kerberos authentication.
- oci-config-file: Allows defining the OCI configuration file for OCI authentication.
- authentication-oci-client-config-profile: Allows defining the OCI profile used from the configuration for client side OCI authentication.
- authentication-openid-connect-client-id-token-file: Allows defining the file path to an OpenId Connect authorization token file when using OpenId Connect authentication.
When these options are defined in a URI, their values must be URL encoded.
The following options are also valid when a dictionary is used:
Base Connection Options
- uri: a URI string.
- scheme: the protocol to be used on the connection.
- user: the MySQL user name to be used on the connection.
- password: the password to be used on the connection.
- host: the hostname or IP address to be used on the connection.
- port: the port to be used in a TCP connection.
- socket: the socket file name to be used on a connection through unix sockets.
- schema: the schema to be selected once the connection is done.
SSH Tunnel Connection Options
- ssh: a SSHURI string used when SSH tunnel is required.
- ssh-password: the password the be used on the SSH connection.
- ssh-identity-file: the key file to be used on the SSH connection.
- ssh-identity-file-password: the SSH key file password.
- ssh-config-file: the SSH configuration file, default is the value of shell.options['ssh.configFile']
- Attention
- The connection options have precedence over options specified in the connection options uri
The connection options are case insensitive and can only be defined once.
If an option is defined more than once, an error will be generated.
Detailed description of the connection data format is available at Connection Data
◆ splitScript()
| Array mysqlsh::mysql::splitScript |
( |
String |
script | ) |
|
Split a SQL script into individual statements.
- Parameters
-
| script | A SQL script as a string containing multiple statements |
- Returns
- A list of statements
The default statement delimiter is `;` but it can be changed with the DELIMITER keyword, which must be followed by the delimiter character(s) and a newline.
◆ parseStatementAst()
| Dictionary mysqlsh::mysql::parseStatementAst |
( |
String |
statements | ) |
|
Parse MySQL statements and return its AST representation.
- Parameters
-
| statements | SQL statements to be parsed |
- Returns
- AST encoded as a JSON structure
◆ quoteIdentifier()
| String mysqlsh::mysql::quoteIdentifier |
( |
String |
s | ) |
|
Quote a string as a MySQL identifier, escaping characters when needed.
- Parameters
-
| s | the identifier name to be quoted |
- Returns
- Quoted identifier
◆ unquoteIdentifier()
| String mysqlsh::mysql::unquoteIdentifier |
( |
String |
s | ) |
|
Unquote a MySQL identifier.
- Parameters
-
- Returns
- Unquoted string.
An exception is thrown if the input string is not quoted with backticks.
