Database Types

A database type defines a given type of database, e.g. MySQL. A database type consists of the following properties.

Property

Description

Name

The name identifying the database type.

JDBC driver

The JDBC driver class of the driver (the driver must be uploaded under Database Drivers).

Connection URL template

A template string defining how connection URLs for databases of the given type look. Possible variables to use in the template string are the following:

${ServerName}

Defines the server name (host) of the database server.

${Schema}

Defines the schema (or database/catalog depending on database vendor) of the database.

An example of a connection string template is the following 'jdbc:mysql://${ServerName}/${Schema}'. This string defines the connection string for a MySQL database running on the default port (no port is specified), on the server given by ${ServerName} and using the schema given by ${Schema}. The variables are given values when databases of the given type are created (see the cluster databases section.

Validation query

The validation query for a database is the query to use when validating connections to the given database. Such queries varies greatly between different types of databases.

Database Type Properties


The database types are also sent to Design Studio clients.

To add a new database type, you either select the database type category, and click the 'Add Database Type' button, or you right-click the database type category and click the add button. NOTE: adding a new database type should be considered an advanced and in some cases experimental feature, meaning that the default database types are those that are supported, and there is no guarantee that a whole new type of database will work as expected throughout the product. However, modifying the database types in order to, for instance, add a type that defines a MySQL server running on a non-standard port would be a normal use-case.