The Database Configuration screen enables you to create and configure databases using the embedded HyperSQL server or connect to an external MySQL or Oracle database. You can also create and restore database backups, as well as port existing backups to a different type of database. For example, you could back up a HyperSQL database, then re-create it as an Oracle or MySQL database. Or, you could capture the current state of a database and use that for a rollback. 

Choose Database Configuration from the administration menu (gear icon) to open the Database Configuration screen.

In this section:

Connecting to an Existing Database

  1. Choose the database software from the Type menu.
  2. Specify the settings for connecting to your database. See Database Settings below.
  3. Click Test Connection to verify the settings. Contact your database administrator if you have trouble using the settings you specified.
  4. Click Save to complete the configuration.

Creating a New Database

  1. Click Create Database in the Database Connection Settings section. 
  2. Choose the database software from the Type menu.
  3. Specify the settings for connecting to your database. See Database Settings below. Alternatively, you could create a database from a backup file (see to Creating a Database from a Backup).
  4. Enable the Create a new user option if you want to create a new user with access to the database.
  5. Click Create 

Creating a Backup

  1. Click Backup Database in the Database Connection Settings section.
  2. Click the file link when prompted to download the backup file.

Backing Up Databases with Large Files (MySQL Only)

If you are using a MySQL database and the backup fails, try increasing the MySQL size limits as follows:

  1. Find the my.cnf/my.ini file for your installation of MySQL. For MySQL 5.7, see http://dev.mysql.com/doc/refman/5.7/en/option-files.html. For other versions, see the appropriate manual at http://dev.mysql.com/doc/index.html.
  2. Edit the file to use the parameter settings outlined below.
  3. Restart the MySQL Service 

[mysqld]

  • innodb = ON
  • innodb_log_file_size = 5242880000 // This must be set to be 10x the largest content being loaded for the public marketplace.
  • max_allowed_packet = 1G
  • innodb_file_per_table = 1
  • innodb_file_format = Barracuda 

[mysql]

  • max_allowed_packet = 1G 

[client]

  • max_allowed_packet = 1G

Creating a Database from a Backup

  1. Click Create Database in the Database Connection Settings section.
  2. Specify information about the new database  
  3. Browse for a backup file In the Create from Backup File section and click Create.

A new database will be created in the specified location then it will be populated with the data saved in the backup file. After a new database is successfully created, CTP will ask you if you want it to delete the previous database (the database whose connection settings are shown in the main page behind the dialog).

Adding Multiple Databases

To add multiple databases of the same type, specify a different location (for example, schema, SID, service name, or path) when creating a new database. This prevents the existing database from being overwritten. 

  • HyperSQL: Enter a new file path.
  • MySQL: Enter a new schema.
  • Oracle: Enter a new SID or service name.

To port a database to a different database type, select the target database type, then specify the desired location for the new database.

To create a new database account from this interface, enter the desired username and password, enable Create a new user, then confirm the password. For new accounts on Oracle, you can also specify a data tablespace and temp tablespace or you can leave those fields empty to use the defaults (<USER>_DATA> and <USER_TEMP>).

Current Configuration

You can view the current database configuration in this section. 

Database Table Limits

Messages received by CTP's underlying Virtualize server are logged in the database. The event message, payload, hit statistics, and time information are stored. You can change the number of event messages and entries about each hit to the server in this section.

 

Database Settings

See System Requirements for details about supported database versions and requirements.

HyperSQL Settings

CTP ships with an embedded HyperSQL database. To use it, choose File path as the connection mode.

  • Connection mode: Choose whether to connect using File path or JDBC URL. The connection configuration field that appears depends on your selection.
    • File path: Specify the where the database files should be saved. The files should be saved on the Apache Tomcat host.  Prepend a forward slash ‘/’ to make the path absolute in the file system. 
    • JDBC URL:  Specify the JDBC URL used to connect to your database. Example JDBC URL:
      jdbc:hsqldb:file:/hsqldb/em;ifexists=true
  • Username: Specify a user that will be able to access to the database. Default is the em user. If the Create a new user option is enabled, a new user with the name specified in this field will be added to the database.
  • Password: Specify the password for the user that will be able to access the database. Default is the password for the em user. If the Create a new user option is enabled, a new user with the password specified in this field will be added to the database. 

MySQL and MariaDB Settings

  • Connection mode: Choose whether to connect using Host and port or JDBC URL. The connection configuration fields that appear depends on your selection.
    • Host and port:
      • Host: Specify the host where the MySQL server is installed.
      • Port: Specify the port on the host through which the MySQL database is running.
      • Schema: Specify the name of the schema (database) that should contain the data. Default is em.
    • JDBC URL:
      • JDBC URL: Specify the JDBC URL used to connect to your database. Example JDBC URLs:
        jdbc:mariadb://hostname:3306?useUnicode=true&characterEncoding=UTF-8&sessionVariables=sql_mode=NO_BACKSLASH_ESCAPES
        jdbc:mysql://hostname:3306?useUnicode=true&characterEncoding=UTF-8&sessionVariables=sql_mode=NO_BACKSLASH_ESCAPES&useSSL=false&allowPublicKeyRetrieval=true
  • Username: Specify a user that will be able to access to the database. Default is the em user. If the Create a new user option is enabled, a new user with the name specified in this field will be added to the database.
  • Password: Specify the password for the user that will be able to access the database. Default is the password for the em user. If the Create a new user option is enabled, a new user with the password specified in this field will be added to the database.

Oracle Settings

  • Connection mode: Choose whether to connect using Host and port or JDBC URL. The connection configuration fields that appear depends on your selection.
    • Host and port:
      • Host: Specify the host where the Oracle server is installed.
      • Port: Specify the port on the host through which the Oracle database is running.
      • Use service name: Enable this option if you want to connect to the Oracle database using the service name. Specify the service name in the field provided. Enabling this option disables the SID field.
      • SID: Specify the SID of the Oracle database if you want to connect using the SID. Enabling the User service name option disables the SID field.
    • JDBC URL:
      • JDBC URL: Specify the JDBC URL used to connect to your database. Example JDBC URLs:
        jdbc:oracle:thin:@//hostname:1521/service_name
        jdbc:oracle:thin:@//hostname:1521:sid
        jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=hostname)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=service_name)))
  • Username: Specify the name of the schema (database) that should contain the data. Default is em.
  • Password: Specify the password for the user that will be able to access the database. Default is the password for the em user. If the Create a new user option is enabled, a new user with the password specified in this field will be added to the database.

JDBC Driver

CTP does not ship with JDBC driver libraries for MySQL or Oracle. Refer to the JDBC Driver Notes in the installation guide for additional information.

If the Oracle database user is created outside of CTP by a Database Administrator (DBA), then it needs permission to create tables so CTP can perform database schema updates when upgrading to new product versions.  The DBA should execute:  GRANT CREATE TABLE TO EM; where EM is the Oracle database user account that CTP will use when running.


Also see Installing and Running CTP.

  • No labels

Need assistance? Visit our support page