Skip to content

Commit 7aa8958

Browse files
robertsilencursoragent
authored andcommitted
docs(mysql): address review feedback on MariaDB documentation
Remove separate MariaDB entry from README backends list. Document MariaDB under Connect on the mysql backend page. Label README entry and page title MySQL/MariaDB; API and URL remain mysql. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent a681280 commit 7aa8958

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,7 @@ Ibis supports more than 20 backends:
149149
- [DuckDB](https://ibis-project.org/backends/duckdb/)
150150
- [Exasol](https://ibis-project.org/backends/exasol)
151151
- [Materialize](https://ibis-project.org/backends/materialize/)
152-
- [MySQL](https://ibis-project.org/backends/mysql/)
153-
- [MariaDB](https://ibis-project.org/backends/mysql/)
152+
- [MySQL/MariaDB](https://ibis-project.org/backends/mysql/)
154153
- [Oracle](https://ibis-project.org/backends/oracle/)
155154
- [Polars](https://ibis-project.org/backends/polars/)
156155
- [PostgreSQL](https://ibis-project.org/backends/postgresql/)

docs/backends/mysql.qmd

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
# MySQL
1+
# MySQL/MariaDB
22

33
[https://www.mysql.com](https://www.mysql.com)
44

5-
[MariaDB](http://www.mariadb.org) is supported via the same backend. Use `ibis.mysql.connect()` or a `mysql://` connection URL.
6-
75
![](https://img.shields.io/badge/memtables-fallback-yellow?style=flat-square) ![](https://img.shields.io/badge/inputs-MySQL tables-blue?style=flat-square) ![](https://img.shields.io/badge/outputs-MySQL tables | CSV | pandas | Parquet | PyArrow-orange?style=flat-square)
86

97
## Install
@@ -105,6 +103,12 @@ passing a properly-formatted MySQL connection URL to `ibis.connect`:
105103
con = ibis.connect(f"mysql://{user}:{password}@{host}:{port}/{database}")
106104
```
107105

106+
### MariaDB
107+
108+
The MySQL backend also works with [MariaDB](https://mariadb.org). Use the same
109+
`ibis.mysql.connect()` API or a `mysql://` connection URL. Ibis development and
110+
CI use a MariaDB image in `compose.yaml`.
111+
108112
```{python}
109113
#| echo: false
110114
BACKEND = "MySQL"

0 commit comments

Comments
 (0)