ConnectionString Property (MagentoConnection)

Visual Basic
C#

'Declaration
 
Public Shadows Property ConnectionString As String

public new string ConnectionString {get; set;}

Property Value

The connection string that includes the parameters needed to establish the initial connection. The default value is an empty string ("").

When ConnectionString property is assigned a value, connection closes. Many of the connection string values have corresponding properties. When the connection string is set, all of these properties are updated, except when an error is detected. In this case, none of the properties are updated. MagentoConnection properties return only those settings contained in the ConnectionString.

Resetting the ConnectionString on a closed connection resets all connection string values (and related properties).

The connection string is parsed immediately after being set. If errors in syntax are found when parsing, a runtime exception, such as System.ArgumentException, is generated. Other errors can be found only when an attempt is made to Open the connection.

The ConnectionString is similar to an OLE DB connection string. Values may be delimited by single or double quotes, (for example, name='value' or name="value"). Either single or double quotes may be used within a connection string by using the other delimiter, for example, name="value's" or name= 'value"s', but not name= 'value's' or name= ""value"". All blank characters, except those placed within a value or within quotes, are ignored. Keyword value pairs must be separated by a semicolon (;). If a semicolon is part of a value, it also must be delimited by quotes. No escape sequences are supported. The value type is irrelevant. Names are not case sensitive. Arguments names may occur only once in the connection string.

The following table lists the valid names for values within the ConnectionString.

Name	Description
AccessToken	Specifies the OAuth 2.0 access token to authorize access to the service.
API Key	Specifies the automatically generated key used to connect to Magento 1.x. The key can be found in the User Information section of the Magento dashboard. For Magento 2.0, use the Password parameter and specify your password instead.
AuthenticationType	Specifies the authentication method used to connect to Magento.
Connection Lifetime	Determines the maximum time span (in seconds) a connection can remain in the pool: when a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).
Connect Timeout -or- Connection Timeout	Specifies the length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 60.
Default Command Timeout	Specifies the time in seconds to wait while trying to execute a command before terminating the attempt and generating an error. A value of 0 indicates no limit.
Domain	Specifies the address of the Magento store to connect to.
Failover Retries	Specifies the maximum number of retry attempts to reconnect after a failover event.
Initialization Command	Specifies a data source-specific command to execute immediately after the connection is established.
Local SQL Engine	Uses a local SQL engine to process queries instead of a remote server.
Max Pool Size	Specifies the maximum number of connections allowed in the pool. Setting the Max Pool Size value of the ConnectionString can affect performance. The default value is 100.
Min Pool Size	Specifies the minimum number of connections allowed in the pool. The default value is 0.
NormalizeDbNames	Determines whether database object names are normalized when retrieved from the database.
Password	Specifies the password to authenticate with the Magento service.
Persist Security Info	Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.
Pooling	Determines whether, by default, the MagentoConnection object is drawn from the appropriate pool or is created and added to the appropriate pool, when set to true.
Proxy Host	Specifies the host name or IP address of proxy server.
Proxy Password	Specifies the password for the proxy server account.
Proxy Port	Specifies the port number of the proxy server. The default value is 3128.
Proxy User	Specifies the proxy server account name.
Run Once Command	Specifies a command to execute the first time the connection is opened. The command is not executed when the connection is retrieved from the connection pool.
Readonly	Determines whether the connection is read-only (allows only SELECT statements).
Service Version	Specifies the Magento service version to connect to: Ver1 for Magento 1.x or Ver2 for Magento 2.0.
StoreViewCode	Specifies the store view code to connect to the Magento store.
User	Specifies the username to authenticate with the Magento service.
UserAgent	Specifies the User-Agent string that identifies the client application when sending requests to the service.
UTC Dates	Indicates whether all the datetime values retrieved from the data source are returned as UTC values or converted to local time, and whether date values, specified on the application side (for example, in SQL statements) are considered UTC or local. Default value is false.

The following example creates a MagentoConnection and sets some of its properties in the connection string.

csharp

public void CreateMagentoConnection()
{
  string myConnString1 = 
     "domain=192.168.10.68/magento;user=Test;apikey=testpassword;";
  MagentoConnection adobe commerceConnection1 = new MagentoConnection(myConnString1);
  adobe commerceConnection1.Open();
}

Visual Basic

Public Sub CreateMagentoConnection()
  Dim myConnString1 As String = _
      "domain=192.168.10.68/magento;user=Test;apikey=testpassword;"
  Dim adobe commerceConnection1 As New MagentoConnection(myConnString1)
  adobe commerceConnection1.Open()
End Sub

Reference

MagentoConnection Class
MagentoConnection Members
Open Method
MagentoConnectionStringBuilder Class