| Name | Description | |
|---|---|---|
 | BigcommerceConnectionStringBuilder Constructor | Overloaded. Initializes a new instance of the BigcommerceConnectionStringBuilder class. |
BigcommerceConnectionStringBuilder Class Members
In This Topic
The following tables list the members exposed by BigcommerceConnectionStringBuilder.
Public Constructors
Public Properties
| Name | Description | |
|---|---|---|
 | AccessToken | Gets or sets the BigCommerce access token for OAuth authentication. |
| APIVersion | Gets or sets the BigCommerce API version to use. |
| AuthenticationToken | Gets or sets the automatically generated key that is used for basic authentication on BigCommerce. |
| AuthenticationType | Gets or sets the kind of authentication to use - Basic authentication of OAuth authentication. |
| ClientId | Gets or sets the BigCommerce client id for OAuth authentication. |
| ConnectionLifetime | Gets or sets time span in seconds for connection to live. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| ConnectionString | Gets or sets the connection string associated with the System.Data.Common.DbConnectionStringBuilder. (Inherited from System.Data.Common.DbConnectionStringBuilder) |
| ConnectionTimeout | Gets or sets the time to wait while trying to establish a connection before terminating the attempt and generating an error. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| Count | Gets the current number of keys that are contained within the System.Data.Common.DbConnectionStringBuilder.ConnectionString property. (Inherited from System.Data.Common.DbConnectionStringBuilder) |
| DefaultCommandTimeout | Gets or sets the time in seconds to wait while trying to execute a command before terminating the attempt and generating an error. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| FailoverRetries | Gets or sets the number of retry attempts to re-run a command in case when the command failed because of an exception, that indicates that the reason of the failure may be temporary. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| InitializationCommand | Specifies a data source-specific command that should be executed immediately after establishing the connection. (Inherited from Devart.Common.DbConnectionStringBuilder) |
| IsFixedSize | Returns true. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| IsReadOnly | Gets a value that indicates whether the System.Data.Common.DbConnectionStringBuilder is read-only. (Inherited from System.Data.Common.DbConnectionStringBuilder) |
| Item | Returns the value of given key. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| Keys | Collection of keys in the Devart.Data.SqlShimConnectionStringBuilder. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| LocalSQLEngine | Determines whether to use local SQL engine for SELECT queries, that are too complex to translate them directly to BigCommerce API calls or to throw an exception. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| MaxPoolSize | The maximum number of connections allowed in the pool. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| MinPoolSize | The minimum number of connections allowed in the pool. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| NormalizeDbNames | (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| PersistSecurityInfo | Gets or sets a value indicating whether password is stored in connection string after connection is opened. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| Pooling | Gets or sets pooling mode. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| ProxyHost | Gets or sets the host name or IP address of the proxy server to which to connect. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| ProxyPassword | Gets or sets the password for the proxy server account. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| ProxyPort | Gets or sets the port number of the proxy server. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| ProxyUser | Gets or sets the proxy server account name. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| Readonly | Gets or sets a value indicating whether the connection is read-only (allows only SELECT statements). (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| RunOnceCommand | Specifies a data source-specific command that should be executed immediately after first establishing the connection. Unlike InitializationCommand, this command is not executed when a connection is taken from the pool. (Inherited from Devart.Common.DbConnectionStringBuilder) |
| Server | Gets or sets the API Path - the path where all XML requests to BigCommerce should be sent. This property is used used for basic authentication on BigCommerce. |
| StoreDates | Determines whether to treat date values as dates in the BigCommerce store timezone. |
| StoreId | Gets or sets the Id of your BigCommerce store, used for OAuth authentication. |
| TokenServer | Gets or sets the location to store OAuth 2.0 refresh tokens between sessions. This parameter is applicable only for some of the data sources that use OAuth 2.0. It is not used in dotConnect for BigCommerce. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| UseCustomFields | Determines whether you will be able to get product custom fields via the CustomFields field of the Products object through this connection. |
| UserAgent | (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| UserId | Gets or sets the user name to login with. |
| UtcDates | 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. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| Values | Collection of values in the Devart.Data.SqlShimConnectionStringBuilder. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
Public Methods
| Name | Description | |
|---|---|---|
 | Add | Adds an entry with the specified key and value into the System.Data.Common.DbConnectionStringBuilder. (Inherited from System.Data.Common.DbConnectionStringBuilder) |
| Clear | Sets all Devart.Data.SqlShimConnectionStringBuilder properties to default values. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| ContainsKey | Indicates whether specified key is set in the Devart.Data.SqlShimConnectionStringBuilder object. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| EquivalentTo | Overloaded. Overridden. Returns a value indicating whether this BigcommerceConnectionStringBuilder has same parameters as given DbConnectionStringBuilder. |
| Remove | Sets value of the specified key to default. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| ShouldSerialize | Determines whether the key will be serialized if required. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
| ToString | Returns the connection string associated with this System.Data.Common.DbConnectionStringBuilder. (Inherited from System.Data.Common.DbConnectionStringBuilder) |
| TryGetValue | Attempts to get a key value. (Inherited from Devart.Data.SqlShimConnectionStringBuilder) |
See Also