Connection String Options
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. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to remote services. |
| AccessKey | Your account access key. This value is accessible from your security credentials page. |
| SecretKey | Your account secret key. This value is accessible from your security credentials page. |
| User | The user account used to authenticate. |
| Password | The password used to authenticate the user. |
| SharePointEdition | The edition of SharePoint being used. Set either SharePointOnline or SharePointOnPremise. |
| Property | Description |
| ConnectionType | Specifies the file storage service, server, or file access protocol through which your Microsoft Excel files are stored and retreived. |
| URI | The Uniform Resource Identifier (URI) for the Excel resource location. |
| DefineTables | Map Excel ranges to table names. |
| Header | Indicates whether the first row should be used as a column header. |
| Orientation | Indicates whether the data in Excel is laid out horizontally or vertically. |
| ExcelFile | The location of an Excel file. |
| BufferChanges | Indicates whether to hold changes to the data in memory until the connection is closed. |
| Region | The hosting region for your S3-like Web Services. |
| ProjectId | The Id of the project where your Google Cloud Storage instance resides. |
| OracleNamespace | The Oracle Cloud Object Storage namespace to use. |
| StorageBaseURL | The URL of a cloud storage service provider. |
| UseVirtualHosting | If true (default), buckets will be referenced in the request using the hosted-style request: http://yourbucket.s3.amazonaws.com/yourobject. If set to false, the bean will use the path-style request: http://s3.amazonaws.com/yourbucket/yourobject. Note that this property will be set to false, in case of an S3 based custom service when the CustomURL is specified. |
| UseLakeFormation | When this property is set to true, AWSLakeFormation service will be used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through OKTA, ADFS, AzureAD, PingFederate, while providing a SAML assertion. |
| Property | Description |
| AWSAccessKey | Your AWS account access key. This value is accessible from your AWS security credentials page. |
| AWSSecretKey | Your AWS account secret key. This value is accessible from your AWS security credentials page. |
| AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
| AWSPrincipalARN | The ARN of the SAML Identity provider in your AWS account. |
| AWSRegion | The hosting region for your Amazon Web Services. |
| AWSSessionToken | Your AWS session token. |
| AWSExternalId | A unique identifier that might be required when you assume a role in another account. |
| MFASerialNumber | The serial number of the MFA device if one is being used. |
| MFAToken | The temporary token available from your MFA device. |
| CredentialsLocation | The location of the settings file where MFA credentials are saved. |
| TemporaryTokenDuration | The amount of time (in seconds) a temporary token will last. |
| AWSWebIdentityToken | The OAuth 2.0 access token or OpenID Connect ID token that is provided by an identity provider. |
| Property | Description |
| AzureStorageAccount | The name of your Azure storage account. |
| AzureAccessKey | The storage key associated with your Azure account. |
| AzureSharedAccessSignature | A shared access key signature that may be used for authentication. |
| AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
| AzureEnvironment | The Azure Environment to use when establishing a connection. |
| Property | Description |
| SSOLoginURL | The identity provider's login URL. |
| SSOProperties | Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. |
| SSOExchangeUrl | The URL used for consuming the SAML response and exchanging it for service specific credentials. |
| Property | Description |
| AllowFormula | Whether or not to treat values starting with an equals (=) sign as formulas during INSERTs and updates. |
| EmptyValueMode | Indicates whether to read the empty values as empty or as null. |
| NullValues | A comma separated list which will be replaced with nulls if there are found in the CSV file. |
| IgnoreCalcError | Indicates whether to ignore errors that occurred during the calculation. |
| NullValueMode | Indicates whether to read empty cells as null or as empty. |
| HasCrossSheetReferences | Indicates how cross sheet references are handled. |
| Recalculate | Indicates whether to recalculate all formulas when data is read. |
| ShowEmptyRows | Indicates whether or not the empty rows should be pushed. |
| TypeDetectionScheme | Determines how the provider detects the data types of columns. |
| EnableOleDbCompatibility | Indicates whether to read the data with the same behavior as the Microsoft OleDB driver. |
| UseFastInsert | Indicates whether to use the fastInsert when executing INSERT Statement. |
| AggregateFiles | Allows URI to be set to a local directory instead of a single file. Aggregates the contents of all identically structured files in the directory to one table per sheet. |
| SkipTop | Skips the number of rows specified starting from the top. |
| IncludeCustomNames | Indicates whether or not the defined names should be pushed. |
| IncludeSubdirectories | Includes the subdirectories of the URI in the aggregation when AggregateFiles is set to true. |
| MetadataDiscoveryURI | Indicates which file is considered the metadata document when the AggregateFiles is set to true. |
| Property | Description |
| InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| OAuthVersion | The version of OAuth being used. |
| 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. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthAccessTokenSecret | The OAuth access token secret for connecting using OAuth. |
| OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'. |
| CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| Scope | Specify scope to obtain the initial access and refresh token. |
| OAuthGrantType | The grant type for the OAuth flow. |
| OAuthPasswordGrantMode | Specifies how the OAuth Client Id and Client Secret should be passed. Supported options: BASIC and POST. |
| OAuthIncludeCallbackURL | Whether to include the callback URL in an access token request. |
| OAuthAuthorizationURL | The authorization URL for the OAuth service. |
| OAuthAccessTokenURL | The URL to retrieve the OAuth access token from. |
| 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. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
| AuthKey | The authentication secret used to request and obtain the OAuth Access Token. |
| 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. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| Property | Description |
| OAuthJWTCert | The JWT Certificate store. |
| OAuthJWTCertType | The type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
| OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
| Property | Description |
| KerberosKDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| KerberosRealm | The Kerberos Realm used to authenticate the user. |
| KerberosSPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| KerberosUser | The principal name for the Kerberos Domain Controller. Used in the format host/user@realm. |
| KerberosKeytabFile | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| KerberosServiceRealm | The Kerberos realm of the service. |
| KerberosServiceKDC | The Kerberos KDC of the service. |
| KerberosTicketCache | The full file path to an MIT Kerberos credential cache file. |
| Property | Description |
| SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
| SSLClientCertPassword | The password for the TLS/SSL client certificate. |
| SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
| SSLMode | The authentication mechanism to be used when connecting to the FTP or FTPS server. |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| SSHAuthMode | The authentication method used when establishing an SSH Tunnel to the service. |
| SSHClientCert | A certificate to be used for authenticating the SSHUser. |
| SSHClientCertPassword | The password of the SSHClientCert key if it has one. |
| SSHClientCertSubject | The subject of the SSH client certificate. |
| SSHClientCertType | The type of SSHClientCert private key. |
| SSHUser | The SSH user. |
| SSHPassword | The SSH password. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
| ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheDriver | The database driver used to cache data. |
| 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. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| BatchSize | The maximum size of each batch operation to submit. |
| Charset | Specifies the session character set for encoding and decoding character data transferred to and from the Microsoft Excel file. The default value is UTF-8. |
| ClientCulture | This property can be used to specify the format of data (e.g., currency values) that is accepted by the client application. This property can be used when the client application does not support the machine's culture settings. For example, Microsoft Access requires 'en-US'. |
| ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| ConnectOnOpen | This property specifies whether to connect to the Microsoft Excel when the connection is opened. |
| Culture | This setting can be used to specify culture settings that determine how the provider interprets certain data types that are passed into the provider. For example, setting Culture='de-DE' will output German formats even on an American machine. |
| CustomHeaders | Other headers as determined by the user (optional). |
| CustomUrlParams | The custom query string to be included in the request. |
| FolderId | The ID of a folder in Google Drive. If set, the resource location specified by the URI is relative to the Folder ID for all operations. |
| GenerateSchemaFiles | Indicates the user preference as to when schemas should be generated and saved. |
| IncludeDropboxTeamResources | Indicates if you want to include Dropbox team files and folders. |
| IncludeItemsFromAllDrives | Whether Google Drive shared drive items should be included in results. If not present or set to false, then shared drive items are not returned. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| 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. |
| PseudoColumns | Specify a set of pseudocolumns to expose as columns. |
| Readonly | You can use this property to enforce read-only access to Microsoft Excel from the provider. |
| RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
| RTK | The runtime key used for licensing. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UseConnectionPooling | This property enables connection pooling. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |