Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space FUNCTDEV and version SVC2025.2

...

  1. Click Configure Database Settings and select Create CTP database schema in the window that appears.
  2. Click Next.

  3. Select a database type: HyperSQL, MariaDB, MySQLOracle, or PostgreSQL.
  4. Enter the database URL and user credentials. See Database Settings below.
  5. Click Test Connection to confirm that it is correct.
  6. Click Create Schema.

Database Backups

Creating a Database Backup
Anchor
BackUpDatabase
BackUpDatabase

To back up your CTP database, click Back Up Database on the Database Configurations page. What happens next depends on your database type:

...

[client]

  • max_allowed_packet = 1G

Creating a Database from a Backup
Anchor
DatabaseFromBackup
DatabaseFromBackup

  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

Migrating a Database

You can migrate a database from one type to another (for example, from HyperSQL to PostgreSQL). Doing so is a basic two-step process:

  1. Create a backup of your existing database. See Creating a Database Backup.
  2. Restore your backup to the new database type. See Creating a Database from a Backup.

You should only do this within the same version of CTP. Keeping with the HyperSQL-to-PostgreSQL example from before, you want to create the backup of your HyperSQL database in the same version of CTP as your PostgreSQL database. Doing something like backing up your HyperSQL database in a previous version of CTP, then upgrading CTP and trying to create your PostgreSQL database with that backup could create errors.

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.

Image Removed

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>).

Image Removed

Current Configuration

You can view the current database configuration 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.

  • 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

  • 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

  • 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.
Info
titleJDBC 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.

Note

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.