Overview

The Session Manager in Team Edition allows you to view and search for active database sessions.

Supported databases

• Altibase
• Amazon Redshift
• Db2 for LUW
• Exasol
• Greenplum
• MariaDB
• Microsoft SQL Server
• MongoDB
• MySQL
• Oracle Database

• PostgreSQL

How to use

To open the Session Manager:

1) In the Database Navigator, navigate to your desired database.

2) Right-click and select Session Manager.

Once you have opened the Session Manager, you will have an ability to view all active database sessions.

To terminate a session, click the Terminate Session button at the bottom of the Session Manager window.

Session details

For more detailed information, click the context menu button on a session and select Show in value panel from the context menu:

Available tabs:

• Details: Detailed information about the session.
• Query: A summary of the SQL query associated with the session.

Overview

Team Edition offers keyboard shortcuts to help you work more efficiently. You can find these shortcuts within the web application by clicking on the Shortcuts icon in the top toolbar. You can also refer to the detailed list provided in this article below.

Shortcuts

Data Viewer

Action	Shortcut for macOS	Shortcut for Windows/Linux
Revert Inline Editor changes	ESCAPE	ESCAPE
Add a new Row	OPTION + R	ALT + R
Duplicate row	SHIFT + OPTION + R	SHIFT + ALT + R
Delete row	DELETE	DELETE

SQL Editor

Action	Shortcut for macOS	Shortcut for Windows/Linux
Execute SQL statement	CMD + ENTER	CTRL + ENTER
Execute SQL statement in the new Tab	CMD + \ or SHIFT + CMD + ENTER	CTRL + \ or SHIFT + CTRL + ENTER
Execute script	OPTION + X	ALT + X
Show Execution plan	SHIFT + CMD + E	SHIFT + CTRL + E
Format script	SHIFT + CMD + F	SHIFT + CTRL + F
Save as script	CMD + S	CTRL + S
Undo	CMD + Z	CTRL + Z
Redo	CMD + Y or CMD + SHIFT + Z	CTRL + Y or CTRL + SHIFT + Z
Open SQL Editor in the separate browser Tab	OPTION + T	ALT + T

Database Navigator

Action	Shortcut for macOS	Shortcut for Windows/Linux
Enable filtering	CMD + F	CTRL + F
Collapse all	CMD + SHIFT + /	CTRL + SHIFT + /
Link with editor	CMD + SHIFT + ,	CTRL + SHIFT + ,

Simple and Advanced Connection view defines what the Database navigator and the Metadata Editor structures will look like:

• Advanced view shows all database objects. It is enabled by default.
• Simple view shows only the schemas and tables. It can be enabled in the Easy configuration or the Administration menu by the admin for all new connections.

Users can also change the view of any connection in the connection context menu in the Database Navigator.

• Show system objects mode makes system schemas and tables available in the Database navigator and the Metadata Editor. It can be enabled in the connection context menu in the Database Navigator.

Tip: Default view could be set by the admin in the Server configuration. This will only affect newly created connections.

Formatting SQL scripts

To format SQL text:

1. Select the SQL text you wish to format.

2. Press Ctrl+Shift+F or click on the Format SQL Script button located on the left toolbar.

   

Commenting SQL lines

To manage comments in SQL scripts:

• To comment out an SQL line:

  1. Place your cursor on the line you want to comment.
  2. Press Ctrl+/ or CMD+/ for macOS.

• To uncomment a commented line:

  1. Place your cursor on the commented line.
  2. Press Ctrl+/ (CMD+/ for macOS) again to remove the commenting syntax.

  

Overview

Team Edition supports the following SSH authentication methods:

• Username/password

• Public key authentication

Configuring SSH tunnels

1. Start by creating a connection.
2. Set the hostname to
   localhost
   and the port to match the remote database in Main tab.

Tip: This step ensures Team Edition connects to the database on the remote machine through the SSH tunnel, treating the remote database as if it were running locally.

For example, if the database server listens on port 3306, the SSH tunnel forwards this port to your server machine. In Team Edition, set the hostname to

localhost

and the port to 3306 to use the local end of the tunnel. Ensure that the local port specified in the SSH tunnel configuration matches the port set in Team Edition’s connection settings. Verify that no other local services use the same port to avoid conflicts.

3. Go to the SSH Tunnel tab in the connection settings.
4. Enable the checkbox Use SSH Tunnel and choose the authentication method from Authentication method dropbox.
5. Depending on the chosen authentication method, configure the required settings:

Field	Description
Host	Enter the hostname or IP address of the SSH server.
Port	Specify the SSH server port (default is 22).
User	Provide the username to authenticate with.
Password	Enter the password for the specified user.
Private key	Paste the private key or use the File button to upload it.
Passphrase	(Optional) Enter the passphrase if the private key is encrypted.

6. Click Test tunnel to verify the parameters.

Tip: To avoid entering credentials every time, enable the Save credentials for the current user option. Depending on the connection type, the checkbox name may vary. For more details, see Credential saving options.

Advanced settings

Setting	Description
Alive interval (ms)	Sets the interval in milliseconds for sending a keep-alive packet to keep the connection active. A value of 0 disables keep-alive packets.
Connect timeout (ms)	Sets the maximum time in milliseconds to establish a tunnel connection before timing out.

Overview

Team Edition supports the ability to establish connections using Secure Socket Layer (SSL), a protocol for creating authenticated and encrypted links between networked computers.

Note: SSL parameters are optional and should only be specified if required by your server configuration.

Setting up SSL configuration

1. Start by creating a connection.
2. Go to the SSL tab in the connection settings.
3. Enable the checkbox Enable SSL
4. Configure the required settings:

Parameter	Description
CA Certificate	Path to the Certificate Authority (CA) certificate.
Client Certificate	Path to the client’s public key certificate.
Client Private Key	Path to the client’s private key.
SSL Mode	Desired security level for SSL.
SSL Factory	Provide SSLSocketFactory factory class name.
Cipher Suites (optional)	Specify a comma-separated cipher suites list to use.
Skip host name validation	Whether to bypass hostname validation.
Use self signed certificate (non-secure)	Acceptance of self-signed certificates.
Force TLS 1.2	Enforce using TLS version 1.2.
Verify server certificate	Ensures the server certificate is valid.
Allow public key retrieval	Allows the retrieval of the server’s public key.

Note: The availability of these parameters can vary depending on the database.

5. If all other necessary connection settings are configured, complete the setup by clicking Finish, or test the configuration by clicking Test Connection to ensure that SSL is functioning correctly.

Tip: To avoid entering credentials every time, enable the Save credentials for the current user option. Depending on the connection type, the checkbox name may vary. For more details, see Credential saving options.

Setting up SSL configuration via Driver properties

For some databases, an alternative method to configure SSL settings is available through the Driver properties tab. This approach allows access to additional or driver-specific SSL options that may not be present in the main SSL tab:

1. Select the Driver properties tab within the Connection settings.

   

2. Look for properties prefixed with

   ssl
   , such as
   sslResponseTimeout
   ,
   sslfactoryarg
   ,
   sslhostnameverifier
   , etc. Configure the necessary properties according to your database and server requirements.

3. If all other necessary connection settings are configured, complete the setup by clicking Finish, or test the configuration by clicking Test Connection to ensure that SSL is functioning correctly.

Import SSL certificates on startup

Team Edition can import certificates from a predefined folder at startup. This method is useful for databases protected by self-signed certificates. It ensures secure connections without manual setup, especially when a firewall or internal security policies require specific certificates.

For Docker Compose

• Create the
  public/custom
  folder inside
  team-edition-deploy/compose/cbte/cert
  .
• Place the certificate file in this folder.
• Team Edition will detect and import it on startup.

For details on locating

, see Encryption keys in the deployment repository.

For Kubernetes

• Create a
  custom
  folder inside the
  cross-ssl-cert
  volume and place the certificate there.

• Alternatively, mount the certificates as a read-only volume:

  
  - name: custom-certificates
  
    mountPath: /opt/{service-name}/conf/certificates/custom
  
    readOnly: true
  
  

  For more details on configuration, see Server configuration.

Note: Only certificates are imported, not private keys.

Overview

Team Edition offers a powerful web API through the GraphQL protocol, enabling advanced server interactions and data manipulation.

Note: The API explorer (GraphQL console) is only available when the server is running in Development mode. Ensure that

develMode

is set to

true

in your configuration to enable access.

Accessing the GraphQL console

The GraphQL console is an interface that allows you to test and interact with the API. You can access it by navigating to the following URL:

http://localhost:${serverPort}/${serviceURI}/gql/console

Replace

and with the actual server port and service URI values set in your configuration.

For information on configuring these variables, see the Server configuration guide.

Generating API tokens

To generate an API token for authentication, see the Generate API access token guide.

Overview

The Server Configuration panel in Team Edition enables administrators to manage server settings important for the server. The panel is structured into distinct sections, each dedicated to specific aspects of server management.

To access the Server Configuration, navigate as administrator to Settings -> Administration -> Server Configuration.

The sections within the Server Configuration include:

• Server Information: Specifies essential server details.
• Configuration: Manages general configurations.
• Authentication Settings: Controls the methods for authentication.
• Security: Manages the storage of credentials.
• Disabled drivers: Allows to disable specific drivers on the server.

Note: The availability and specific options of the settings in the Server Configuration panel may vary between different versions of Team Edition.

Server information

Setting name	Description
Server Name	The name assigned to the server for identification purposes.
Server URL	The URL through which the server can be accessed.
Session lifetime	Specify the duration, in minutes, for which a session remains active before expiring.

Configuration

Setting name	Description	Additional article
Navigator simple view	Shows only basic information in new connections within the navigation tree.	Simple and advanced view.

Services integration

Setting name	Description	Additional article
Cloud Storage	Enables integration with cloud storage services.	Cloud Storage.
AI	Allows integration with AI services.	AI smart assistance.
AWS	Enables the server to connect with AWS services.	AWS Settings.
Azure	Allows integration with Microsoft Azure services.	Cloud Explorer.
GCP	Enables integration with Google Cloud Platform services.	Cloud Explorer.
Git	Integrates Team Edition with Git services for version control.	Team Edition Git integration.

Resource management

Setting name	Description	Additional article
Enable Resource Manager	Activates the Resource Manager, allowing users to store and manage scripts on the server.	Resource manager.

Authentication settings

The Authentication Settings section allows enabling various authentication methods that can later be configured in the Identity Provider tab.

Tip: For more information, see Authentication methods.

Security

Setting name	Description
Save credentials	Allows saving credentials for pre-configured databases.
Save users credentials	Allows saving credentials for non-admin users.

Disabled drivers

The Disabled Drivers section allows administrators to control the availability of database drivers on the server.

• Search for the driver: Enter the name of a specific driver in the search field to quickly locate it.
• Disabling a driver: Select the desired driver from the search results to disable it.
• Enabling a driver: To re-enable a disabled driver, click on the
  X
  next to its name in the list.

Tip: For more information on how to manage these settings through the configuration file, see Server configuration.

Overview

The Result details panel provides you with information about the execution of a

query. To open the panel, click the Result Details button on the right-hand side of the Data tab.

Note: This panel is specific to BigQuery and provides details that help in monitoring query costs.

Metrics

Result details panel includes the following metrics:

Name	Description
Job	The unique identifier of the job.
Location	The regional location of the data you have queried.
Project	The project within which the query was executed.
DML affected rows	The number of rows affected by a Data Manipulation Language (DML) statement.
Fetched from cache	Indicates if the results were retrieved from the cache. true means no additional costs are incurred for data processing.
Total rows	The number of rows returned by the query.
Total bytes processed	The amount of data processed by the query. This is important for cost calculations as costs are incurred based on the amount of data processed. If the Total bytes processed is zero, it indicates that the query results were served from the cache, which does not incur costs.
Transaction id	The identifier for the transaction within which the query was executed, if applicable.
Total bytes billed	The total bytes billed for the query, which might be different from the bytes processed if discounts or caps are applied.
Total modified partitions	The total number of partitions that were modified as a result of the query execution.
Total slot ms	The total number of slot milliseconds consumed by the query.
Query	The SQL query statement that was executed.