Connection String Parameters for Excel
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 |
AllowFormula | Whether or not to treat values starting with an equals (=) sign as formulas during inserts and updates. |
AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
BufferChanges | Indicates whether to hold changes to the data in memory until the connection is closed. |
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 . |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
DefineTables | Map Excel ranges to table names. |
EmptyValueMode | Indicates whether to read the empty values as empty or as null. |
ExcelFile | The location of an Excel file. |
HasCrossSheetReferences | Indicates how cross sheet references are handled. |
Header | Indicates whether the first row should be used as a column header. |
IgnoreCalcError | Indicates whether to ignore errors that occurred during the calculation. |
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. |
NullValueMode | Indicates whether to read empty cells as null or as empty. |
Offline | Use offline mode to get the data from the cache instead of the live source. |
Orientation | Indicates whether the data in Excel is laid out horizontally or vertically. |
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 | 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. |
RowScanDepth | Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan. |
RTK | The runtime key used for licensing. |
ShowEmptyRows | Indicates whether or not the empty rows should be pushed. |
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. |
TypeDetectionScheme | Determines how the provider detects the data types of columns. |
UseConnectionPooling | This property enables connection pooling. |
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. |