new IRelationalDatabase(connectionInfo)
Creates a new relational database connection.
Parameters:
Name | Type | Description |
---|---|---|
connectionInfo |
The connection info to utilize for the connection. |
Extends
- IDatabase
Methods
-
close()
-
Closes an open relational database and returns a Promise.
Returns:
- Type
- Promise
-
close(callback)
-
Closes an open relational database and utilizes the supplied callback when complete.
Parameters:
Name Type Description callback
IRelationalDatabase~closeCallback The node.js style callback to use in conjunction with the command.
-
connect()
-
Connects to a relational database and returns a Promise.
Returns:
- Type
- Promise
-
connect(connectionInfo)
-
Connects to a relational database with the supplied connection info and returns a Promise.
Parameters:
Name Type Description connectionInfo
The connection info to utilize for the connection.
Returns:
- Type
- Promise
-
connect(callback)
-
Connects to a relational database and utilizes the supplied callback when complete.
Parameters:
Name Type Description callback
IRelationalDatabase~connectCallback The node.js style callback to use in conjunction with the connection.
-
connect(connectionInfo, callback)
-
Connects to a relational database with the supplied connection info and utilizes the supplied callback when complete.
Parameters:
Name Type Description connectionInfo
The connection info to utilize for the connection.
callback
IRelationalDatabase~connectCallback The node.js style callback to use in conjunction with the connection.
Type Definitions
-
closeCallback(error)
-
node.js style database close callback
Parameters:
Name Type Description error
string Contains the error message if one exists.
-
connectCallback(error)
-
node.js style database connection callback
Parameters:
Name Type Description error
string Contains the error message if one exists.