amotl commented on code in PR #29243: URL: https://github.com/apache/superset/pull/29243#discussion_r1844141083
########## docs/docs/configuration/databases.mdx: ########## @@ -394,21 +394,33 @@ couchbase://{username}:{password}@{hostname}:{port}?truststorepath={certificate #### CrateDB -The recommended connector library for CrateDB is -[crate](https://pypi.org/project/crate/). -You need to install the extras as well for this library. -We recommend adding something like the following -text to your requirements file: - +The connector library for CrateDB is [sqlalchemy-cratedb]. +We recommend to add the following item to your `requirements.txt` file: ``` -crate[sqlalchemy]==0.26.0 +sqlalchemy-cratedb>=0.40.1,<1 ``` -The expected connection string is formatted as follows: - +An SQLAlchemy connection string for [CrateDB Self-Managed] on localhost, +for evaluation purposes, looks like this: ``` crate://crate@127.0.0.1:4200 ``` +An SQLAlchemy connection string for connecting to [CrateDB Cloud] looks like +this: +``` +crate://<username>:<password>@<clustername>.cratedb.net:4200/?ssl=true +``` + +Follow the steps [here](/docs/configuration/databases#installing-database-drivers) +to install the CrateDB connector package when setting up Superset locally using +Docker Compose. +``` +echo "sqlalchemy-cratedb" >> ./docker/requirements-local.txt +``` + +[CrateDB Cloud]: https://cratedb.com/product/cloud +[CrateDB Self-Managed]: https://cratedb.com/product/self-managed +[sqlalchemy-cratedb]: https://pypi.org/project/sqlalchemy-cratedb/ Review Comment: Hi. While being at it, refreshing the canonical dependencies for the CrateDB connector, we took the chance to also update the relevant documentation section. We hope you agree with those minor updates being slapped into the same PR per aef7f2dd1ff. @hlcianfagna, @proddata, @simonprickett, @kneth: Please also have a look at those updates, and suggest any improvements that come to mind. See [GitHub-rendered preview](https://github.com/apache/superset/blob/aef7f2dd1ff8853642eda2fdd3e5bbae4277f142/docs/docs/configuration/databases.mdx#cratedb). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org For additional commands, e-mail: notifications-h...@superset.apache.org