redshift connection properties
This is list of properties that are compatible with redshift.
They are inside given data source configuration file. For example: redshiftTest-source_1.conf These properties are saved in this format there:
"properties": {
"ApplicationName": "testApp",
"testQuery": "SELECT 1",
"defaultCatalog": "test",
"url": "jdbc:redshift://localhost:5439/${database}"
},
⚠️ Note: You can use SHIFT with mouse scroll to scroll horizontally!
| Key | Description | Possible values | Default |
|---|---|---|---|
| AccessKeyID | The IAM access key id for the IAM user or role | String | - |
| allowEncodingChanges | Allow for changes in client_encoding | Boolean | false |
| ApplicationName | Name of the Application (backend >= 9.0) | String | - |
| assumeMinServerVersion | Assume the server is at least that version | String | - |
| AuthMech | Parameter governing the use of SSL. Alias for sslMode | String ( TRUE / FALSE ) | TRUE |
| AutoCreate | Indicates whether the user should be created if not exists | Boolean | False |
| autosave | Specifies what the driver should do if a query fails. In autosave=always mode, JDBC driver sets a savepoint before each query, and rolls back to that savepoint in case of failure. In autosave=never mode (default), no savepoint dance is made ever. In autosave=conservative mode, safepoint is set for each query, however the rollback is done only for rare cases like 'cached statement cannot change return type' or 'statement XXX is not valid' so JDBC driver rollsback and retries | String | never |
| binaryTransfer | Use binary format for sending and receiving data if possible | Boolean | true |
| binaryTransferDisable | Comma separated list of types to disable binary transfer. Either OID numbers or names. Overrides values in the driver default set and values set with binaryTransferEnable. | String | - |
| binaryTransferEnable | Comma separated list of types to enable binary transfer. Either OID numbers or names | String | - |
| BlockingRowsMode | Positive number of rows that should be fetched from the database when more rows are needed for ResultSet by each fetch iteration | Integer | 0 |
| cancelSignalTimeout | The timeout that is used for sending cancel command. | Integer | 10 |
| cleanupSavePoints | Determines if the SAVEPOINT created in autosave mode is released prior to the statement. This is done to avoid running out of shared buffers on the server in the case where 1000's of queries are performed. | Boolean | false |
| ClusterID | The name of the Redshift cluster to connect to. | String | - |
| connectTimeout | The timeout value used for socket connect operations. The timeout is specified in seconds. A value of 0 means that no timeout is specified. | Integer (0 no timeout) | 10 |
| currentSchema | Specify the schema to be set in the search-path | String | - |
| databaseMetadataCacheFields | Specifies the maximum number of fields to be cached per connection. A value of {@code 0} disables the cache. | Integer | 65536 |
| databaseMetadataCacheFieldsMiB | Specifies the maximum size (in megabytes) of fields to be cached per connection. A value of {@code 0} disables the cache. | Integer | 5 |
| databaseMetadataCurrentDbOnly | Control the behavior of metadata API to return data from all accessible databases or only from connected database | Boolean | true |
| DbGroups | A comma delimited database group names | String | PUBLIC |
| DbGroupsFilter | Regex for filtering out dbGroups from final result | String | - |
| defaultRowFetchSize | Positive number of rows that should be fetched from the database when more rows are needed for ResultSet by each fetch iteration | Integer (0 fetch all) | 0 |
| disableColumnSanitiser | Enable optimization that disables column name sanitiser | Boolean | off (false) |
| DisableIsValidQuery | Disable isValid query | Boolean | False |
| DSILogLevel | Log level of the driver | Integer ( 1 - 6 ) | ? |
| enableFetchRingBuffer | The Redshift fetch rows using a ring buffer on a separate thread | Boolean | true |
| enableGeneratedName | The Redshift uses generated statement name and portal name | Boolean | - |
| enableMultiSqlSupport | Control the behavior of semicolon separated SQL commands in a Statement | Boolean | true |
| enableStatementCache | The Redshift statement cache using SQL as key | Boolean | - |
| EndpointUrl | The Redshift endpoint url | String | null |
| escapeSyntaxCallMode | Specifies how the driver transforms JDBC escape call syntax into underlying SQL, for invoking procedures or functions. (backend >= 11)|\n + |In escapeSyntaxCallMode=select mode (the default), the driver always uses a SELECT statement (allowing function invocation only).|\n + |In escapeSyntaxCallMode=callIfNoReturn mode, the driver uses a CALL statement (allowing procedure invocation) if there is no return parameter specified, otherwise the driver uses a SELECT statement.|\n + |In escapeSyntaxCallMode=call mode, the driver always uses a CALL statement (allowing procedure invocation only). | String | select |
| fetchRingBufferSize | Specifies size of ring buffer during fetching result set. Can be specified as specified size or percent of heap memory. | String | 1G |
| ForceLowercase | Forces database group names to be lower case | Boolean | false |
| groupFederation | Use the IDP Groups in the Redshift | Boolean | false |
| gsslib | Force SSSPI or GSSAPI | String | auto |
| hideUnprivilegedObjects | Enable hiding of database objects for which the current user has no privileges granted from the DatabaseMetaData | Boolean | - |
| hostRecheckSeconds | Specifies period (seconds) after which the host status is checked again in case it has changed | Integer | 10 |
| IAMAuth | Indicates whether use IAM authentication | Boolean | - |
| IAMDisableCache | Indicates to disable credential cache. Enable cache gives protection against throttling API calls | Boolean | false |
| IAMDuration | The length of time (in seconds) until the temporary IAM credentials expire. | Integer ( min 900, max 3600 ) | 900 |
| IniFile | The JDBC INI file. Easy to configure connection properties. | String | - |
| IniSection | The JDBC INI file section name. | String | - |
| jaasApplicationName | Specifies the name of the JAAS system or application login configuration. | String | pgjdbc |
| jaasLogin | Login with JAAS before doing GSSAPI authentication | Boolean | true |
| kerberosServerName | The Kerberos service name to use when authenticating with GSSAPI. | String | postgres |
| loadBalanceHosts | If disabled hosts are connected in the given order. If enabled hosts are chosen randomly from the set of suitable candidates | Boolean | false |
| logServerErrorDetail | Include full server error detail in exception messages. If disabled then only the error itself will be included. | Boolean | true |
| loggerFile | File name output of the Logger | String | - |
| loggerLevel | Logger level of the driver | String | - |
| loginTimeout | Specify how long to wait for establishment of a database connection. | Integer ( 0 dont time out) | 0 |
| LogLevel | Log level of the driver | Integer ( 1 - 6 ) | 0 |
| LogPath | File Path output of the Logger. If the LogPath value is invalid, the driver sends the logged information to the standard output stream, System.out. | String | current working directory |
| logUnclosedConnections | When connections that are not explicitly closed are garbage collected, log the stacktrace from the opening of the connection to trace the leak source | Boolean | false |
| MaxLogFileCount | Maximum number of log files | Integer | - |
| MaxLogFileSize | Maximum single log file size | Integer | - |
| maxResultBuffer | Specify the size of the result buffer when not streaming results, will generate an exception if the result exceeds this size. Specify in units of k,m or g, or percent for total heap percent, i.e. 10percent | String | - |
| options | Specify 'options' connection initialization parameter | String | - |
| plugin_name | The fully qualified class path for a class that implements AWSCredentialsProvider | String | - |
| preferQueryMode | Specifies which mode is used to execute queries to database: simple means ('Q' execute, no parse, no bind, text mode only), extended means always use bind/execute messages, extendedForPrepared means extended for prepared statements only, extendedCacheEverything means use extended protocol and try cache every statement (including Statement.execute(String sql)) in a query cache. | String (extended, extendedForPrepared, extendedCacheEverything, simple) | extended |
| preparedStatementCacheQueries | Specifies the maximum number of entries in per-connection cache of prepared statements. A value of {@code 0} disables the cache. | 0 (Disabled) or Integer | 256 |
| preparedStatementCacheSizeMiB | Specifies the maximum size (in megabytes) of a per-connection prepared statement cache. A value of {@code 0} disables the cache. | 0 (Disabled) or Integer | 5 |
| prepareThreshold | Statement prepare threshold. A value of {@code -1} stands for forceBinary | -1 (force binary transfer) Integer | 5 |
| Profile | The AWS profile name for credentials | String | - |
| protocolVersion | The driver supports the V3 frontend/backend protocols. The V3 protocol was introduced in 7.4 and the driver will by default try to connect using the V3 protocol. | Integer | - |
| providerName | The name of the Redshift Native Auth Provider | String | - |
| queryGroup | Assign a query to a queue at runtime by assigning your query to the appropriate query group | String | - |
| raiseExceptionOnSilentRollback | Certain database versions perform a silent rollback instead of commit in case the transaction was in a failed state | Boolean | - |
| readOnly | Puts this connection in read-only mode | Boolean | false |
| readOnlyMode | Controls the behavior when a connection is set to be read only, one of 'ignore', 'transaction', or 'always'\n + When 'ignore', setting readOnly has no effect.\n + When 'transaction' setting readOnly to 'true' will cause transactions to BEGIN READ ONLY if autocommit is 'false'.\n + When 'always' setting readOnly to 'true' will set the session to READ ONLY if autoCommit is 'true'\n + and the transaction to BEGIN READ ONLY if autocommit is 'false'. | String | transaction |
| receiveBufferSize | Socket read buffer size | Integer | -1 |
| Region | The AWS region where the cluster is located | String | null |
| replication | Connection parameter passed in startup message, one of 'true' or 'database' Passing 'true' tells the backend to go into walsender mode, wherein a small set of replication commands can be issued instead of SQL statements. Only the simple query protocol can be used in walsender mode. Passing 'database' as the value instructs walsender to connect to the database specified in the dbname parameter, which will allow the connection to be used for logical replication from that database. (backend >= 9.4) | String (true and database) | false |
| reWriteBatchedInserts | Enable optimization to rewrite and collapse compatible INSERT statements that are batched. | Boolean | false |
| reWriteBatchedInsertsSize | Enable optimization size to rewrite and collapse compatible INSERT statements that are batched. This must be power of 2 | Integer | 128 |
| SecretAccessKey | The IAM secret key for the IAM user or role | String | - |
| sendBufferSize | Socket write buffer size | Integer | -1 |
| SessionToken | The IAM security token for an IAM user or role | String | - |
| socketFactory | Specify a socket factory for socket creation | String | - |
| socketFactoryArg | Argument forwarded to constructor of SocketFactory class. | String | - |
| socketTimeout | The timeout value used for socket read operations. | Integer | 0 |
| ssl | Control use of SSL (any non-null value causes SSL to be required) | String ( TRUE and FALSE ) | TRUE |
| sslcert | The location of the client's SSL certificate | String | - |
| sslfactory | Provide a SSLSocketFactory class when using SSL. | String | - |
| sslfactoryarg | Argument forwarded to constructor of SSLSocketFactory class. | String | - |
| sslhostnameverifier | A class, implementing javax.net.ssl.HostnameVerifier that can verify the server | String | org.postgresql.ssl.PGjdbcHostnameVerifier |
| sslkey | The location of the client's PKCS#8 SSL key | String | - |
| sslmode | Parameter governing the use of SSL | String (disable , allow , prefer , require , verify-ca and verify-full . require , allow and prefer) | verify-ca |
| sslpassword | The password for the client's ssl key (ignored if sslpasswordcallback is set) | String | 0 |
| sslpasswordcallback | A class, implementing javax.security.auth.callback.CallbackHandler that can handle PassworCallback for the ssl password. | String | org.postgresql.ssl.jdbc4.LibPQFactory.ConsoleCallbackHandler |
| sslrootcert | The location of the root certificate for authenticating the server. | String | - |
| SSLTruststore | The SSL Truststore password key. | String | - |
| SSLTrustStorePath | The SSL Truststore path key. | String | - |
| sspiServiceClass | The Windows SSPI service class for SPN | String | POSTGRES |
| stringtype | The type to bind String parameters as (usually 'varchar', 'unspecified' allows implicit casting to other types) | String | null |
| StsEndpointUrl | The STS endpoint url | String | - |
| targetServerType | Specifies what kind of server to connect. The primary/secondary distinction is currently done by observing if the server allows writes. The value preferSecondary tries to connect to secondary if any are available, otherwise allows falls back to connecting also to primary. The value preferPrimary tries to connect to primary if it is available, otherwise allows falls back to connecting to secondaries available. | String (any, primary, master, slave, secondary, preferSlave, preferSecondary, preferPrimary) | any |
| tcpKeepAlive | Enable or disable TCP keep-alive. The default is {@code false}. | String ( TRUE, FALSE ) | TRUE |
| uid | Username to connect to the database as. | String | - |
| unknownLength | Specifies the length to return for types of unknown length | Integer | Integer.MAX_VALUE |
| useSpnego | Use SPNEGO in SSPI authentication requests | Boolean | false |
| webIdentityToken | The Oauth access token for an idp connection | String | - |