Files
dbx/docs/content/docs/databases.mdx
T

92 lines
2.7 KiB
Plaintext

---
title: Database Support
description: 25+ database engines through native Rust drivers by default, with optional JDBC plugin support for more databases.
---
<Callout type="info">
DBX uses native Rust drivers by default, with no JDBC required. For additional databases, install the optional [JDBC plugin](/docs/plugins).
</Callout>
## Fully Supported
| Database | Driver | Protocol |
|---|---|---|
| MySQL | sqlx | MySQL |
| PostgreSQL | sqlx | PostgreSQL |
| SQLite | sqlx | Embedded |
| Redis | redis-rs | RESP |
| MongoDB | mongodb | MongoDB Wire |
| DuckDB | duckdb-rs | Embedded |
| ClickHouse | HTTP client | HTTP |
| SQL Server | tiberius | TDS |
| Oracle | oracle-rs | OCI |
| Elasticsearch | HTTP client | REST |
| DM (Dameng) | odbc-api | ODBC |
| GaussDB | rust-gaussdb | GaussDB |
## MySQL Compatible
These databases use MySQL protocol and work with the MySQL driver out of the box:
| Database | Default Port |
|---|---|
| MariaDB | 3306 |
| TiDB | 4000 |
| OceanBase | 2881 |
| GoldenDB | 3306 |
| Doris | 9030 |
| SelectDB | 9030 |
| StarRocks | 9030 |
| TDengine | 6030 |
<Callout type="info">
OceanBase supports automatic Oracle mode detection — when connected to an OceanBase instance running in Oracle mode, DBX automatically switches to Oracle-style schema queries.
</Callout>
These databases use PostgreSQL protocol and work with the PostgreSQL driver:
| Database | Default Port |
|---|---|
| openGauss | 5432 |
| KingBase | 54321 |
| Vastbase | 5432 |
| Redshift | 5439 |
| CockroachDB | 26257 |
## ODBC Databases
DM (Dameng) connects through ODBC, which requires an ODBC driver installed on your system.
### DM (Dameng)
DM8 connects via the DM ODBC driver. Default port: **5236**, default user: **SYSDBA**.
<Tabs groupId="dm-platform" items={['Linux', 'Windows', 'macOS']}>
<Tab value="Linux">
```bash
# Install unixODBC
sudo apt install unixodbc
# Install DM8 (includes ODBC driver)
# Download from https://eco.dameng.com/download/
# Register the driver in /etc/odbcinst.ini
sudo tee -a /etc/odbcinst.ini << 'EOF'
[DM8 ODBC DRIVER]
Description = DM8 ODBC Driver
Driver = /opt/dmdbms/bin/libdodbc.so
EOF
```
</Tab>
<Tab value="Windows">
The DM8 installer automatically registers the ODBC driver. No manual configuration needed.
</Tab>
<Tab value="macOS">
DM does not provide a native macOS ODBC driver. For development/testing, DM is best accessed from Linux.
</Tab>
</Tabs>
## Optional JDBC Plugin
If your target database is not built in, or if you must use a vendor JDBC driver, create a JDBC connection with the [JDBC plugin](/docs/plugins). The JDBC plugin does not increase the main DBX installer size and does not automatically download vendor drivers.