Connecting to PostgreSQL

The following properties can be specified when loading data from a PostgreSQL connection.

Not all properties listed here may be necessary when creating the data connection. However, at a minimum, basic information must be provided.

Basic Information

• Title - The name of the connection.

• Description - The description (optional) of the connection.

• Host - The IP address or host name of the storage system.

• Port - The network port number through which the storage system connects.

• Database - The name of the database containing the data to be added.

• Username - The user account used to authenticate access to the storage system.

• Password - The password corresponding to the user account.

PostgreSQL Options

• Adaptive Fetch - Specifies whether the number of rows fetched in ResultSet should be adaptve to maxResultBuffer and max row size.

• Adaptive Fetch Maximum - The maximum number of rows used by adaptive fetch.

• Adaptive Fetch Minimum - The minimum number of rows used by adaptive fetch.

• Allow Encoding Changes - Specifies whether changes in client_encoding are allowed.

• Application Name - The name of the application.

• Assume Min Server Version - The minimum server version to be assumed.

• Authentication Plugin Class Name - The name of the class implementing AuthenticationPlugin.

• Autosave - Specifies what the driver should do if a query fails (e.g., Always, Never, Conservative).

• Binary Transfer - Use binary format for sending and receiving data if possible

• Binary Transfer Disable - 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.

• Binary Transfer Enable - Comma separated list of types to enable binary transfer. Either OID numbers or names

• Cancel Signal Timeout - The timeout that is used for sending cancel command.

• Cleanup Savepoints - Determine whether SAVEPOINTS used in AUTOSAVE will be released per query or not

• Connect Timeout - The timeout value in seconds used for socket connect operations.

• Current Schema - Specify the schema (or several schema separated by commas) to be set in the search-path

• Database Metadata Cache Fields - Specifies the maximum number of fields to be cached per connection. A value of {@code 0} disables the cache.

• Database Metadata Cache Fields MiB - Specifies the maximum size (in megabytes) of fields to be cached per connection. A value of {@code 0} disables the cache.

• Default Row Fetch Size - Positive number of rows that should be fetched from the database when more rows are needed for ResultSet by each fetch iteration

• Disable Column Sanitiser - Enable optimization that disables column name sanitiser

• Escape Syntax Call Mode - 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).

• Group Startup Parameters - This is important in pool-by-transaction scenarios in order to make sure that all the statements reaches the same connection that is being initialized.

• GSS Enc Mode - Force Encoded GSS Mode

• G SSL Ib - Force SSSPI or GSSAPI

• GSS Response Timeout - Time in milliseconds we wait for a response from the server after requesting a GSS upgrade

• Hide Unprivileged Objects - Enable hiding of database objects for which the current user has no privileges granted from the DatabaseMetaData

• Host Recheck Seconds - Specifies period (seconds) after which the host status is checked again in case it has changed

• JAAS Application Name - Specifies the name of the JAAS system or application login configuration.

• JAAS Login - Login with JAAS before doing GSSAPI authentication

• Kerberos Server Name - The Kerberos service name to use when authenticating with GSSAPI.

• Load Balance Hosts - If disabled hosts are connected in the given order. If enabled hosts are chosen randomly from the set of suitable candidates

• Local Socket Address - Local Socket address, if set bind the client side of the socket to this address

• Logger File - File name output of the Logger

• Logger Level - Logger level of the driver

• Login Timeout - Specify how long in seconds to wait for establishment of a database connection.

• Log Server Error Detail - Include full server error detail in exception messages. If disabled then only the error itself will be included.

• Log Unclosed Connections - When connections that are not explicitly closed are garbage collected, log the stacktrace from the opening of the connection to trace the leak source

• Max Result Buffer - Specifies size of buffer during fetching result set. Can be specified as specified size or percent of heap memory.

• Options - Specify 'options' connection initialization parameter.

• Prefer Query Mode - 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.

• Prepared Statement Cache Queries - Specifies the maximum number of entries in per-connection cache of prepared statements. A value of {@code 0} disables the cache.

• Prepared Statement Cache Size MiB - Specifies the maximum size (in megabytes) of a per-connection prepared statement cache. A value of {@code 0} disables the cache.

• Prepare Threshold - Statement prepare threshold. A value of {@code -1} stands for forceBinary

• Protocol Version - Force use of a particular protocol version when connecting, currently only version 3 is supported.

• Quote Returning Identifiers - Quote identifiers provided in returning array

• Read Only - Puts this connection in read-only mode

• Read Only Mode - 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'.

• Receive Buffer Size - Socket read buffer size

• 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)

• Re Write Batched Inserts - Enable optimization to rewrite and collapse compatible INSERT statements that are batched.

• Send Buffer Size - Socket write buffer size

• Service - Service name to be searched in pg_service.conf resource

• Socket Factory - Specify a socket factory for socket creation

• Socket Factory Arg - Argument forwarded to constructor of SocketFactory class.

• Socket Timeout - The timeout value in seconds max(2147484) used for socket read operations.

• SSL - Control use of SSL (any non-null value causes SSL to be required)

• SSL Cert - The location of the client's SSL certificate

• SSL Factory - Provide a SSLSocketFactory class when using SSL.

• SSL Factory Arg - Argument forwarded to constructor of SSLSocketFactory class.

• SSL Hostname Verifier - A class, implementing javax.net.ssl.HostnameVerifier that can verify the server

• SSL Key - The location of the client's PKCS#8 SSL key

• SSL Mode - Parameter governing the use of SSL

• SSL Password - The password for the client's ssl key (ignored if sslpasswordcallback is set)

• SSL Password Callback - A class, implementing javax.security.auth.callback.CallbackHandler that can handle PasswordCallback for the ssl password.

• SSL Response Timeout - Time in milliseconds we wait for a response from the server after requesting SSL upgrade

• SSL Root Cert - The location of the root certificate for authenticating the server.

• SSPI Service Class - The Windows SSPI service class for SPN

• String Type - The type to bind String parameters as (usually 'varchar', 'unspecified' allows implicit casting to other types)

• Target Server Type - Specifies what kind of server to connect

• TCP Keep Alive - Enable or disable TCP keep-alive. The default is {@code false}.

• TCP No Delay - Enable or disable TCP no delay. The default is (@code true}.

• Unknown Length - Specifies the length to return for types of unknown length

• Use Spnego - Use SPNEGO in SSPI authentication requests

• Xml Factory - Factory class to instantiate factories for XML processing

Additional Options

Connection Properties

• Property Name - The name of a connection property.
• Property Value - The value of the connection property.

Encrypted Properties

• Encrypted Property Name - The name of an encrypted property.
• Encrypted Property Value - The value of the encrypted connection property.

Advanced

Concurrency Control

• Maximum Allowed Concurrency - The overall limit on concurrent executions used to process the source.
• Number of Nodes - The number of nodes to use when processing the source.
• Executors per Node - The number of executors to use per node when processing the source.
• Maximum Request Rate - The maximum aggregate request rate against the source (e.g., 100 / s, 480 / minute).

Localization Settings

• Locale - The locale to use when parsing dates and numbers (e.g., ar-SA, en-US, ja-JP).
• Character Encoding - The default character encoding used by the connection (e.g., EBCDIC, UTF-8).
• Timezone - The timezone to use for dates and times that don't contain one (e.g., GMT+2, PST).

Data Formats

• Recognize only the configured formats - Specifies whether only those formats configured here should be recognized.
• DateTime Formats - How date and time values should be encoded (e.g., yyyy-MM-dd'T'HH:mm:ss, MM/dd/yyyy HH:mm, dd-MMM-yyyy HH:mm:ss).
• Date Formats - How calendar dates without time information should be encoded (e.g., yyyy-MM-dd, MM/dd/yyyy, dd-MMM-yyyy).
• Time Formats - How time-of-day values should be encoded (e.g., HH:mm:ss, hh:mm a, HH:mm:ss.SSS).
• Boolean Formats - How true/false or binary logical values should be encoded (e.g., true/false, 1/0, Y/N).
• Double Formats - How double-precision floating values should be encoded (e.g., ##,##0.00, $, %).
• Float Formats - How single-precision floating-point values should be encoded (e.g., ##,##0.00, %, e).
• Integer Formats - How whole numbers should be encoded (e.g., #, #,###,##0).
• Long Formats - How long integer values exceeding the range of standard integers should be encoded (e.g., #, #,###,##0).
• Month Formats - How standalone month values should be encoded (e.g., MM, MMMM).
• Year Month Formats - How combined month and year values should be encoded (e.g., yyyy MM, yyyy-MMM).
• Month Day Formats - How combined month/day values should be encoded (e.g., MM-dd, MMM dd, MM/dd)
• Year Formats - How standalone year values are encoded (e.g., yyyy, YY).