Skip to content

Latest commit

 

History

History
169 lines (93 loc) · 4.92 KB

README.md

File metadata and controls

169 lines (93 loc) · 4.92 KB
Raw

pgjdbc-ng Build Status

A new JDBC driver for PostgreSQL aimed at supporting the advanced features of JDBC and Postgres

http://impossibl.github.io/pgjdbc-ng

Connection format

The connection format for the pgjdbc-ng driver is

jdbc:pgsql://<server>[:<port>]/<database>

An example

jdbc:pgsql://localhost:5432/test

Driver

The java.sql.Driver class is

com.impossibl.postgres.jdbc.PGDriver

The driver will accept configuration parameters in the style of

jdbc:pgsql://localhost:5432/test?applicationName=MyApp&networkTimeout=10000

Data sources

The javax.sql.DataSource class is

com.impossibl.postgres.jdbc.PGDataSource

, the javax.sql.ConnectionPoolDataSource class is

com.impossibl.postgres.jdbc.PGConnectionPoolDataSource

and the XADataSource class is

com.impossibl.postgres.jdbc.xa.PGXADataSource

Configuration

The driver and data sources supports the following configuration properties (name, type and default value).

host      (String) localhost

The 'host' parameter specifies the host name of the database server. Data sources only.

port         (int)     5432

The 'port' parameter specifies the port number of the database server. Data sources only.

database     (String)

The 'database' parameter specifies the name of the database on the database server. Data sources only.

user   (String)

The 'user' parameter specifies the user name.

password     (String)

The 'password' parameter specifies the password.

housekeeper      (boolean) true

The 'housekeeper' parameter specifies if the JDBC driver should keep track connections, statements and result sets and automatically close them if they can't no longer be reached.

parsedSqlCacheSize   (int)   250

The 'parsedSqlCacheSize' parameter specifies how big the cache size for parsed SQL statements should be.

preparedStatementCacheSize (int)     50

The 'preparedStatementCacheSize' parameter specifies how big the cache size for PreparedStatement instaces should be.

applicationName          (String)  pgjdbc app

The 'applicationName' parameter specifies the application name associated with the connection on the database server.

clientEncoding          (String)  UTF8

The 'clientEncoding' parameter specifies the client encoding for the database server.

networkTimeout         (int)     0

The 'networkTimeout' parameter specifies the default timeout in milliseconds for the connections. A value of 0 indicates that there isnt a timeout for database operations.

strictMode          (boolean)  false

The 'strictMode' parameter specifies if the JDBC driver should follow behavior assumed by certain frameworks, and test suites. See http://github.com/impossibl/pgjdbc-ng/wiki/StrictMode for additional details.

defaultFetchSize         (int)     0

The 'defaultFetchSize' parameter specifies the default fetch size for statements.

receiveBufferSize         (int)     -1

The 'receiveBufferSize' parameter specifies the size of the receive buffer for the connection.

sendBufferSize         (int)     -1

The 'sendBufferSize' parameter specifies the size of the send buffer for the connection.

SSL                 (boolean)  false

Enable SSL for data sources.

ssl.mode          (String)

The 'ssl.mode' parameter specifies which SSL mode that should be used to connect to the database server. Valid values include 'prefer', 'require', 'verify-ca' and 'verify-full'. Data source property is 'SSLMode'.

ssl.password          (String)

The 'ssl.password' parameter specifies the SSL password. Data source property is 'SSLPassword'.

ssl.cert.file          (String)

The 'ssl.cert.file' parameter specifies the SSL certificate file as a path. Data source property is 'SSLCertificateFile'.

ssl.key.file          (String)

The 'ssl.key.file' parameter specifies the SSL key file as a path. Data source property is 'SSLKeyFile'.

ssl.root.cert.file          (String)

The 'ssl.root.cert.file' parameter specifies the SSL root certificate file as a path. Data source property is 'SSLRootCertificateFile'.

License

pgjdbc-ng is released under the 3 clause BSD license.

Building

The driver is built with maven. Simply build with:

mvn clean package

This will produce, in the target directory, two JAR files. One with dependencies packaged inside and another without.

Testing

The unit tests need a PostgreSQL database to execute against. The tests assume theses defaults:

SERVER:     localhost
PORT:       5432
DATABASE:   test
USERNAME:   pgjdbc
PASSWORD:   test

The following system properties are supported in order to customize the setup

pgjdbc.test.server
pgjdbc.test.port
pgjdbc.test.db
pgjdbc.test.user
pgjdbc.test.password

If you'd like to build the driver without running the unit tests use the command:

mvn clean package -DskipTests