Module azure.mysql
ballerinax/azure.mysql Ballerina library
Deprecated0.1.0
This package does not have any public APIs.
Clients
azure.mysql: Client
Represents a MySQL database client.
Constructor
Initializes the 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 the 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 noconnectionPoolprovided, the global connection pool will be used and it will be shared by other clients, which have the same properties
query
Isolated FunctionRemote Function
function query(string|ParameterizedQuery sqlQuery, typedesc<record {}>? rowType) returns stream<record {}, Error>Queries the database with the provided query and returns the result as a stream.
Parameters
- sqlQuery string|ParameterizedQuery - The query, which needs to be executed as a
stringor ansql:ParameterizedQuerywhen 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 will be used for the record attributes
Return Type
execute
Isolated FunctionRemote Function
function execute(string|ParameterizedQuery sqlQuery) returns ExecutionResult|ErrorExecutes the provided DDL or DML SQL queries and returns a summary of the execution.
Parameters
- sqlQuery string|ParameterizedQuery - The DDL or DML queries such as
INSERT,DELETE,UPDATE, etc. as astringor ansql:ParameterizedQuerywhen the query has params to be passed in
Return Type
- ExecutionResult|Error - Summary of the SQL update query as an
sql:ExecutionResultorsql:Errorif 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 queries provided and returns the summary of the execution.
Parameters
- sqlQueries ParameterizedQuery[] - The DDL or DML queries such as
INSERT,DELETE,UPDATE, etc. as ansql:ParameterizedQuerywith an array of values passed in
Return Type
- ExecutionResult[]|Error - Summary of the executed SQL queries as an
sql:ExecutionResult[], which includes details such as theaffectedRowCountandlastInsertId. If one of the commands in the batch fails, this function will return ansql:BatchExecuteError. 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 an 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 a stream with an 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 will be used for the record attributes
Return Type
- ProcedureCallResult|Error - Summary of the execution is returned in an
sql:ProcedureCallResultorsql:Error
close
Isolated Function
function close() returns Error?Close the SQL client.
Return Type
- Error? - Possible error during the closure of the client