The timeout value used for socket connect operations. If connecting to the server takes longer * than this value, the connection is broken.
* *The timeout is specified in seconds and a value of zero means that it is disabled.
*/ CONNECT_TIMEOUT( "connecttimeout", "10", "The timeout value used for socket connect operations."), /** * Specify the schema (or several schema separated by commas) to be set in the search-path. This schema will be used to resolve * unqualified object names used in statements over this connection. */ CURRENT_SCHEMA( "currentschema", null, "Specify the schema (or several schema separated by commas) to be set in the search-path"), /** * Specifies the maximum number of fields to be cached per connection. A value of {@code 0} disables the cache. */ DATABASE_METADATA_CACHE_FIELDS( "databasemetadatacachefields", "65536", "Specifies the maximum number of fields to be cached per connection. A value of {@code 0} disables the cache."), /** * Specifies the maximum size (in megabytes) of fields to be cached per connection. A value of {@code 0} disables the cache. */ DATABASE_METADATA_CACHE_FIELDS_MIB( "databasemetadatacachefieldsmib", "5", "Specifies the maximum size (in megabytes) of fields to be cached per connection. A value of {@code 0} disables the cache."), /** * Returns metadata for the connected database only. * Application is ready to accept metadata from all databases, * can set the value of this parameter "false". * Default value is "true" means application gets metadata from single * databases. */ DATABASE_METADATA_CURRENT_DB_ONLY( "databasemetadatacurrentdbonly", "true", "Control the behavior of metadata API to return data from all accessible databases or only from connected database"), /** * Default parameter for {@link java.sql.Statement#getFetchSize()}. A value of {@code 0} means * that need fetch all rows at once */ DEFAULT_ROW_FETCH_SIZE( "defaultrowfetchsize", "0", "Positive number of rows that should be fetched from the database when more rows are needed for ResultSet by each fetch iteration"), /** * Added for backward compatibility. * */ BLOCKING_ROWS_MODE( "blockingrowsmode", "0", "Positive number of rows that should be fetched from the database when more rows are needed for ResultSet by each fetch iteration"), /** * Enable optimization that disables column name sanitiser. */ DISABLE_COLUMN_SANITISER( "disablecolumnsanitiser", "false", "Enable optimization that disables column name sanitiser"), /** * This option specifies whether the driver submits a new database query when using the * Connection.isValid() method to determine whether the database connection is active. * * true: The driver does not submit a query when using Connection.isValid() to * determine whether the database connection is active. This may cause the driver * to incorrectly identify the database connection as active if the database server * has shut down unexpectedly. * * false: The driver submits a query when using Connection.isValid() to * determine whether the database connection is active. * When using the V3 protocol the driver monitors changes in certain server configuration * parameters that should not be touched by end users. The {@code client_encoding} setting is set * by the driver and should not be altered. If the driver detects a change it will abort the * connection. */ DISABLE_ISVALID_QUERY( "disableisvalidquery", "false", "Disable isValid query"), /** * The Redshift fetch rows using a ring buffer on a separate thread. * */ ENABLE_FETCH_RING_BUFFER("enablefetchringbuffer", "true", "The Redshift fetch rows using a ring buffer on a separate thread"), /** * Use generated statement name cursor for prepared statements. * */ ENABLE_GENERATED_NAME_FOR_PREPARED_STATEMENT("enablegeneratedname", "true", "The Redshift uses generated statement name and portal name"), /** * "true" means driver supports multiple SQL commands (semicolon separated) in a Statement object. * "false" means driver throws an exception when see multiple SQL commands. * Default value is "true". */ ENABLE_MULTI_SQL_SUPPORT( "enablemultisqlsupport", "true", "Control the behavior of semicolon separated SQL commands in a Statement"), /** * The statement cache enable/disable. * */ ENABLE_STATEMENT_CACHE("enablestatementcache", "false", "The Redshift statement cache using SQL as key"), /** * Specifies how the driver transforms JDBC escape call syntax into underlying SQL, for invoking procedures or functions. (backend >= 11) * In {@code escapeSyntaxCallMode=select} mode (the default), the driver always uses a SELECT statement (allowing function invocation only). * In {@code 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. * In {@code escapeSyntaxCallMode=call} mode, the driver always uses a CALL statement (allowing procedure invocation only). */ ESCAPE_SYNTAX_CALL_MODE( "escapesyntaxcallmode", "call", "Specifies how the driver transforms JDBC escape call syntax into underlying SQL, for invoking procedures or functions. (backend >= 11)" + "In escapeSyntaxCallMode=select mode (the default), the driver always uses a SELECT statement (allowing function invocation only)." + "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." + "In escapeSyntaxCallMode=call mode, the driver always uses a CALL statement (allowing procedure invocation only).", false, new String[] {"select", "callIfNoReturn", "call"}), /** * Specifies size of buffer during fetching result set. Can be specified as specified size or * percent of heap memory. */ FETCH_RING_BUFFER_SIZE( "fetchringbuffersize", "1G", "Specifies size of ring buffer during fetching result set. Can be specified as specified size or percent of heap memory."), /** * Force one of *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.
* *This mode is meant for debugging purposes and/or for cases when extended protocol cannot be used (e.g. logical replication protocol)
*/ PREFER_QUERY_MODE( "preferquerymode", "extended", "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.", false, new String[] {"extended", "extendedForPrepared", "extendedCacheEverything", "simple"}), /** * Specifies the maximum number of entries in cache of prepared statements. A value of {@code 0} * disables the cache. */ PREPARED_STATEMENT_CACHE_QUERIES( "preparedstatementcachequeries", "256", "Specifies the maximum number of entries in per-connection cache of prepared statements. A value of {@code 0} disables the cache."), /** * Specifies the maximum size (in megabytes) of the prepared statement cache. A value of {@code 0} * disables the cache. */ PREPARED_STATEMENT_CACHE_SIZE_MIB( "preparedstatementcachesizemib", "5", "Specifies the maximum size (in megabytes) of a per-connection prepared statement cache. A value of {@code 0} disables the cache."), /** * Sets the default threshold for enabling server-side prepare. A value of {@code -1} stands for * forceBinary */ PREPARE_THRESHOLD( "preparethreshold", "5", "Statement prepare threshold. A value of {@code -1} stands for forceBinary"), /** * Force use of a particular protocol version when connecting, if set, disables protocol version * fallback. */ PROTOCOL_VERSION( "protocolversion", null, "Force use of a particular protocol version when connecting, currently only version 3 is supported.", false, new String[] {"3"}), /** * Certain database versions perform a silent rollback instead of commit in case the transaction was in a failed state. */ RAISE_EXCEPTION_ON_SILENT_ROLLBACK( "raiseexceptiononsilentrollback", "false", "Certain database versions perform a silent rollback instead of commit in case the transaction was in a failed state"), /** * Puts this connection in read-only mode. */ READ_ONLY( "readonly", "false", "Puts this connection in read-only mode"), /** * Connection parameter to control behavior when * {@link Connection#setReadOnly(boolean)} is set to {@code true}. */ READ_ONLY_MODE( "readonlymode", "always", // transaction "Controls the behavior when a connection is set to be read only, one of 'ignore', 'transaction', or 'always' " + "When 'ignore', setting readOnly has no effect. " + "When 'transaction' setting readOnly to 'true' will cause transactions to BEGIN READ ONLY if autocommit is 'false'. " + "When 'always' setting readOnly to 'true' will set the session to READ ONLY if autoCommit is 'true' " + "and the transaction to BEGIN READ ONLY if autocommit is 'false'.", false, new String[] {"ignore", "transaction", "always"}), /** * Socket read buffer size (SO_RECVBUF). A value of {@code -1}, which is the default, means system * default. */ RECEIVE_BUFFER_SIZE( "receivebuffersize", "-1", "Socket read buffer size"), /** *Connection parameter passed in the startup message. This parameter accepts two values; "true" * and "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.
*Parameter should be use together with {@link RedshiftProperty#ASSUME_MIN_SERVER_VERSION} with * parameter >= 9.4 (backend >= 9.4)
*/ REPLICATION( "replication", null, "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)"), /** * Configure optimization to enable batch insert re-writing. */ REWRITE_BATCHED_INSERTS( "rewritebatchedinserts", "false", "Enable optimization to rewrite and collapse compatible INSERT statements that are batched."), /** * Configure optimization to batch insert size re-writing. * This must be power of 2. */ REWRITE_BATCHED_INSERTS_SIZE( "rewritebatchedinsertssize", "128", "Enable optimization size to rewrite and collapse compatible INSERT statements that are batched. This must be power of 2"), /** * Socket write buffer size (SO_SNDBUF). A value of {@code -1}, which is the default, means system * default. */ SEND_BUFFER_SIZE( "sendbuffersize", "-1", "Socket write buffer size"), /** * Socket factory used to create socket. A null value, which is the default, means system default. */ SOCKET_FACTORY( "socketfactory", null, "Specify a socket factory for socket creation"), /** * The String argument to give to the constructor of the Socket Factory. * @deprecated use {@code ..Factory(Properties)} constructor. */ @Deprecated SOCKET_FACTORY_ARG( "socketfactoryarg", null, "Argument forwarded to constructor of SocketFactory class."), /** * The timeout value used for socket read operations. If reading from the server takes longer than * this value, the connection is closed. This can be used as both a brute force global query * timeout and a method of detecting network problems. The timeout is specified in seconds and a * value of zero means that it is disabled. */ SOCKET_TIMEOUT( "sockettimeout", "0", "The timeout value used for socket read operations."), /** * Control use of SSL: empty or {@code true} values imply {@code sslmode==verify-full} */ SSL( "ssl", "true", "Control use of SSL (any non-null value causes SSL to be required)"), /** * File containing the SSL Certificate. Default will be the file {@code redshift.crt} in {@code * $HOME/.redshift} (*nix) or {@code %APPDATA%\redshift} (windows). */ SSL_CERT( "sslcert", null, "The location of the client's SSL certificate"), /** * Classname of the SSL Factory to use (instance of {@code javax.net.ssl.SSLSocketFactory}). */ SSL_FACTORY( "sslfactory", null, "Provide a SSLSocketFactory class when using SSL."), /** * The String argument to give to the constructor of the SSL Factory. * @deprecated use {@code ..Factory(Properties)} constructor. */ @Deprecated SSL_FACTORY_ARG( "sslfactoryarg", null, "Argument forwarded to constructor of SSLSocketFactory class."), /** * Classname of the SSL HostnameVerifier to use (instance of {@code * javax.net.ssl.HostnameVerifier}). */ SSL_HOSTNAME_VERIFIER( "sslhostnameverifier", null, "A class, implementing javax.net.ssl.HostnameVerifier that can verify the server"), /** * File containing the SSL Key. Default will be the file {@code redshift.pk8} in {@code * $HOME/.redshift} (*nix) or {@code %APPDATA%\redshift} (windows). */ SSL_KEY( "sslkey", null, "The location of the client's PKCS#8 SSL key"), /** * Parameter governing the use of SSL. The allowed values are {@code disable}, {@code allow}, * {@code prefer}, {@code require}, {@code verify-ca}, {@code verify-full}. * If {@code ssl} property is empty or set to {@code true} it implies {@code verify-full}. * Default mode is "require" */ SSL_MODE( "sslmode", null, "Parameter governing the use of SSL", false, new String[] {"disable", "allow", "prefer", "require", "verify-ca", "verify-full"}), /** * Added for backward compatibility. */ AUTH_MECH( "authmech", null, "Parameter governing the use of SSL. Alias for sslMode", false, new String[] {"disable", "allow", "prefer", "require", "verify-ca", "verify-full"}), /** * The SSL password to use in the default CallbackHandler. */ SSL_PASSWORD( "sslpassword", null, "The password for the client's ssl key (ignored if sslpasswordcallback is set)"), /** * The classname instantiating {@code javax.security.auth.callback.CallbackHandler} to use. */ SSL_PASSWORD_CALLBACK( "sslpasswordcallback", null, "A class, implementing javax.security.auth.callback.CallbackHandler that can handle PassworCallback for the ssl password."), /** * File containing the root certificate when validating server ({@code sslmode} = {@code * verify-ca} or {@code verify-full}). Default will be the file {@code root.crt} in {@code * $HOME/.redshift} (*nix) or {@code %APPDATA%\redshift} (windows). */ SSL_ROOT_CERT( "sslrootcert", null, "The location of the root certificate for authenticating the server."), /** * The SSL Truststore path key. */ SSL_TRUSTSTORE_PATH_KEY( "ssltruststorepath", null, "The SSL Truststore path key."), /** * The SSL Truststore path key. */ SSL_TRUSTSTORE_PWD_KEY( "ssltruststore ", null, "The SSL Truststore password key."), /** * Specifies the name of the SSPI service class that forms the service class part of the SPN. The * default, {@code REDSHIFT}, is almost always correct. */ SSPI_SERVICE_CLASS( "sspiserviceclass", "REDSHIFT", "The Windows SSPI service class for SPN"), /** * Bind String to either {@code unspecified} or {@code varchar}. Default is {@code varchar} for * 8.0+ backends. */ STRING_TYPE( "stringtype", "unspecified", "The type to bind String parameters as (usually 'varchar', 'unspecified' allows implicit casting to other types)", false, new String[] {"unspecified", "varchar"}), TARGET_SERVER_TYPE( "targetservertype", "any", "Specifies what kind of server to connect", false, new String [] {"any", "primary", "master", "slave", "secondary", "preferSlave", "preferSecondary"}), /** * Enable or disable TCP keep-alive. The default is {@code true}. */ TCP_KEEP_ALIVE( "tcpkeepalive", "true", "Enable or disable TCP keep-alive. The default is {@code true}."), /** * Specifies the length to return for types of unknown length. */ UNKNOWN_LENGTH( "unknownlength", Integer.toString(Integer.MAX_VALUE), "Specifies the length to return for types of unknown length"), /** * Username to connect to the database as. */ USER( "user", null, "Username to connect to the database as.", true), /** * Username to connect to the database as. It's an alias for the USER. */ UID( "uid", null, "Username to connect to the database as.", true), /** * Use SPNEGO in SSPI authentication requests. */ USE_SPNEGO( "usespnego", "false", "Use SPNEGO in SSPI authentication requests"), // IAM properties /** * The name of the Redshift cluster to connect to. * Used only by JDBC driver internally only. */ CLUSTER_IDENTIFIER("clusterid", null, "The name of the Redshift cluster to connect to"), /** * The length of time (in seconds) until the temporary IAM credentials expire. */ IAM_DURATION("iamduration", null, "The length of time (in seconds) until the temporary IAM credentials expire."), /** * The IAM access key id for the IAM user or role. */ IAM_ACCESS_KEY_ID("accesskeyid", null, "The IAM access key id for the IAM user or role"), /** * Indicates whether use IAM authentication. * Used only by JDBC driver internally only. */ IAM_AUTH("iamauth", "false", "Indicates whether use IAM authentication"), /** * Disable IAM credentials cache. * Enable cache gives protection against throttling API calls. * Default value is false. */ IAM_DISABLE_CACHE("iamdisablecache", "false", "Indicates to disable credential cache. Enable cache gives protection against throttling API calls"), /** * The AWS region where the cluster is located. * Used only by JDBC driver internally only. */ AWS_REGION("region", null, "The AWS region where the cluster is located"), /** * The Redshift endpoint url. * Used only AWS internal team. */ ENDPOINT_URL("endpointurl", null, "The Redshift endpoint url"), /** * The STS endpoint url. */ STS_ENDPOINT_URL("stsendpointurl", null, "The STS endpoint url"), /** * The AWS profile name for credentials. */ AWS_PROFILE("profile", null, "The AWS profile name for credentials"), /** * The IAM secret key for the IAM user or role. */ IAM_SECRET_ACCESS_KEY("secretaccesskey", null, "The IAM secret key for the IAM user or role"), /** * The IAM security token for an IAM user or role. */ IAM_SESSION_TOKEN("sessiontoken", null, "The IAM security token for an IAM user or role"), /** * The fully qualified class path for a class that implements AWSCredentialsProvider. */ CREDENTIALS_PROVIDER("plugin_name", null, "The fully qualified class path for a class that implements AWSCredentialsProvider"), /** * Indicates whether the user should be created if not exists. */ USER_AUTOCREATE("autocreate", null, "Indicates whether the user should be created if not exists"), /** * The database user name. */ DB_USER("dbuser", null, "The database user name"), /** * A comma delimited database group names. */ DB_GROUPS("dbgroups", null, "A comma delimited database group names"), /** * Regex for filtering out dbGroups. */ DB_GROUPS_FILTER("dbgroupsfilter", null, "Regex for filtering out dbGroups from final result"), /** * Forces database group names to be lower case. */ FORCE_LOWERCASE("forcelowercase", null, "Forces database group names to be lower case"), /** * Use the IDP Groups in the Redshift. * This is supported by new GetClusterCredentialsV2 API. * Default value is false for backward compatibility, which uses * STS API and GetClusterCredentials for user federation and explictily * specifying DbGroups in connection. */ GROUP_FEDERATION("groupfederation", "false", "Use the IDP Groups in the Redshift"), /** * The Oauth access token for an idp connection. */ WEB_IDENTITY_TOKEN("webidentitytoken", null, "The Oauth access token for an idp connection"), /** * The name of the Redshift Native Auth Provider. */ PROVIDER_NAME("providername", null, "The name of the Redshift Native Auth Provider"), /** * Set true when end point host is for serverless. * Driver auto detect from the given host. * For NLB, it won't so user can set explicitly. * Default value is false. */ IS_SERVERLESS("isserverless", "false", "Redshift end-point is serverless or provisional."), /** * The account ID of the serverless. * Driver auto detect from the given host. * For NLB, it won't so user can set explicitly. * Default value is null. * */ SERVERLESS_ACCT_ID("serverlessacctid", null, "The account ID of the serverless"), /** * The work group of the serverless. * Driver auto detect from the given host. * For NLB, it won't so user can set explicitly. * Default value is null. * */ SERVERLESS_WORK_GROUP("serverlessworkgroup", null, "The work group of the serverless"), ; private final String name; private final String defaultValue; private final boolean required; private final String description; private final String[] choices; private final boolean deprecated; private static final Set