Skip to content

Commit 1991d1f

Browse files
authored
chore(deps): Migrate from crate[sqlalchemy] to sqlalchemy-cratedb (#29243)
1 parent df47994 commit 1991d1f

File tree

2 files changed

+22
-10
lines changed

2 files changed

+22
-10
lines changed

docs/docs/configuration/databases.mdx

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -394,21 +394,33 @@ couchbase://{username}:{password}@{hostname}:{port}?truststorepath={certificate
394394

395395
#### CrateDB
396396

397-
The recommended connector library for CrateDB is
398-
[crate](https://pypi.org/project/crate/).
399-
You need to install the extras as well for this library.
400-
We recommend adding something like the following
401-
text to your requirements file:
402-
397+
The connector library for CrateDB is [sqlalchemy-cratedb].
398+
We recommend to add the following item to your `requirements.txt` file:
403399
```
404-
crate[sqlalchemy]==0.26.0
400+
sqlalchemy-cratedb>=0.40.1,<1
405401
```
406402

407-
The expected connection string is formatted as follows:
408-
403+
An SQLAlchemy connection string for [CrateDB Self-Managed] on localhost,
404+
for evaluation purposes, looks like this:
409405
```
410406
crate://crate@127.0.0.1:4200
411407
```
408+
An SQLAlchemy connection string for connecting to [CrateDB Cloud] looks like
409+
this:
410+
```
411+
crate://<username>:<password>@<clustername>.cratedb.net:4200/?ssl=true
412+
```
413+
414+
Follow the steps [here](/docs/configuration/databases#installing-database-drivers)
415+
to install the CrateDB connector package when setting up Superset locally using
416+
Docker Compose.
417+
```
418+
echo "sqlalchemy-cratedb" >> ./docker/requirements-local.txt
419+
```
420+
421+
[CrateDB Cloud]: https://cratedb.com/product/cloud
422+
[CrateDB Self-Managed]: https://cratedb.com/product/self-managed
423+
[sqlalchemy-cratedb]: https://pypi.org/project/sqlalchemy-cratedb/
412424

413425

414426
#### Databend

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ bigquery = [
112112
clickhouse = ["clickhouse-connect>=0.5.14, <1.0"]
113113
cockroachdb = ["cockroachdb>=0.3.5, <0.4"]
114114
cors = ["flask-cors>=2.0.0"]
115-
crate = ["crate[sqlalchemy]>=0.26.0, <0.27"]
115+
crate = ["sqlalchemy-cratedb>=0.40.1, <1"]
116116
databend = ["databend-sqlalchemy>=0.3.2, <1.0"]
117117
databricks = [
118118
"databricks-sql-connector>=2.0.2, <3",

0 commit comments

Comments
 (0)