MySQL Shell API 26.7.0
Unified development interface for MySQL Products
Classes

Encloses the functions and classes available to interact with a MySQL Server using the traditional MySQL Protocol. More...

Classes

class  Type
 Constants to represent data types on Column objects. More...
 

Detailed Description

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');
// Then you can use the module functions and properties
// for example to create a session
mysql-js> var mySession = mysql.getClassicSession('admin@localhost');
Any require(String module_name_or_path)
Loads the specified JavaScript module.
Definition: mod_shell.cc:72

When running the shell in interactive mode, this module is automatically imported.