How do I connect Bamboo to an unsupported database type

We strongly recommend that you use Bamboo with one of the databases that we support (see Supported platforms for details). However, if you wish to connect Bamboo to an unsupported database, you can do so using the instructions below.

First, choose one of the following methods by which you will connect to your database:

  • Connecting using JDBC
  • Connecting using a datasource.

Then follow the instructions for that method. Note that using JDBC is generally simpler, and is therefore the recommended method.

This setting will not Bamboo connect to deprecated database version.

Connecting using JBDC


To connect Bamboo to an unsupported database, using JDBC:

  1. Put the appropriate JDBC driver jar file into your application server's classpath by copying the jar file into the webapp/WEB-INF/lib directory.
  2. Set the following system property before starting your upgraded Bamboo server to enable "Unsupported Database" as a selectable option in the Setup Wizard:
    -Dbamboo.enable.unsupported.db=true
  3. At Step 2 of the Bamboo Setup Wizard, choose External Database > Unsupported Database.
  4. In the 'Select Database Connection' screen, choose Direct JDBC connection.
  5. In the 'Setup JDBC Connection' screen, make the following settings:

    Driver Class Name
    The classname of your JDBC driver (consult your JDBC driver documentation for details).

    Database URL
    The URL where Bamboo will access your database (consult your JDBC driver documentation for details).

    UserName
    The username that Bamboo will use to access your database.

    Password
    The password (if required) that Bamboo will use to access your database.

    Hibernate Dialect
    The Hibernate dialect for your particular database. Using these databases is not recommended as there is no guarantee that they will operate correctly with Bamboo. Please consider using a supported database instead.

  6. Select Overwrite existing data if you wish Bamboo to overwrite any tables that already exist in the database.
  7. Go to Step 3 of the Setup Wizard.

Connecting using a datasource

To connect Bamboo to an unsupported database, using a datasource:

  1. Configure a datasource in your application server (consult your application server documentation for details). For the syntax of the JDBC URL to use, please see your JDBC driver documentation.
  2. Set the following system property before starting your upgraded Bamboo server to enable "Unsupported Database" as a selectable option in the Setup Wizard:
    -Dbamboo.enable.unsupported.db=true
  3. At Step 2 of the Bamboo Setup Wizard, choose External Database > Unsupported Database from the list.
  4. In the 'Select Database Connection' screen, select Connect via a datasource (configured in the application server).
  5. The 'Setup Datasource Connection' screen is displayed.  In the JNDI name field, type the JNDI name of your datasource, as configured in your application server.
    (warning) If java:comp/env/jdbc/DataSourceName doesn't work, try jdbc/DataSourceName (and vice versa).
  6. Select Overwrite existing data if you wish Bamboo to overwrite any tables that already exist in the database.
  7. Go to Step 3 of the Setup Wizard.
Last modified on Aug 14, 2020

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.