AceQL.Client.Api Namespace
AceQL.Client.Api.Metadata Namespace
AceQL HTTP C# Client SDK v6.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 AddRequestHeader
Adds A request header. The header will be added at each server call.
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) (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method Static member GetAceQLLocalFolder
Gets the path to the local AceQL folder where SQL queries results are stored.
Public method Static member GetClientVersion
Returns the AceQL Client SDK current Version.
Public method Static member GetDefaultWebProxy
Gets the default web proxy set. Returns null if none was previously set by SetDefaultWebProxy(IWebProxy).
Public method GetHashCode (Inherited from Object.)
Public method GetProgressIndicator
Returns the progress indicator variable that will store Blob/Clob upload progress between 0 and 100.
Public method GetRemoteDatabaseMetaData
Creates a RemoteDatabaseMetaData in order to query remote database metadata info.
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 (Inherited from Object.)
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 (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 ResetRequestHeaders
Resets the request headers. The previously added headers with AddRequestHeader(String, String) will be suppressed.
Public method Static member SetDefaultWebProxy
Sets the default web proxy to use. Allows to force to use on some environments (Windows, ...) System.Net.WebRequest.GetSystemProxy() instead of [System.Net.WebRequest.DefaultWebProxy].
Public method SetProgressIndicator
Sets the progress indicator variable that will store Blob/Clob upload progress between 0 and 100.
Public method ToString (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 filePath format before download. Defaults to true.
Public property RequestRetry
Gets or sets a value indicating whether a failed request will be retried. The retry will be done once, without compression. Defaults to false.