JDBC Driver for Amazon Redshift

Build 24.0.9060

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
AllowPreparedStatementPrepare a query statement before its execution.
BatchSizeThe maximum size of each batch operation to submit.
ConnectionLifeTimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectOnOpenThis property specifies whether to connect to the Amazon Redshift when the connection is opened.
COPYConversionParametersSpecifies 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.
FetchResultSetMetadataThis field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server.
IncludeTableTypesIf set to true, the provider will query for the types of individual tables and views.
InsertModeSpecifies what method to use when inserting bulk data. By default DML mode is used.
LZ4CompressionWhen set the driver notifies the server to compress data packets with lz4 compression algorithm.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
OtherThese hidden properties are used only in specific use cases.
PoolIdleTimeoutThe allowed idle time for a connection before it is closed.
PoolMaxSizeThe maximum connections in the pool.
PoolMinSizeThe minimum number of connections in the pool.
PoolWaitTimeThe max seconds to wait for an available connection.
QueryPassthroughThis option passes the query to the Amazon Redshift server as is.
ReadonlyYou can use this property to enforce read-only access to Amazon Redshift from the provider.
RedshiftToS3RoleARNThe Amazon Resource Name of the role to use when authenticating S3 with IAM role by the COPY command for the bulk inserts.
RTKThe runtime key used for licensing.
S3BucketSpecifies the name of AWS S3 bucket to upload bulk data for staging.
S3BucketFolderSpecifies 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.
StripOutNullsWhen set the null characters are stripped out from character values in bulk operations.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TimeZoneSet time zone for the current session.
UseConnectionPoolingThis property enables connection pooling.
UseUIDForStagingUse 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.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060