Skip to content

API Library ADO

Robert Polak edited this page Aug 9, 2019 · 31 revisions

Home / API Library / ADO

API Library ADO handle SQL Server. The API Library ADO Methods list with Parameters.

Configuration

Configuration of ADO variables at App.config.

More details about The Server API Library Configuration at Configuration API - ADO


ADO

API Library ADO handle SQL Server Open Connection to Data Base (defaultConnection).

Method: API.ADO.ADO

Parameters:

Name Type Default Description
connectionName String API_ADO_DEFAULT_CONNECTION default Connection

Return: Void.


OpenConnection

Open Connection to Data Base.

Method: API.ADO.OpenConnection

Parameters:

Name Type Default Description
connectionName String API_ADO_DEFAULT_CONNECTION default Connection

Return: void.


CloseConnection

Close Connection to Data Base.

Method: API.ADO.CloseConnection

Parameters:

Name Type Default Description
onDispose Bool false default Connection

Return: void.


StartTransaction

Start Transaction on active Data Base Connection.

Method: API.ADO.StartTransaction

Parameters:

Name Type Default Description
transactionIsolation IsolationLevel IsolationLevel.Snapshot Isolation Level

More detail Snapshot Isolation Level SQL Server at Snapshot Isolation Level SQL Server

Return: void.


ResetTransaction

Reset Transaction on active Data Base Connection.

Method: API.ADO.ResetTransaction

Parameters: N/A

Return: void.


CommitTransaction

Commit Transaction on active Data Base Connection.

Method: API.ADO.CommitTransaction

Parameters: N/A

Return: void.


RollbackTransaction

Rollback Transaction on active Data Base Connection.

Method: API.ADO.RollbackTransaction

Parameters: N/A

Return: void.


ExecuteNonQueryProcedure

Execute Non Query Procedure on active Data Base Connection.

Method: API.ADO.ExecuteNonQueryProcedure

Parameters:

Name Type Default Description
procedureName String Procedure Name
inputParams Array[ADO_inputParams] inputParams Input Params
returnParam object Return Param
outputParam object ADO_outputParam Output Param

ADO_inputParams

Name Type Default Description
name string name
value dynamic value
typeName string typeName

returnParam

Name Type Default Description
name string name
value string value

outputParam

Name Type Default Description
name string name
value string value

Return: void.


ExecuteBulkCopy

Execute Bulk Copy on active Data Base Connection.

Method: API.ADO.ExecuteBulkCopy

Parameters:

Name Type Default Description
destinationTableName String Destination Table Name
mappings Array[SqlBulkCopyColumnMapping] Mappings
dt object DataTable object
useCurrentTransaction Bool false Use Current Transaction
copyOptions enum SqlBulkCopyOptions.Default Copy Options

SqlBulkCopyColumnMapping Parameter

Name Type Default Description
DestinationColumn string Destination Column
DestinationOrdinal int Destination Ordinal
SourceColumn int Source Column
SourceOrdinal string Source Ordinal

More details about the SqlBulkCopyOptions Enum at SqlBulkCopyOptions Enum

Return: void.


ExecuteReaderProcedure

Execute Reader Procedure on active Data Base Connection.

Method: API.ADO.ExecuteReaderProcedure

Parameters:

Name Type Default Description
destinationTableName String Destination Table Name
procedureName String Procedure Name
inputParams Array[ADO_inputParams] Input Params

ADO_inputParams Parameter

Name Type Default Description
name string name
value dynamic value
typeName string typeName

Return: ADO_readerOutput object.

Name Type Default Description
hasData bool hasData
sizeInByte int sizeInByte
timeInSec float timeInSec
meta Array[dynamic] meta object
data Array[dynamic] data object

Dispose

Dispose all resources and close Data Base Connection.

Method: API.ADO.Dispose

Parameters: N/A

Return: void.

Clone this wiki locally