[]
        
(Showing Draft Content)

C1.AdoNet.OData.C1ODataConnection

C1ODataConnection Class

Represents a connection to an OData service, which can be used for querying or modifying the data hosted there.

Namespace: C1.AdoNet.OData
Assembly: C1.AdoNet.OData.dll
Syntax
public sealed class C1ODataConnection : C1ConnectionBase<C1ODataConnection>, IComponent, IDbConnection, IDisposable, IAsyncDisposable, IExtendedConnection

Constructors

Name Description
C1ODataConnection()

Creates a new instance of C1ODataConnection.

C1ODataConnection(C1ODataConnectionStringBuilder)

Creates a C1ODataConnection instance, specifying its connection string expressed in a C1ODataConnectionStringBuilder.

C1ODataConnection(string)

Creates a C1ODataConnection instance, specifying the string to be used for opening it.

Properties

Name Description
BaseUrl

The base URL of the OData service.

CustomFunctions

Allows the declaration of a subset of functions supported by the target data source.

CustomHeaders

Custom headers that can be passed

CustomOperators

Allows the declaration of a subset of operators supported by the target data source.

DataSource

Gets the name of the database server to which to connect.

Database

Gets the name of the current database after a connection is opened, or the database name specified in the connection string before the connection is opened.

DbProviderFactory

Gets the DbProviderFactory for this connection.

IsNotValidForRead

IsNotValidForRead columns

ODataVersion

An int specifying which version of Odata is being used by C1ODataConnection.

ServerTimeZone

Server TimeZone

ServerVersion

Gets a string that represents the version of the server to which the object is connected.

SupportGroupBy

A boolean specifying whether or not this C1ODataConnection is using SupportGroupBy.

SupportLimit

A boolean specifying whether or not this C1ODataConnection is using SupportLimit.

SupportOrderBy

A boolean specifying whether or not this C1ODataConnection is using SupportOrderBy.

UnSupportedColumns

Allows the declaration of a subset of columns supported by the target data source.

UseDynamicType

A boolean specifying whether or not this C1ODataConnection is using dynamic type.

UseEtag

A boolean specifying whether or not this C1ODataConnection is using Etag.

Methods

Name Description
BeginDbTransaction(IsolationLevel)

Initiates and returns a new transaction with the connected data source.

ChangeDatabase(string)

Changes the current database for an open connection.

Close()

Closes the connection to the database. This is the preferred method of closing any open connection.

CreateDbCommand()

Creates and returns a DbCommand object associated with the current connection.

GetColumnsSchema(string[])

Retrieve the metadata relatively to the columns.

GetForeignKeySchema(string[])

Retrieve the metadata relatively to the foreign keys.

GetIndexColumns(string[])

Retrieve the metadata relatively to the index columns.

GetIndexesSchema(string[])

Retrieve the metadata relatively to the indexes.

GetPrimaryKeySchema(string[])

Retrieve the metadata relatively to the primary keys.

GetTablesSchema(string[])

Retrieve the metadata relatively to the tables.

OnConnectionStringChanged()

A method that is called every time there is a change to the connection string used by this C1ODataConnection.

Open()

Opens a database connection with the settings specified by the connection string.

OpenAsync(CancellationToken)

An asynchronous version of Open().