AceQL HTTP C# Client SDK v2.0

AceQLConnection Members

The AceQLConnection type exposes the following members.

Constructors


  Name Description
Public method AceQLConnection()()()()
Initializes a new instance of the AceQLConnection class.
Public method AceQLConnection(String)
Initializes a new instance of the AceQLConnection class when given a string that contains the connection string.
Public method AceQLConnection(String, AceQLCredential)
Initializes a new instance of the AceQLConnection class when given a string that contains the connection string and an AceQLCredential object that contains the username and password.

Methods


  Name Description
Public method BeginTransactionAsync(CancellationToken)
Initializes a AceQLTransactionobject. This will put the remote connection in auto commit mode off.

The cancellation token can be used to can be used to request that the operation be abandoned before the http request timeout.

Public method BeginTransactionAsync()()()()
Initializes a AceQLTransactionobject. This will put the remote connection in auto commit mode off.
Public method BeginTransactionAsync(IsolationLevel, CancellationToken)
Initializes a new AceQLTransactionobject with the specified isolation level. This will put the remote connection in auto commit mode off.

The cancellation token can be used to can be used to request that the operation be abandoned before the http request timeout.

Public method BeginTransactionAsync(IsolationLevel)
Initializes a new AceQLTransactionobject with the specified isolation level. This will put the remote connection in auto commit mode off.
Public method CloseAsync
Closes the connection to the remote database. This is the preferred method of closing any open connection.
Public method Dispose()()()()
If connection has not been closed by an explicit call to AceQLConnectionCloseAsync: calls silently AceQLConnectionCloseAsync without reporting any Exception.

As the call is not awaited, execution of the current method continues before the call to is AceQLConnectionCloseAsync completed.

Public method Equals(System.Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method Static member GetAceQLLocalFolderAsync
Gets the path to the local AceQL folder where SQL queries results are stored.
Public method GetClientVersion
Returns the AceQL Client SDK current Version.
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method GetProgressIndicator
Returns the progress indicator variable that will store Blob/Clob upload progress between 0 and 100.
Public method GetServerVersionAsync(CancellationToken)
Returns the remote AceQL HTTP Server Version.

The cancellation token can be used to can be used to request that the operation be abandoned before the http request timeout.

Public method GetServerVersionAsync()()()()
Returns the remote AceQL HTTP Server Version.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method Static member IsTraceOn
Says if trace is on. If on, a trace is done on the file "trace.txt" in the path of value AceQL.Client.Api.GetAceQLLocalFolderAsync().
Public method LogoutAsync
Closes the session to the remote AceQL server and Close on server all the connections to the database. This is the preferred method of closing any open connection.
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method OpenAsync()()()()
Opens a connection with the remote database.
Public method OpenAsync(CancellationToken)
Opens a connection with the remote database.

The cancellation token can be used to can be used to request that the operation be abandoned before the http request timeout.

Public method SetProgressIndicator
Sets the progress indicator variable that will store Blob/Clob upload progress between 0 and 100.
Public method Static member SetTraceOn
Sets the trace on/off. If on, a trace is done on the file "trace.txt" in the path of value AceQL.Client.Api.GetAceQLLocalFolderAsync().
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)

Properties


  Name Description
Public property ConnectionString
Gets or sets the connection string used to connect to the remote database.
Public property ConnectionTimeout
Gets the time to wait in milliseconds while trying to establish a connection before terminating the attempt and generating an error. If value is 0, [System.Net.Http.HttpClient] default will value be used.
Public property Credential
Gets or sets the AceQLCredential object for this connection.
Public property Database
Gets the current database in use.
Public property GzipResult
Gets or sets a value indicating whether SQL result sets are returned compressed with the GZIP file format before download. Defaults to true.
Public property PrettyPrinting
Gets a value indicating whether [pretty printing] is on or off. Defaults to false.