Index
Downloads (PDF, HTML & XML formats)
[Bamboo Knowledge Base Home]
Documentation for Bamboo 4.2.x. Documentation for other versions of Bamboo is available too.
These instructions will help you connect Bamboo to a MySQL 5.1 database.
(Neither MySQL 4.1 nor 5.0 are supported databases for use with Bamboo.)
Please note, the JDBC driver for MySQL 5.1 (JDBC Connector/J 5.1) is bundled with Bamboo. You do not have to download and install the driver.
On this page:
To connect Bamboo to an external MySQL database, you must first create and configure it. This database must be configured to use:
utf8
character set encoding, instead of latin1
utf8_bin
collationIf your MySQL database server is configured to use a storage engine other than InnoDB by default (such as MyISAM), then if possible change it to use InnoDB. Otherwise, you can configure Bamboo's JDBC connection to your MySQL database so that any tables which Bamboo creates in this database will be done using the InnoDB database engine.
A MySQL database administrator can easily create and configure a MySQL database for Bamboo by running the following MySQL commands:
mysql> CREATE DATABASE bamboo CHARACTER SET utf8 COLLATE utf8_bin; mysql> GRANT ALL PRIVILEGES ON bamboo.* TO 'bamboouser'@'localhost' IDENTIFIED BY 'password'; mysql> FLUSH PRIVILEGES; mysql> QUIT
This creates an empty MySQL database for Bamboo named bamboo
.
Please Note:
bamboouser
— the user account name for the Bamboo MySQL databaselocalhost
— the host name of the MySQL database serverpassword
— the password for this user accountlocalhost
and not set a password by omitting IDENTIFIED BY 'password'
from the 2nd MySQL statement above (if you trust the security within this computer).For more information about configuring character set encoding and collation for Bamboo MySQL databases, please refer to the MySQL 5 documentation — Specifying Character Sets and Collations.
Bamboo provides two ways to connect to a MySQL database — via JDBC or via a datasource. JDBC is generally simpler and is the recommended method.
To connect Bamboo to a MySQL database, via JDBC:
Ensure that Direct JDBC connection is selected and complete the following fields (as shown in the screenshot below):
Driver Class Name | Type com.mysql.jdbc.Driver (if different from the default). |
---|---|
Database URL | Type the URL where Bamboo will access your database (if different from the default). Your URL must include the autoReconnect=true flag.
|
User Name | Type the username that Bamboo will use to access your database. This is bamboouser defined in section 1 (above). |
Password | Type the password (if required) that Bamboo will use to access your database. This is password defined in section 1 (above). Leave this field blank if a password for the database user account was not specified. |
Click Continue.
Screenshot: Setup JDBC Connection (MySQL)
To connect Bamboo to a MySQL database, via a datasource:
Configure a datasource in your application server (consult your application server documentation for details). Please note the following:
Ensure that the JDBC URL which you configure in your application server includes the autoReconnect=true
, useUnicode=true
and characterEncoding=utf8
flags, such that your database URL should look similar to:jdbc:mysql://localhost/bamboo?autoReconnect=true&useUnicode=true&characterEncoding=utf8
If your MySQL database server is configured to use a storage engine other than InnoDB by default, also include the sessionVariables=storage_engine=InnoDB
flag in this URL.
If the autoReconnect flag is not set, the MySQL JDBC driver will eventually time out and Bamboo will no longer be able to communicate with the database.
For more information on the URL syntax, please see the MySQL documentation.
Datasource example: You can see an example of using Tomcat with a MySQL database as a datasource in the following document: Tomcat and External MySQL Datasource Example.
Run the Setup Wizard and choose the Custom Installation method.
On the 'Choose a Database Configuration' page, choose External Database > MySQL 5.1 from the list and click Continue. The 'Database Configuration' page appears.
Choose Connect via a datasource (configured in the application server) (as shown in the screenshot below).
In the JNDI name field, type the JNDI name of your datasource, as configured in your application server.If
java:comp/env/jdbc/DataSourceName
does not work, try jdbc/DataSourceName
(and vice versa).
Select Overwrite existing data if you wish Bamboo to overwrite any tables that already exist in the database.
Click Continue.
Screenshot 2: Setup Datasource Connection