Using MySQL with OpenShift Online

The mysql cartridge(s) provides MySQL on OpenShift. MySQL is an open-source relational database management system. With OpenShift you can easily deploy and run applications backed by MySQL using your favorite servers and frameworks. OpenShift Online currently supports MySQL 5.1 and 5.5.

The MySQL Cartridge

Environment Variables

The mysql cartridge provides several environment variables to reference for ease of use:

Variable	Description
OPENSHIFT_MYSQL_DB_HOST	The MySQL server IP address
OPENSHIFT_MYSQL_DB_PORT	The MySQL server port
OPENSHIFT_MYSQL_DB_USERNAME	MySQL username credential
OPENSHIFT_MYSQL_DB_PASSWORD	MySQL password credential
OPENSHIFT_MYSQL_DB_URL	MySQL server configuration url (mysql://OPENSHIFT_MYSQL_DB_USERNAME:OPENSHIFT_MYSQL_DB_PASSWORD@OPENSHIFT_MYSQL_DB_HOST:OPENSHIFT_MYSQL_DB_PORT)
OPENSHIFT_MYSQL_DB_SOCKET	MySQL socket connection file
OPENSHIFT_MYSQL_DB_LOG_DIR	The path to the MySQL log directory
OPENSHIFT_MYSQL_VERSION	The version of the MySQL server
OPENSHIFT_MYSQL_TIMEZONE	The MySQL server timezone
OPENSHIFT_MYSQL_LOWER_CASE_TABLE_NAMES	Sets how the table names are stored and compared
OPENSHIFT_MYSQL_DEFAULT_STORAGE_ENGINE	The default storage engine (table type)
OPENSHIFT_MYSQL_MAX_CONNECTIONS	The maximum permitted number of simultaneous client connections
OPENSHIFT_MYSQL_FT_MIN_WORD_LEN	The minimum length of the word to be included in a FULLTEXT index.
OPENSHIFT_MYSQL_FT_MAX_WORD_LEN	The maximum length of the word to be included in a FULLTEXT index.
OPENSHIFT_MYSQL_AIO	Controls the 'innodb_use_native_aio' setting value in case the native AIO is broken. See http://help.directadmin.com/item.php?id=529

Variable

Description

OPENSHIFT_MYSQL_DB_HOST

The MySQL server IP address

OPENSHIFT_MYSQL_DB_PORT

The MySQL server port

OPENSHIFT_MYSQL_DB_USERNAME

MySQL username credential

OPENSHIFT_MYSQL_DB_PASSWORD

MySQL password credential

OPENSHIFT_MYSQL_DB_URL

MySQL server configuration url (mysql://OPENSHIFT_MYSQL_DB_USERNAME:OPENSHIFT_MYSQL_DB_PASSWORD@OPENSHIFT_MYSQL_DB_HOST:OPENSHIFT_MYSQL_DB_PORT)

OPENSHIFT_MYSQL_DB_SOCKET

MySQL socket connection file

OPENSHIFT_MYSQL_DB_LOG_DIR

The path to the MySQL log directory

OPENSHIFT_MYSQL_VERSION

The version of the MySQL server

OPENSHIFT_MYSQL_TIMEZONE

The MySQL server timezone

OPENSHIFT_MYSQL_LOWER_CASE_TABLE_NAMES

Sets how the table names are stored and compared

OPENSHIFT_MYSQL_DEFAULT_STORAGE_ENGINE

The default storage engine (table type)

OPENSHIFT_MYSQL_MAX_CONNECTIONS

The maximum permitted number of simultaneous client connections

OPENSHIFT_MYSQL_FT_MIN_WORD_LEN

The minimum length of the word to be included in a FULLTEXT index.

OPENSHIFT_MYSQL_FT_MAX_WORD_LEN

The maximum length of the word to be included in a FULLTEXT index.

OPENSHIFT_MYSQL_AIO

Controls the 'innodb_use_native_aio' setting value in case the native AIO is broken. See http://help.directadmin.com/item.php?id=529

→ Learn more about OpenShift Environment Variables

Example Use

Getting a PHP app with a MySQL backend deployed onto OpenShift is as easy as executing two commands:

$ rhc app create MyApp php-5.4
$ rhc cartridge add mysql-5.5 -a MyApp

These two commands create your "server" and install and configure PHP, MySQL, and a git repository on the server. You can now visit your application on the web at:

http://MyApp-MyDomain.rhcloud.com/

phpMyAdmin

The phpmyadmin cartridge provides phpMyAdmin on OpenShift. In order to add this cartridge to an application, the MySQL cartridge must already be present. Once installed, phpMyAdmin can be used by navigating to http://app-domain.rhcloud.com/phpmyadmin with the MySQL login credentials.