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, the target database connection, listener status, maximum allowed connections, and idle timeout behavior.

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 Selection

The Connections field allows the administrator to select an existing database connection.

Only previously configured connections are available in this dropdown list.

Example connection options may include:

PostgreSQL-Cloud
MsSQL-Cloud
Oracle-cloud
postgresql-local
pg-local
mysql-local

The selected connection determines the backend database destination used by the listener.

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.

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.