Investigating Bamboo Database Schema

Still need help?

The Atlassian Community is here for you.

Ask the community

The purpose of this guide is to walk you through connecting to Bamboo's database using the Database Administration tool DBVisualizer. This will allow you to investigate the Bamboo database schema. 

On this page:


Read on for step by step instructions on how to Configure DbVisualizer and connect it to Bamboo's HSQLDB database.

Prerequisites

  1. Download and install the latest copy of DBVisualizer.
  2. Create a backup of your database, which you will connect to.
  3. If you're using HSQL Embedded database, ensure that Bamboo is not running or use DBVisualizer to connect to the backup of your database and not the actual production version.

Connection Procedure

Please ensure that you read and follow the instructions below carefully.


Ensure you create a backup (Administration > Backup) of your data before attempting any modifications.


Create the Database Connection

  1. Open Connection Wizard. 

    Screenshot: Opening the Connection Wizard
     

  2. Enter an identifiable name for the connection. For example: cruc1.6.6-std 

    Screenshot: Entering a Name for the Connection
     

  3. Click 'Next'.

Select a JDBC Driver

The example below assumes that you're trying to connect to HSQL database, if you're trying to connect to one of the External Databases, than please define a driver for the target databse


  1. From the drop down list select HSQLDB Embedded 

    Screenshot: Selecting a Database
     

  2. Click on Load Driver Files
  3. Browse to WEB-INF//lib directory where the hsqldb*.jar file is located.

Select the Database Path

  1. Browse to your <Bamboo-Home> directory if you are going to connect to your production database (Bamboo is shutdown), or Browse to your expanded <<Backup>> directory that was created when you unzipped the backup file you made (if you just want to run some queries against your data).
  2. Open the BAMBOO_HOME/database folder.
  3. Select the defaultdb.log file 

Enter the Connection Details

  1. Remove the .log from the end of defaultdb.log 

    Screenshot: Entering Connection Details
     

  2. Type in sa for the username.
  3. Leave the password field blank.
  4. Click on Test Connection to verify that the details are correct.
  5. Click on 'Finish' to complete the setup. 
    Refer to the example screenshot above if you are unsure

Connect to the Embedded Database

  1. Select the connection from the list on the left hand side. 

    If you're trying to connect to one of the External Databases then, select a different Database Type & Driver.

    Then specify a Database URL for your Database Type. You can look at your BAMBOO_HOME/bamboo.cfg.xml file if you aren't sure what DB Credentials/URL you should be using.


    Screenshot: Connecting to the Embedded Database
     

  2. You can now click on 'Connect' to connect to the embedded database. 

Viewing the Tables and their References

  1. Click on tables on the left and references in the middle to see an image that displays all tables and shows references.


Existing database schemas

Check out below the existing database schemas generated from a Bamboo instance:


Last modified on Mar 11, 2022

Was this helpful?

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