framework-maria_db_jdbc.md

MariaDB JDBC Framework

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

Detection Criterion

Existence of a single bound MariaDB or MySQL service and NO provided MariaDB or MySQL JDBC jar. Existence of a MariaDB service is defined as the VCAP_SERVICES payload containing a service whose name, label or tag has mariadb as a substring. Existence of a MySQL service is defined as the VCAP_SERVICES payload containing a service whose name, label or tag has mysql as a substring. Existence of a MariaDB JDBC jar is defined as the application containing a JAR whose name matches mariadb-java-client*.jar Existence of a MySQL JDBC jar is defined as the application containing a JAR whose name matches mysql-connector-j*.jar

Tags

maria-db-jdbc=<version>

Tags are printed to standard output by the buildpack detect script

User-Provided Service (Optional)

Users may optionally provide their own MariaDB or MySQL service. A user-provided MariaDB or MySQL service must have a name or tag with mariadb or mysql in it so that the MariaDB 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/maria_db_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 MariaDB JDBC repository index (details).
version	The version of MariaDB JDBC to use. Candidate versions can be found in this listing.