C1MagentoConnection Class

<xref href="C1.AdoNet.Magento.C1MagentoConnection" data-throw-if-not-resolved="false"></xref> represents a connection to a Magento server.

The connection can be used to query the data hosted by the server or request modifications.

Inheritance

object

C1ConnectionBase<C1MagentoConnection>

C1MagentoConnection

Implements

Namespace: C1.AdoNet.Magento

Assembly: C1.AdoNet.Magento.dll

Syntax

public sealed class C1MagentoConnection : C1ConnectionBase<C1MagentoConnection>, IComponent, IDbConnection, IDisposable, IAsyncDisposable

Public NotInheritable Class C1MagentoConnection
    Inherits C1ConnectionBase(Of C1MagentoConnection)
    Implements IComponent, IDbConnection, IDisposable, IAsyncDisposable

Constructors

Name	Description
C1MagentoConnection()	Creates a new C1MagentoConnection instance.
C1MagentoConnection(C1MagentoConnectionStringBuilder)	Initialize a new C1MagentoConnection instance using the specified connection string expressed in a C1MagentoConnectionStringBuilder.
C1MagentoConnection(string)	Initialize a new C1MagentoConnection instance using the specified connection string.

Properties

Name	Description
AccessToken	Access Token.
ApiVersion	The API version of the Magento server
BaseUrl	The base url of the Magento server.
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.
ServerVersion	Gets a string that represents the version of the server to which the object is connected.
TokenType	The token type to authenticate in Magento.
UseCache	Use cache property of the Magento server.

Methods

Name	Description
BeginDbTransaction(IsolationLevel)	Begins a transaction on the connection.
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.
GetPrimaryKeySchema(string[])	Retrieve the metadata relatively to the primary keys.
GetTablesSchema(string[])	Retrieve the metadata relatively to the tables.
OnConnectionStringChanged()	A method that is executed everytime that the connection string used by this C1MagentoConnectionStringBuilder has changed.
Open()	Opens a database connection with the settings specified by the connection string.
OpenAsync(CancellationToken)	An asynchronous version of Open() open.

Events

Name	Description
OAuthTokenRetreived	Occurs after the token is taken.