Connection Templates Management

Table of contents

• Overview
  • The Purpose
  • Description
  • Creation
  • Template Form
  • Usage

Important: This feature will be removed in version 25.0.

Overview

The Purpose

The templates enable administrators to define various reusable connection parameters, subsequently allowing users to create multiple connections based on these templates. This process ensures consistency across the connections created from these templates, as they adhere to the defined parameters within the templates.

Description

You can add, edit, or remove database templates on the Connection Templates page in administration.

Creation

To create a new template, follow the steps below:

1. Click the Add button located on the top toolbar. This will open the template creation form.
2. Fill out the fields in the form with the appropriate information.
3. Once all fields are completed, click Create.

Your new template should be successfully created and it will appear at the top of the templates table.

Template Form

Below are the detailed steps to set the template parameters:

1. Open the template form. This can be done by clicking the Add button in the toolbar.
2. Fill in the appropriate information in the base template parameters, driver settings, SSH tunnel, and access fields.
3. To verify the template connection, click the Test button. If SSH is configured, the test will use it to establish the connection.
4. When users attempt to establish a connection using the template, they will be prompted to enter credentials.

You can manage access to the database at the Access tab. You can select users or roles to provide access to.

Usage

Once a template is prepared, connections can be created using the template from the public section of the CloudBeaver.

1. In the toolbar, select Connection.
2. From the dropdown menu, select From a template.
3. Choose the desired template.