> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/concepts/resources/vulcan/activation/mysql.md).

# MySQL

Your semantic layer speaks the MySQL wire protocol, so anything that can talk to MySQL can query it: the `mysql` shell, DBeaver, JetBrains DataGrip, MySQL Workbench, scripts, exports, internal tools.

Pick the interface that matches how you already work.

***

## Option 1: MySQL Shell

If you don't have the shell installed, grab it for your OS from the official docs:

```
https://dev.mysql.com/doc/mysql-shell/8.4/en/mysql-shell-install.html
```

Connect with your tenant details:

```bash
mysql -h tcp.{instance_name} -P 3306 -u {username} -p'{apikey}' --enable-cleartext-plugin {tenant_name}.{dataproduct_name}
```

`--enable-cleartext-plugin` is required: the API key is sent as the password, and TLS encrypts the channel.

Once connected, explore your semantic layer with standard SQL:

```sql
-- List all available semantic models
SHOW TABLES;

-- View the structure of one
DESCRIBE table_name;

-- List columns
SHOW COLUMNS FROM table_name;
```

***

## Option 2: DBeaver or other IDEs

DBeaver, DataGrip, MySQL Workbench, and most SQL IDEs support MySQL connections. Use these values in the new-connection dialog:

| Field    | Value                              |
| -------- | ---------------------------------- |
| Host     | `tcp.{instance_name}`              |
| Port     | `3306`                             |
| Username | `{username}`                       |
| Password | `{apikey}`                         |
| Database | `{tenant_name}.{dataproduct_name}` |

{% hint style="info" %}
Enable **cleartext authentication** in the IDE's advanced or SSL settings. Without it, the connection fails immediately at handshake.
{% endhint %}

***

## Troubleshooting

<details>

<summary>Common issues</summary>

**`Authentication plugin 'mysql_clear_password' cannot be loaded`**

Cleartext auth isn't enabled. In the shell, add `--enable-cleartext-plugin`. In a GUI IDE, find the option under **Driver properties** or **SSL/Advanced settings** and turn it on.

**`Unknown database '{tenant}.{dataproduct}'`**

The database string must contain a dot: `{tenant_name}.{dataproduct_name}`. Just the data product name on its own won't resolve.

**`SHOW TABLES` is empty**

No semantic models have been applied yet. Run `vulcan plan` and confirm at least one model exists in `models/semantics/`.

**Connection refused or timeout**

Confirm `tcp.{instance_name}` resolves and that port 3306 isn't blocked by a corporate firewall or VPN policy.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://v2.dataos.info/concepts/resources/vulcan/activation/mysql.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.