Connection Strings Parameters for CSV
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. |
AggregateFiles | When set to true, the provider will aggregate all the files in URI directory into a single result. With this option enabled, the AggregatedFiles will be exposed which can be used to query the dataset. |
AuthScheme | The scheme used for 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. |
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. |
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. |
DataSource | This property specifies a URI for the CSV resource location. |
DirectoryRetrievalDepth | Limit the subfolders recursively scanned when IncludeSubdirectories is enabled. |
ExcludeFileExtensions | Set to true if file extensions should be excluded from table names. |
ExtendedProperties | The Microsoft Jet OLE DB 4.0-compatible extended properties for text files. |
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. |
FMT | The format to be used to parse all text files. |
GenerateHiveDDL | Specifies a directory in which the provider will store the DDL statements required to query the data generated by INSERT queries. This is only valid for the S3 target. |
GenerateSchemaFiles | Indicates the user preference as to when schemas should be generated and saved. |
HDR | Whether to get column names from the first line of the specified files. |
IncludeColumnHeaders | Whether to get column names from the first line of the specified files. |
IncludeFiles | Comma-separated list of file extensions to include into the set of the files modelled as tables. |
IncludeSubdirectories | Whether to read files and Schema.ini from nested folders. In the case of a name collision, table names are prefixed by the underscore-separated folder names. |
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. |
MetadataDiscoveryURI | Used together with AggregateFiles , this property specifies a specific file to read the schema of the AggregatedFiles result set. |
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. |
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. |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
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. Enter Disabled, 1.0 or 2.0. |
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. |
QuoteCharacter | Determines the character which will be used to quote values. |
QuoteEscapeCharacter | Determines the character which will be used to escape quotes. |
Readonly | You can use this property to enforce read-only access to CSV 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. |
RowDelimiter | The character which will be used to detect the end of a CSV row. |
RowScanDepth | The number of rows to scan when dynamically determining columns for the table. |
RTK | The runtime key used for licensing. |
SchemaIniLocation | A path to the directory that contains the schema.ini file. |
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. |
SharepointUrl | The URL required for the Sharepoint cloud storage service provider. |
SkipHeaderComments | If set to true, skips rows at the top of the file beginning with #. |
SkipTop | Skips the amount of rows specified starting from the top. |
SSHAuthMode | The authentication method to be used to log on to an SFTP server. |
SSHClientCert | A certificate to be used for authenticating the user. |
SSHClientCertPassword | The password of the SSHClientCert certificate if it has one. |
SSHClientCertType | The type of SSHClientCert certificate. |
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. |
SSLMode | The authentication mechanism to be used when connecting to the FTP or SFTP server. |
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. |
TrimSpaces | Set to True if you want the provider to trim preceeding and trailing spaces in a cell containing a quoted value. |
TruncateOnInserts | Set to True if you want the provider to truncate on every (batch) insert. |
TypeDetectionScheme | Determines how to determine the data types of columns. |
URI | This property specifies a URI for the CSV 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. |
UseRowNumbers | Set this to true if you are deleting or updating in CSV. This will create a new column with the name RowNumber which will be used as key for that table. |
UseTempFile | Set to True if you want to use temp files when inserting in a CSV file. |
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. |