Database Connection

You can configure database connection details in the project settings. Once configured, you can use these connections during endpoint debugging and testing by adding database operations in the pre/post processors steps. This allows you to read from or write to the database seamlessly.

The free version of Apidog supports connecting to the following databases:

MySQL

SQL Server: Supports SQL Server 2014 and later versions

Oracle (Connecting to an Oracle database requires installing Oracle Client)

Db2

PostgreSQL

With an upgrade, you can also connect to:

ClickHouse (Requires Basic plan)

MongoDB (Requires Basic plan)

Redis (Requires Basic plan)

Configuring Database Connection

Follow these steps to set up a database connection in Apidog:

Open Project Settings->Database Connections.

Click + New at the top right corner to create a database connection.

Select the database type from the available options, fill in the necessary connection information such as host, port, database name, user name, and password. It is recommended to use variables to fill in. Database connections filled entirely with variables can be saved in the cloud for collaboration.

📌

Important! When using variables for database connections, be mindful of data security implications.

In addition to the local connection method using username and password, you can also establish a more secure connection through SSH tunnel to better protect data transmission.

Click Save, and this connection can be used in pre/post processors.

Using Database Connection

You can add "Database Operations" in pre/post processors for an endpoint request to reference a database connection. After adding it, you can specify a database connection in "Database Operations".

Below are the specific steps for database operations.

In theRuntab (Design Mode) orRequesttab (Request Mode), navigate to pre/post processors.

Hover over Add PreProcessor orAdd PostProcessor and select Database Operation.

Name the database operation and configure the database connection. Ensure the selected "Database Connection" is correctly set up. Learn More.

Enter the SQL command. Variables such as {{variables}} are supported in commands.

EnableExtract Result To Variable(supports JSONPath) and toggle Console Logif needed.

Click Send to execute the endpoint request, and check the result in the console.

If you useDatabase Operationin automated tests—either as a test step or in the pre/post-processors of endpoint requests—you can follow the same steps outlined above to set it up and use it.

Apidog supports standard SQL queries but does not support complex SQL operations such as stored procedures.

Important Notes

Before executing database operations via requests, ensure the configured database connection is properly saved:

If your database connection uses variables and is stored in the cloud, make sure to set the actual database details (like host, username, password, etc.) in the Current Value field of the related variables. Alternatively, you can use the set variable method to configure these values dynamically.

If the database connection uses fixed text and is stored locally, you need to enter the actual database details (like host, username, password, etc.) in Project Settings -> Database Connection.

If you need to run test scenarios with a database connection via CLI, click here for detailed notes

If you need to run test scenarios with a database connection via Runner, click here for detailed notes.

Storage Mechanism and Data Security

Currently, Apidog offers two ways to store database connections:

Stored in Apidog Cloud: If the database connection is configured entirely using variables, it will be stored as variables on Apidog’s cloud server.

Stored Locally: If the database connection is configured using fixed text, it will be stored as plain text in the local configuration file.

Differences between Storage Mechanisms

Storage Mechanism	Storage Method	Advantages	Disadvantages
Cloud	Use variables in configuration	1. Enables more convenient collaboration with team members. 2. When running test scenarios via CI, Runner, etc., you can use variables to set the database connection details instead of maintaining local files.	⚠️ When plaintext is used in the initial values of variables, data such as database names and passwords will be transmitted in plaintext to Apidog's cloud servers, posing a data security risk (using current values for variables keeps the data stored locally, eliminating this risk). It is recommended to use vault variables to avoid data security risks.
Local	Use fixed text in configuration	Locally stored with no security risk	1. Poor collaboration; each team member must configure the database connection individually. 2. When running test scenarios through CI, Runner, or similar tools, you need to maintain a dedicated local file for database connections.

💡

To balance a great user experience with data security, Apidog recommends saving database connections in the cloud and using Vault variables to ensure data safety. It is strongly discouraged to use plaintext in the initial values of variables related to database connections, as this can lead to significant data security risks.

Configuring Database Connection#

Using Database Connection#

Important Notes#

Storage Mechanism and Data Security#

Differences between Storage Mechanisms#

Configuring Database Connection

Using Database Connection

Important Notes

Storage Mechanism and Data Security

Differences between Storage Mechanisms