MySQL

MySQL is a widely used relational database management system known for structured data storage, high performance, and strong scalability.

Apidog supports connecting to and interacting with MySQL databases, allowing SQL statements to be executed either before or after an endpoint call.

Connecting to the Database

On the endpoint page, click "Pre/Post Processors" and select "Database Operation".

Click the "Database Connections" dropdown and choose "Manage Database Connection", then click the "+ New" button at the top right corner.

In the popup window, select "MySQL" as the database type and fill in the connection details including host, port, user name, password, and database name. You can store these details in variables and test the connection.

SSL Connection (Optional)

The latest version of Apidog supports automatic SSL connections by default. If you need to configure SSL manually, switch to the SSL tab in the connection settings and select a mode:

Prefer (default): Use SSL if supported; otherwise, fall back to non-SSL.

Require: SSL is mandatory; the connection will fail if SSL is not available.

Verify CA: Use SSL and validate the server’s CA certificate.

Verify Full: In addition to Verify CA, validate the server’s hostname.

You can upload a CA certificate, client certificate, and private key (either by directly entering the content or selecting a local file; the content will be displayed in the input field).

Apidog suggests that you:

store database connection info in Apidog Cloud for centralized management.

use Vault variables to protect sensitive fields.

avoid storing plaintext credentials in the "Initial Value" section of the environment variables.

Operating the Database

Apidog supports standard SQL queries, but does not support complex operations like stored procedures.

SELECT

Run a query to fetch data from the database.

Example:

You can also use variables:

The query will return structured data as an array of objects — even if there's only one result:

[
    {
        "id": 1,
        "name": "jack"
    }
]

You can extract fields using JSONPath and save them as variables:

Variable name: user_id

JSONPath: $[0].id

To save the entire result set:

Variable name: userList

JSONPath: $

INSERT

Insert new records into the database.

Example:

Dynamic data supported:

DELETE

Delete records from the database.

Example:

Using a variable:

UPDATE

Update existing records in the database.

Example:

Supports dynamic update:

Usage in Automated Test

Database operations are supported during automated test, and SQL statements in test steps can use dynamic value expressions and variables.

Using Dynamic Value Expressions

You can retrieve pre-step data using dynamic values in SQL statements:

Using Variables

Extract a variable (e.g., products_id) from previous test step:

Then reference them as {{variables}} in SQL for the next test steps:

Using ForEach Loop

You can use ForEach loops in test steps to perform batch database operations.

Example 1: Query by Field in a Loop

Note: 4 is the ID of the ForEach step — replace it with the correct ID in your workflow.

You can use dynamic values to fetch the expression:

Example 2: Insert Multiple Fields in a Loop

This is especially helpful when you need to insert multiple records in batch or verify if certain data already exists in the database.

FAQs

How to fix authentication errors when connecting to MySQL 8?

The latest MySQL module in Apidog does not fully support the caching_sha2_password, the default authentication method in MySQL 8.

To work around this, you need to specify the mysql_native_password mode to modify the MySQL password: Connect to MySQL using other tools and run the following SQL command:

Replace username and 123456 with your actual username and password.

Connecting to the Database#

Operating the Database#

SELECT#

INSERT#

DELETE#

UPDATE#

Usage in Automated Test#

Using Dynamic Value Expressions#

Using Variables#

Using ForEach Loop#

FAQs#

Connecting to the Database

Operating the Database

SELECT

INSERT

DELETE

UPDATE

Usage in Automated Test

Using Dynamic Value Expressions

Using Variables

Using ForEach Loop

FAQs