Module sql
ballerina/sql Ballerina library
Functions
generateApplicationErrorStream
Parameters
- message string -
getGlobalConnectionPool
function getGlobalConnectionPool() returns ConnectionPoolClasses
sql: ArrayOutParameter
Represents Array Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: ArrayValue
Represents ArrayValue SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
sql: BigIntOutParameter
Represents BigInt Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: BigIntValue
Represents BigInt SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value int? - Value of parameter passed into the SQL statement
sql: BinaryOutParameter
Represents Binary Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: BinaryValue
Represents Binary SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value byte[]|ReadableByteChannel? - Value of parameter passed into the SQL statement
sql: BitOutParameter
Represents Bit Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: BitValue
Represents Bit SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
sql: BlobOutParameter
Represents Blob Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: BlobValue
Represents Blob SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value byte[]|ReadableByteChannel? - Value of parameter passed into the SQL statement
sql: BooleanOutParameter
Represents Boolean Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: BooleanValue
Represents Boolean SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value boolean? - Value of parameter passed into the SQL statement
sql: CharOutParameter
Represents Char Out Parameter used in procedure calls
get
Parses returned Char SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: CharValue
Represents Char SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value string? - Value of parameter passed into the SQL statement
sql: ClobOutParameter
Represents Clob Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: ClobValue
Represents Clob SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value ReadableCharacterChannel|string? - Value of parameter passed into the SQL statement
sql: DateOutParameter
Represents Date Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: DateTimeOutParameter
Represents DateTime Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: DateTimeValue
Represents DateTime SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
sql: DateValue
Represents Date SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
sql: DecimalOutParameter
Represents Decimal Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: DecimalValue
Represents Decimal SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
sql: DoubleOutParameter
Represents Double Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: DoubleValue
Represents Double SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
sql: FloatOutParameter
Represents Float Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: FloatValue
Represents Float SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
sql: InOutParameter
Represents SQL InOutParameter used in procedure calls.
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: IntegerOutParameter
Represents Integer Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: IntegerValue
Represents Integer SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value int? - Value of parameter passed into the SQL statement
sql: NCharOutParameter
Represents NChar Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: NCharValue
Represents NChar SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value string? - Value of parameter passed into the SQL statement
sql: NClobOutParameter
Represents NClob Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: NClobValue
Represents NClob SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value ReadableCharacterChannel|string? - Value of parameter passed into the SQL statement
sql: NumericOutParameter
Represents Numeric Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: NumericValue
Represents Numeric SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
sql: NVarcharOutParameter
Represents NVarchar Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: NVarcharValue
Represents NVarchar SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value string? - Value of parameter passed into the SQL statement
sql: ProcedureCallResult
Object that is used to return stored procedure call results.
getNextQueryResult
Updates executionResult or queryResult with the next result in the result. This will also close the current
results by default.
close
function close() returns Error?Closes the ProcedureCallResult object and releases resources.
Return Type
- Error? -
Errorif any error occurred while closing.
Fields
- executionResult ExecutionResult?(default ()) - Summary of the execution of DML/DLL query
- customResultIterator CustomResultIterator? - The instance of the custom ballerina class that is structurally equivalent to CustomResultIterator object type. This instance includes a custom implementation of the getNextQueryResult method.
sql: RealOutParameter
Represents Real Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: RealValue
Represents Real SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
sql: RefOutParameter
Represents Ref Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: RefValue
Represents Ref SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value record {}? - Value of parameter passed into the SQL statement
sql: ResultIterator
The result iterator object that is used to iterate through the results in the event stream.
next
function next() returns record {|record {} value;|}|Error?close
function close() returns Error?Fields
- customResultIterator CustomResultIterator? - The instance of the custom ballerina class that is structurally equivalent to CustomResultIterator object type. This instance includes a custom implementation of the nextResult method.
sql: RowOutParameter
Represents Row Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: RowValue
Represents Row SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value byte[]? - Value of parameter passed into the SQL statement
sql: SmallIntOutParameter
Represents SmallInt Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: SmallIntValue
Represents SmallInt SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value int? - Value of parameter passed into the SQL statement
sql: StructOutParameter
Represents Struct Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: StructValue
Represents Struct SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value record {}? - Value of parameter passed into the SQL statement
sql: TextOutParameter
Represents Text Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: TextValue
Represents Text SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value ReadableCharacterChannel|string? - Value of parameter passed into the SQL statement
sql: TimeOutParameter
Represents Time Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: TimestampOutParameter
Represents Timestamp Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: TimestampValue
Represents Timestamp SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
sql: TimeValue
Represents Time SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
sql: VarBinaryOutParameter
Represents VarBinary Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: VarBinaryValue
Represents VarBinary SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value byte[]|ReadableByteChannel? - Value of parameter passed into the SQL statement
sql: VarcharOutParameter
Represents Varchar Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: VarcharValue
Represents Varchar SQL field.
Fields
- Fields Included from *TypedValue
- value anydata|object {}?
- value string? - Value of parameter passed into the SQL statement
sql: XMLOutParameter
Represents XML Out Parameter used in procedure calls
get
Parses returned SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
Constants
sql: EXECUTION_FAILED
Constant indicating that the specific batch statement failed.
sql: SUCCESS_NO_INFO
Constant indicating that the specific batch statement executed successfully but that no count of the number of rows it affected is available.
Records
sql: BatchExecuteErrorDetail
Represents the properties belonging to a BatchExecuteError.
Fields
- errorCode int - SQL error code
- sqlState string - SQL state
- executionResults ExecutionResult[] - Result of execution of commands
sql: ConnectionPool
Represents the properties which are used to configure DB connection pool. Default values of the fields can be set through the configuration API.
Fields
- maxOpenConnections int(default maxOpenConnections) - The maximum number of open connections that the pool is allowed to have, including
both idle and in-use connections. Default value is 15 and it can be changed through the
configuration API with the key
b7a.sql.pool.maxOpenConnections.
- maxConnectionLifeTime decimal(default maxConnectionLifeTime) - The maximum lifetime (in seconds) of a connection in the pool. Default value is 1800
seconds (30 minutes) and it can be changed through the configuration API with the
key
b7a.sql.pool.maxConnectionLifeTime. A value of 0 indicates unlimited maximum lifetime (infinite lifetime).
- minIdleConnections int(default minIdleConnections) - The minimum number of idle connections that pool tries to maintain in the pool. Default
is the same as maxOpenConnections and it can be changed through the configuration
API with the key
b7a.sql.pool.minIdleConnections.
sql: DatabaseErrorDetail
Represents the properties belonging to a DatabaseError.
Fields
- errorCode int - SQL error code
- sqlState string - SQL state
sql: ExecutionResult
The result of the query without returning the rows.
Fields
- affectedRowCount int - Number of rows affected by the execution of the query. It may be one of the following,
(1) A number greater than or equal to zero -- indicates that the command was processed
successfully and is the affected row count in the database that were affected by
the command's execution
(2) A value of
SUCCESS_NO_INFOindicates that the command was processed successfully but that the number of rows affected is unknown (3) A value ofEXECUTION_FAILEDindicated the specific command failed. This can be returned inBatchExecuteErrorand only if the driver continues to process the statements after the error occurred.
Errors
sql: ApplicationError
Represents an error originating from application-level causes.
sql: Error
Defines the common error type for the module
Object types
sql: Client
Represents a SQL client.
query
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
execute
function execute(string|ParameterizedQuery sqlQuery) returns ExecutionResult|ErrorExecutes the DDL or DML sql query 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 anErrorif any error occurred when executing the query
batchExecute
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 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
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
function close() returns Error?Close the SQL client.
Return Type
- Error? - Possible error during closing the client
sql: CustomResultIterator
The object type that is used as a structure to define a custom class with custom implementations for nextResult and getNextQueryResult in the connector modules.
nextResult
function nextResult(ResultIterator iterator) returns record {}|Error?Parameters
- iterator ResultIterator -
getNextQueryResult
function getNextQueryResult(ProcedureCallResult callResult) returns boolean|ErrorParameters
- callResult ProcedureCallResult -
sql: OutParameter
Represents all OUT parameters used in SQL stored procedure call.
get
Parses returned Char SQL value to ballerina value.
Parameters
- typeDesc typedesc<anydata> - Type description of the data that need to be converted
sql: ParameterizedCallQuery
Represents Parameterized Call SQL Statement.
Fields
- Fields Included from *RawTemplate
- strings string[] & readonly
- insertions (any|error)[]
- strings (string[] & readonly) - The separated parts of the sql call query
- insertions Parameter[] - The values that should be filled in between the parts
sql: ParameterizedQuery
Represents Parameterized SQL query.
Fields
- Fields Included from *RawTemplate
- strings string[] & readonly
- insertions (any|error)[]
- strings (string[] & readonly) - The separated parts of the sql query
- insertions Value[] - The values that should be filled in between the parts
sql: TypedValue
Represents a parameter for the SQL Client remote functions when a variable needs to be passed to the remote function.
Fields
- value anydata|object {}? - Value of parameter passed into the SQL statement
Union types
sql: Parameter
Parameter
Represents all parameters used in SQL stored procedure call.
sql: Value
Value
Possible type of parameters that can be passed into the SQL query.
Intersection types
sql: BatchExecuteError
BatchExecuteError
Represents an error occurred when a batch execution is running.
sql: DatabaseError
DatabaseError
Represents an error caused by an issue related to database accessibility, erroneous queries, constraint violations, database resource clean-up, and other similar scenarios.