Skip to content

Commit aef7f2d

Browse files
committed
chore(docs): Update documentation section about CrateDB configuration
1 parent 5119132 commit aef7f2d

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

docs/docs/configuration/databases.mdx

Lines changed: 20 additions & 8 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
```
404400
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

0 commit comments

Comments
 (0)