framework-postgresql_jdbc.md

PostgreSQL JDBC Framework

The PostgreSQL JDBC Framework causes a JDBC driver JAR to be automatically downloaded and placed on a classpath to work with a bound PostgreSQL Service. This JAR will not be downloaded if the application provides a PostgreSQL JDBC JAR itself.

Detection Criterion	Existence of a single bound PostgreSQL service and no provided PostgreSQL JDBC JAR. Existence of a PostgreSQL service is defined as the VCAP_SERVICES payload containing a service who's name, label or tag has postgres as a substring. Existence of a PostgreSQL JDBC JAR is defined as the application containing a JAR who's name matches postgresql-*.jar
Tags	postgresql-jdbc=<version>

Tags are printed to standard output by the buildpack detect script

User-Provided Service (Optional)

Users may optionally provide their own PostgreSQL service. A user-provided PostgreSQL service must have a name or tag with postgres in it so that the PostgreSQL JDBC Framework will automatically download the JDBC driver JAR and place it on the classpath.

Configuration

For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to Configuration and Extension.

The framework can be configured by modifying the config/postgresql_jdbc.yml file in the buildpack fork. The framework uses the Repository utility support and so it supports the version syntax defined there.

Name	Description
repository_root	The URL of the PostgreSQL JDBC repository index (details).
version	The version of PostgreSQL JDBC to use. Candidate versions can be found in this listing.