The Listeners menu is used to configure and manage OneDB listener services. A listener acts as the access point between client applications and the configured database connection.

Each listener defines the port exposed by OneDB, its primary database connection, allowed connection profiles, listener status, maximum allowed connections, and idle timeout behavior.

A listener can support multiple registered OneDB connection profiles when they use the same database type and backend database endpoint. This allows client users or applications to connect through one listener while OneDB applies the appropriate connection profile, database scope, and security policies.

Listeners Management

To access this page, go to:

Database Server > Listeners

The Listeners Management page displays all configured listeners in OneDB.

Each listener is shown in a table with the following information:

Add Listener

To create a new listener, click the Add listeners button from the Listeners Management page.

The Add Listener form will be displayed.

Listener Configuration Fields

Fill in the required listener configuration details.

Connection Profiles

The Connections field is used to select the primary database connection for the listener.

This primary connection establishes the listener runtime configuration and policy boundary. It defines the database type, backend destination, and the base security context used by the listener.

The Allowed Databases / Schemas field allows additional compatible OneDB connection profiles to be assigned to the same listener.

Only registered OneDB connections that meet the following requirements are available:

• Use the same database type as the primary connection.
• Use the same backend database host or IP address.
• Use the same backend database port.

For example, a PostgreSQL listener can allow multiple PostgreSQL connection profiles for different databases, schemas, or database users, as long as they point to the same PostgreSQL backend server.

Queries to databases or schemas that are not included in the allowed connection profiles will be blocked by the listener.

The primary connection must always be selected before additional connection profiles can be assigned.

Port Configuration

The Port field defines the port exposed by OneDB.

Client applications will connect to OneDB using this port instead of connecting directly to the database server.

Valid port range:

1024 - 65535

Example:

Listener Status

The Listener Status field controls whether the listener is active.

This option is useful when the administrator wants to temporarily disable access without deleting the listener configuration.

Max Connections

The Max Connections field defines the maximum number of concurrent client connections allowed for the listener.

Default value shown:

10

Valid range:

1 - 1000

Use this setting to control connection capacity and prevent excessive client connections from reaching the target database through OneDB.

Idle Timeout

The Idle Timeout (Seconds) field defines how long an idle client connection can remain open.

Default value shown:

60

Valid range:

10 - 3600 seconds

If a connection remains idle longer than the configured timeout value, OneDB will automatically close the connection.

Submit Listener Configuration

After all required fields have been completed, click Submit to save the listener configuration.

Once saved, the listener will appear in the Listeners Management table.

Allowed Connection Profiles

After a listener has been configured, administrators can view its allowed connection profiles from the Listeners Management page.

The profile list displays the connection details associated with the listener, including:

This view helps administrators confirm which connection profiles are available through a listener and verify that each profile points to the expected backend database environment.

Edit Listener

To modify an existing listener, click the Edit icon from the listener row.

The administrator can update the listener configuration, such as:

Delete Listener

To remove a listener, click the Delete icon from the listener row.

Deleting a listener removes the configuration from OneDB. After deletion, client applications will no longer be able to connect through that listener port.

Make sure the listener is no longer used by any application before deleting it.

Notes

• Each listener should use a unique port.
• The selected port must not conflict with another listener or any service already running on the OneDB server
• A listener should be associated with a valid database connection before it can be used by client applications.
• The target database IP address and destination port are inherited from the selected connection configuration
• A listener can support multiple connection profiles, provided that all selected profiles use the same database type and backend database endpoint.
• The primary connection determines the listener runtime connection and policy boundary
• Only databases or schemas included in the allowed connection profiles can be accessed through the listener.
• Requests targeting an unlisted database or schema are blocked by OneDB
• Each listener should use a unique port and must not conflict with another OneDB listener or service running on the same server