Additional Documentation
This Connector is based on the Excel ADO.NET Provider by CData. For additional help, including Connection String parameters, please see: https://cdn.cdata.com/help/RXG/ado/
Establishing a Connection
Connecting to Excel Data Sources
The StarfishETL Excel Connector allows connecting to local Excel resources. Browse to your desired Excel file on your local machine or on your network. Please use UNC and not drive letter when browsing the network.
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 connecting, see Establishing a Connection.| Allow Formula | Whether or not to treat values starting with an equals (=) sign as formulas during inserts and updates. |
| Auth Key | The authentication secret used to request and obtain the OAuth Access Token. |
| Auth Scheme | The type of authentication to use when connecting to remote services. |
| Auth Token | The authentication token used to request and obtain the OAuth Access Token. |
| Auto Cache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| AWS Access Key | Your AWS account access key. This value is accessible from your AWS security credentials page. |
| AWS Region | The hosting region for your Amazon Web Services. |
| AWS Role ARN | The Amazon Resource Name of the role to use when authenticating. |
| AWS Secret Key | Your AWS account secret key. This value is accessible from your AWS security credentials page. |
| Azure Access Key | The storage key associated with your Azure Blob storage account. |
| Azure Account | The name of your Azure Blob storage account. |
| Azure Environment | The Azure Environment to use when establishing a connection. |
| Azure Shared Access Signature | A shared access key signature that may be used for authentication. |
| Azure Tenant | The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used. |
| Buffer Changes | Indicates whether to hold changes to the data in memory until the connection is closed. |
| Cache Connection | 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. |
| Cache Location | Specifies the path to the cache when caching to a file. |
| Cache Metadata | This property determines whether or not to cache the table metadata to a file store. |
| Cache Provider | The name of the provider to be used to cache data. |
| Cache Tolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Callback URL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| Connection Life Time | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| Custom Headers | Other headers as determined by the user (optional). |
| Custom Url Params | The custom query string to be included in the request. |
| Define Tables | Map Excel ranges to table names. |
| Directory Retrieval Depth | Limit the subfolders recursively scanned when IncludeSubdirectories is enabled. |
| Empty Value Mode | Indicates whether to read the empty values as empty or as null. |
| Excel File | The location of an Excel file. |
| Firewall Password | A password used to authenticate to a proxy-based firewall. |
| Firewall Port | The TCP port for a proxy-based firewall. |
| Firewall Server | The name or IP address of a proxy-based firewall. |
| Firewall Type | The protocol used by a proxy-based firewall. |
| Firewall User | The user name to use to authenticate with a proxy-based firewall. |
| Has Cross Sheet References | Indicates how cross sheet references are handled. |
| Header | Indicates whether the first row should be used as a column header. |
| Ignore Calc Error | Indicates whether to ignore errors that occurred during the calculation. |
| Include Files | Comma-separated list of file extensions to include into the set of the files modeled as tables. |
| Include Subdirectories | Whether to read files from nested folders. In the case of a name collision, table names are prefixed by the underscore-separated folder names. |
| Initiate OAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| Kerberos Keytab File | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Logfile | A filepath which designates the name and location of the log file. |
| Log Modules | Core modules to be included in the log file. |
| Max Log File Count | 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. |
| Max Log File Size | 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. |
| Max Rows | 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. |
| MFA Serial Number | The serial number of the MFA device if one is being used. |
| MFA Token | The temporary token available from your MFA device. |
| Null Value Mode | Indicates whether to read empty cells as null or as empty. |
| Null Values | A comma separated list which will be replaced with nulls if there are found in the CSV file. |
| OAuth Access Token | The access token for connecting using OAuth. |
| OAuth Access Token Secret | The OAuth access token secret for connecting using OAuth. |
| OAuth Access Token URL | The URL to retrieve the OAuth access token from. |
| OAuth Authorization URL | The authorization URL for the OAuth service. |
| OAuth Client Id | The client ID assigned when you register your application with an OAuth authorization server. |
| OAuth Client Secret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuth Expires In | The lifetime in seconds of the OAuth AccessToken. |
| OAuth Grant Type | The grant type for the OAuth flow. |
| OAuth Params | A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value. |
| OAuth Refresh Token | The OAuth refresh token for the corresponding OAuth access token. |
| OAuth Refresh Token URL | The URL to refresh the OAuth token from. |
| OAuth Request Token URL | The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0. |
| OAuth Settings Location | 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://. |
| OAuth Token Timestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| OAuth Verifier | The verifier code returned from the OAuth authorization URL. |
| OAuth Version | The version of OAuth being used. |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| Oracle Namespace | The Oracle Cloud Object Storage namespace to use. |
| Orientation | Indicates whether the data in Excel is laid out horizontally or vertically. |
| Other | These hidden properties are used only in specific use cases. |
| Password | The password used to authenticate the user. |
| Pool Idle Timeout | The allowed idle time for a connection before it is closed. |
| Pool Max Size | The maximum connections in the pool. |
| Pool Min Size | The minimum number of connections in the pool. |
| Pool Wait Time | The max seconds to wait for an available connection. |
| Project Id | The id of the project where your Google Cloud Storage instance resides. |
| Proxy Auth Scheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| Proxy Auto Detect | 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. |
| Proxy Exceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Proxy Password | A password to be used to authenticate to the ProxyServer proxy. |
| Proxy Port | The TCP port the ProxyServer proxy is running on. |
| Proxy Server | The hostname or IP address of a proxy to route HTTP traffic through. |
| Proxy SSL Type | The SSL type to use when connecting to the ProxyServer proxy. |
| Proxy User | A user name to be used to authenticate to the ProxyServer proxy. |
| Pseudo Columns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Readonly | You can use this property to enforce read-only access to Excel from the provider. |
| Recalculate | Indicates whether to recalculate all formulas when data is read. |
| Region | The hosting region for your S3-like Web Services. |
| Row Scan Depth | The maximum number of rows to scan to look for the columns available in a table. |
| RTK | The runtime key used for licensing. |
| Sharepoint URL | The URL required for the Sharepoint cloud storage service provider. |
| Show Empty Rows | Indicates whether or not the empty rows should be pushed. |
| SSH Auth Mode | The authentication method to be used to log on to an SFTP server. |
| SSH Client Cert | A certificate to be used for authenticating the user. |
| SSH Client Cert Password | The password of the SSHClientCert certificate if it has one. |
| SSH Client Cert Type | The type of SSHClientCert certificate. |
| SSL Client Cert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSL Client Cert Password | The password for the TLS/SSL client certificate. |
| SSL Client Cert Subject | The subject of the TLS/SSL client certificate. |
| SSL Client Cert Type | The type of key store containing the TLS/SSL client certificate. |
| SSL Server Cert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Support Enhanced SQL | 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. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| Type Detection Scheme | Determines how the provider detects the data types of columns. |
| URI | The Uniform Resource Identifier (URI) for the Excel resource location. |
| URL | The URL of the cloud storage service provider. |
| Use Connection Pooling | This property enables connection pooling. |
| User | The Excel user account used to authenticate. |
| Use Virtual Hosting | 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. |
| 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. |