Object Type: Client

Represents a SQL client.

Methods

query

Queries the database with the query provided by the user, and returns the result as stream.

execute

Executes the DDL or DML sql query provided by the user, and returns summary of the execution.

batchExecute

Executes a batch of parameterized DDL or DML sql query provided by the user, and returns the summary of the execution.

call

Executes a SQL stored procedure and returns the result as stream and execution summary.

close

Close the SQL client.

query

function query(string | ParameterizedQuery sqlQuery, typedesc<record {}>? rowType) returns stream<record {}, Error>
Isolated Function
Remote Function

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 string or ParameterizedQuery when the SQL query has params to be passed in

  • rowType typedesc<record {}>? (default ())
  • The typedesc of 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

(stream<record {}, Error>)

Stream of records in the type of rowType

execute

function execute(string | ParameterizedQuery sqlQuery) returns ExecutionResult | Error
Isolated Function
Remote Function

Executes 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 string or ParameterizedQuery when the query has params to be passed in

Return Type

(ExecutionResult | Error)

Summary of the sql update query as ExecutionResult or an Error if any error occurred when executing the query

batchExecute

function batchExecute(ParameterizedQuery[ ] sqlQueries) returns ExecutionResult[ ] | Error
Isolated Function
Remote Function

Executes 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 ParameterizedQuery with an array of values passed in

Return Type

(ExecutionResult[ ] | Error)

Summary of the executed SQL queries as ExecutionResult[] which includes details such as affectedRowCount and lastInsertId. If one of the commands in the batch fails, this function will return BatchExecuteError, 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 | Error
Isolated Function
Remote Function

Executes a SQL stored procedure and returns the result as stream and execution summary.

Parameters

  • rowTypes typedesc<record {}>[ ] (default [])
  • The array of typedesc of 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 ProcedureCallResult or sql:Error

close

function close() returns Error?
Isolated Function

Close the SQL client.

Return Type

(Error?)

Possible error during closing the client