Module mysql
ballerinax/mysql Ballerina library
0.7.0-alpha9.2
Clients
mysql: Client
Represents a MySQL database client.
Constructor
Initialize MySQL Client.
init (string host, string? user, string? password, string? database, int port, Options? options, ConnectionPool? connectionPool)- host string "localhost" - Hostname of the mysql server to be connected
- user string? () - If the mysql server is secured, the username to be used to connect to the mysql server
- password string? () - The password of provided username of the database
- database string? () - The name fo the database to be connected
- port int 3306 - Port number of the mysql server to be connected
- options Options? () - The Database specific JDBC client properties
- connectionPool ConnectionPool? () - The
sql:ConnectionPoolobject to be used within the jdbc client. If there is no connectionPool is provided, the global connection pool will be used and it will be shared by other clients which has same properties.
query
Isolated FunctionRemote Function
function query(string|ParameterizedQuery sqlQuery, typedesc<record {}>? rowType) returns stream<record {}, Error>Queries the database with the query provided by the user, and returns the result as stream.
Parameters
- sqlQuery string|ParameterizedQuery - The query which needs to be executed as
stringorParameterizedQuerywhen the SQL query has params to be passed in
- rowType typedesc<record {}>? (default ()) - The
typedescof the record that should be returned as a result. If this is not provided the default column names of the query result set be used for the record attributes.
Return Type
execute
Isolated FunctionRemote Function
function execute(string|ParameterizedQuery sqlQuery) returns ExecutionResult|ErrorExecutes the DDL or DML sql queries provided by the user, and returns summary of the execution.
Parameters
- sqlQuery string|ParameterizedQuery - The DDL or DML query such as INSERT, DELETE, UPDATE, etc as
stringorParameterizedQuerywhen the query has params to be passed in
Return Type
- ExecutionResult|Error - Summary of the sql update query as
ExecutionResultor returnsErrorif any error occurred when executing the query
batchExecute
Isolated FunctionRemote Function
function batchExecute(ParameterizedQuery[] sqlQueries) returns ExecutionResult[]|ErrorExecutes a batch of parameterized DDL or DML sql query provided by the user, and returns the summary of the execution.
Parameters
- sqlQueries ParameterizedQuery[] - The DDL or DML query such as INSERT, DELETE, UPDATE, etc as
ParameterizedQuerywith an array of values passed in
Return Type
- ExecutionResult[]|Error - Summary of the executed SQL queries as
ExecutionResult[]which includes details such asaffectedRowCountandlastInsertId. If one of the commands in the batch fails, this function will returnBatchExecuteError, however the JDBC driver may or may not continue to process the remaining commands in the batch after a failure. The summary of the executed queries in case of error can be accessed as(<sql:BatchExecuteError> result).detail()?.executionResults.
call
Isolated FunctionRemote Function
function call(string|ParameterizedCallQuery sqlQuery, typedesc<record {}>[] rowTypes) returns ProcedureCallResult|ErrorExecutes a SQL stored procedure and returns the result as stream and execution summary.
Parameters
- sqlQuery string|ParameterizedCallQuery - The query to execute the SQL stored procedure
- rowTypes typedesc<record {}>[] (default []) - The array of
typedescof the records that should be returned as a result. If this is not provided the default column names of the query result set be used for the record attributes.
Return Type
- ProcedureCallResult|Error - Summary of the execution is returned in
ProcedureCallResultorsql:Error
close
Isolated Function
function close() returns Error?Close the SQL client.
Return Type
- Error? - Possible error during closing the client
Constants
Records
mysql: Options
Closed record
MySQL database options.
Fields
- ssl SecureSocket? - SSL Configuration to be used
- useXADatasource boolean(default false) - Boolean value to enable XADatasource
- connectTimeout decimal(default 30) - Timeout (in seconds) to be used when connecting to the mysql server
- socketTimeout decimal(default 0) - Socket timeout (in seconds) during the read/write operations with the MySQL server (0 means no socket timeout)
- serverTimezone string? - Configures the connection time zone, which is used by the
Connector/Jif the conversion between a Ballerina application and a target time zone is needed when preserving instant temporal values
mysql: SecureSocket
Closed record
SSL Configuration to be used when connecting to mysql server.
Fields
- mode SSLMode(default SSL_PREFERRED) -
SSLModeto be used during the connection
- key KeyStore? - Keystore configuration of the client certificates
- cert TrustStore? - Keystore configuration of the trust certificates
- allowPublicKeyRetrieval boolean(default false) - Boolean value to allow special handshake round-trip to get an RSA public key directly from server
Union types
mysql: SSLMode
SSLMode
SSLMode as a union of available ssl modes.