Connect Bamboo to an Oracle database

This page describes how to connect Bamboo to an Oracle database.

Bamboo provides two ways to connect to an Oracle database: using JDBC or using a datasource. We recommend to use JDBC because this method is simpler.

See Supported platforms for other information about the versions of Oracle supported by Bamboo.

On this page:


Important

  • For JDBC or JNDI connections, please ensure that the user connecting to the database will have total permissions. This includes the DBMS_LOB package and other resources available.

Install Oracle

If you don't already have an operational Oracle server, download and install it now. See the Oracle documentation for instructions. 

When setting up your Oracle server:

  • Character encoding must be set to AL32UTF8 (this is the Oracle equivalent of Unicode UTF-8).
  • Collation should be set to BINARY.

Configuring Oracle

  1. Ensure that you have a database instance available for Bamboo (either create a new one or use an existing one).
  2. Within that database instance, create a user whom Bamboo will connect (for example: bamboo-user). (tick) Remember this database user name, as it will be used to configure Bamboo's connection to this database.

    When you create a user in Oracle, Oracle will create a 'schema' automatically.
    create user bamboo-user identified by password;
    
  3. Ensure that the user has the following permissions:

    grant connect, resource, create table to bamboo-user;
    

Connecting using JDBC

The JDBC drivers for Oracle Server are no longer bundled with Bamboo due to licensing restrictions. You need to download and install the driver yourself.

Download and install the JDBC driver

To download and install the JDBC driver:

  1. Take a backup of the ojdbc8.jar file from the following location: <Bamboo installation directory>/lib
  2. Download the Oracle JDBC driver ojdbc8.jar from the Oracle download site.
  3. Copy the ojdbc8.jar file from the extracted directory to the {{ <Bamboo installation directory>/lib  }}directory
    If the lib/ directory doesn't exist, you can create it.

    If you are using the Java Service Wrapper, to start your Bamboo instance (Bamboo/wrapper/run-bamboo start), copy the ojdbc8.jar file to the <Bamboo installation directory> /wrapper/lib directory.
  4. Stop Bamboo on WindowsLinux, or Mac.
  5. Restart Bamboo on WindowsLinux, or Mac.

Connect Bamboo to an Oracle database using JDBC

To connect Bamboo to an Oracle database using JDBC:

  1. Run the Setup Wizard and choose the Custom Installation method.
  2. At the 'Choose a Database Configuration' step, choose External Database > Oracle.
  3. Select Direct JDBC connection and complete the form:

    Driver Class Name

    Type: oracle.jdbc.driver.OracleDriver

    Database URL
    Type the URL where Bamboo will access your database, e.g. jdbc:oracle:thin:@localhost:1521:SID. For syntax, please see the Oracle documentation.

    Username
    Type the username that Bamboo will use to access your database.

    Password
    Type the password that Bamboo will use to access your database.

  4. Select Overwrite existing data if you wish Bamboo to overwrite any tables that already exist in the database.
  5. Select Continue.

Screenshot: Setup JDBC Connection (Oracle)

Connecting 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 the Oracle documentation.
  2. Run the Setup Wizard and choose the Custom Installation method.
  3. At the 'Choose a Database Configuration' step, choose External Database > Oracle.
  4. Select Connect using a datasource (configured in the application server)
  5. In the JNDI name field, type the JNDI name of your datasource, as configured in your application server.

    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. Select Continue.

Screenshot Setup Datasource Connection

Last modified on Oct 11, 2023

Was this helpful?

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