Miscellaneous
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
AllowPreparedStatement | Prepare a query statement before its execution. |
BatchSize | The maximum size of each batch operation to submit. |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
COPYConversionParameters | Specifies the coma separated list of parameter to use in the COPY command when InsertMode is S3Staging or S3StagingWithIAM. Supported parameters are: BLANKSASNULL DELIMITER EMPTYASNULL EXPLICIT_IDS NULL AS TRIMBLANKS TRUNCATECOLUMNS. |
FetchResultSetMetadata | This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server. |
IncludeTableTypes | If set to true, the provider will query for the types of individual tables and views. |
InsertMode | Specifies what method to use when inserting bulk data. By default DML mode is used. |
LZ4Compression | When set the driver notifies the server to compress data packets with lz4 compression algorithm. |
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. |
QueryPassthrough | This option passes the query to the Amazon Redshift server as is. |
Readonly | You can use this property to enforce read-only access to Amazon Redshift from the provider. |
RedshiftToS3RoleARN | The Amazon Resource Name of the role to use when authenticating S3 with IAM role by the COPY command for the bulk inserts. |
RTK | The runtime key used for licensing. |
S3Bucket | Specifies the name of AWS S3 bucket to upload bulk data for staging. |
S3BucketFolder | Specifies the name of the folder in AWS S3 bucket to upload bulk data for staging. By default bulk data are staged in the root folder. |
StripOutNulls | When set the null characters are stripped out from character values in bulk operations. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TimeZone | Set time zone for the current session. |
UseConnectionPooling | This property enables connection pooling. |
UseUIDForStaging | Use this property in combination with InsertMode assigned with S3Staging or S3StagingWithIAM. By default the the driver creates staging files with names that prepend the targeted table's name, so the files are overwritten between sessions. When the property is set to True , the provider additionally attaches temporary unique identifiers to these names. It may be required if you use parallel jobs to insert rows into the same table. Thus, the staging files are not overwritten by the jobs. A caveat is that using this property adds to the number of staging files put onto S3 bucket, since the file names are not controlled by the driver between different sessions. In this case you may want to define an AWS S3 policy on the bucket to remove staging files that were stored in a bucket automatically. |