Connection String Parameters for XML
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.
| Name | Description |
| AccessKey | Your AWS account access key. This value is accessible from your AWS security credentials page. |
| AuthScheme | The scheme used for HTTP authentication. Accepted entries are NTLM, BASIC, DIGEST, NONE, or KERBEROSDELEGATION. |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| AWSAccessKey | The access key associated with your Amazon Web Services account. |
| AWSSecretKey | The secret key associated with your Amazon Web Services account. |
| AzureAccessKey | The storage key associated with your Azure Blob storage account. |
| AzureAccount | The name of your Azure Blob storage account. |
| BackwardsCompatibilityMode | Set BackwardsCompatibilityMode to true to use the XML functionality and features available in the 2017 version. |
| CacheConnection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| CacheProvider | The name of the provider to be used to cache data. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| CustomHeaders | Other headers as determined by the user (optional). |
| CustomUrlParams | The custom query string to be included in the request. |
| DataModel | Specifies the data model to use when parsing XML documents and generating the database metadata. |
| DataSource | The Uniform Resource Identifier (URI) for the XML resource location. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FlattenArrays | By default, nested arrays are returned as strings of XML. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays. |
| FlattenObjects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of XML. |
| GenerateSchemaFiles | Indicates the user preference as to when schemas should be generated and saved. |
| IncludeFiles | Comma-separated list of file extensions to include into the set of the files modelled as tables. |
| InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| KerberosKDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| KerberosKeytabFile | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| KerberosRealm | The Kerberos Realm used to authenticate the user with. |
| KerberosServiceKDC | The Kerberos KDC of the service. |
| KerberosServiceRealm | The Kerberos realm of the service. |
| KerberosSPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| KerberosTicketCache | The full file path to an MIT Kerberos credential cache file. |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Logfile | A path to the log file. |
| MaxLogFileCount | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
| MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| MFASerialNumber | The serial number of the MFA device if one is being used. |
| MFAToken | The temporary token available from your MFA device. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthAccessTokenSecret | The OAuth access token secret for connecting using OAuth. |
| OAuthAccessTokenURL | The URL to retrieve the OAuth access token from. |
| OAuthAuthorizationURL | The authorization URL for the OAuth service. |
| OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthGrantType | The grant type for the OAuth flow. |
| OAuthParams | A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value. |
| OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthRefreshTokenURL | The URL to refresh the OAuth token from. |
| OAuthRequestTokenURL | The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0. |
| OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| OAuthVersion | The version of OAuth being used. |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| Other | These hidden properties are used only in specific use cases. |
| Password | The password used to connect to a remote data source using HTTP. |
| PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
| PoolMaxSize | The maximum connections in the pool. |
| PoolMinSize | The minimum number of connections in the pool. |
| PoolWaitTime | The max seconds to wait for an available connection. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyExceptions | A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer . |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| PushAttributes | Set PushAttributes to true to push any identified attributes as columns. |
| Readonly | You can use this property to enforce read-only access to XML from the provider. |
| Region | The hosting region for your Amazon Web Services. |
| RoleARN | The optional Amazon Resource Name of the role to use when authenticating. |
| RowScanDepth | The number of rows to scan when dynamically determining columns for the table. |
| RTK | The runtime key used for licensing. |
| SecretKey | Your AWS account secret key. This value is accessible from your AWS security credentials page. |
| SecurityToken | The security token used to authenticate to the AWS account. |
| SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSLClientCertPassword | The password for the TLS/SSL client certificate. |
| SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
| SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| SupportEnhancedSQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| TemporaryTokenDuration | The amount of time (in seconds) a temporary token will last. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| URI | The Uniform Resource Identifier (URI) for the XML resource location. |
| UseConnectionPooling | This property enables connection pooling. |
| UseEC2Roles | A boolean indicating if you would like to use EC2 credentials when reading files from Amazon S3. |
| User | The username that will be used to connect to a remote data source using HTTP. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| XPath | The XPath of an element that repeats at the same height within the XML document (used to split the document into multiple rows). |