Connect: Fix and improve connection strings #151
Conversation
amotl
force-pushed
the
amo/connect-ssl-true
branch
from
d4b7fb6 to
2b82c00
Compare
amotl
changed the title
ssl=true argument on SQLAlchemy connection string
| @@ -101,10 +101,10 @@ An HTTP URL to visit Admin UI. | |||
| **Connection-string examples** | |||
|
|
|||
| A native PostgreSQL connection string. | |||
| `postgresql://crate@localhost:5432/crate` | |||
There was a problem hiding this comment.
technically /crate specifies the database to be used.
Unfortunately CrateDB still uses them in a non pg-compliant way
crate/crate#13502
There was a problem hiding this comment.
Do you think it is a good measure to slap the "Blocked by CrateDB" label onto the root issue, in order to increase awareness?
|
I have removed me as reviewer as my SQL Alchemy and Apache Flink knowledge is too shallow |
amotl
force-pushed
the
amo/connect-ssl-true
branch
from
2b82c00 to
7f16fd1
Compare
Co-authored-by: Georg Traar <[email protected]>
amotl
force-pushed
the
amo/connect-ssl-true
branch
from
3c3c335 to
1fb6dba
Compare
amotl
force-pushed
the
amo/connect-ssl-true
branch
from
a406876 to
728947a
Compare
|
I think this yak shaving went well? Let me know if you see any spots for improvements, or if you would do it completely different.
Please check, also @karynzv, @hammerhead, @wierdvanderhaar, @zolbatar, @lservini, if you can spot something to be improved in this section of the documentation, also in general beyond this widget. Thank you. |
amotl
force-pushed
the
amo/connect-ssl-true
branch
from
728947a to
418d3d6
Compare
CrateDB is different in different aspects regarding the semantics of common database servers, because it does not implement "databases". This section aims to educate about the differences in a very concise manner, including relevant hints that might save users from too many permutations in probing failed connection attempts.
amotl
force-pushed
the
amo/connect-ssl-true
branch
from
418d3d6 to
8cd4341
Compare
| ```{tip} | ||
| - Specify the [schema] name `doc`, if you are asked for a *database name*. | ||
| - The default [superuser] on a vanilla CrateDB cluster is called `crate`, | ||
| without a password. | ||
| - When aiming to authenticate properly, please learn about the available | ||
| [authentication] options. | ||
| - CrateDB's fixed catalog name is `crate`, the default schema name is `doc`. | ||
| - CrateDB does not implement the notion of a database, | ||
| however tables can be created in different [schemas]. | ||
| - When asked for a *database name*, specifying a schema name (any), | ||
| or the fixed catalog name `crate` may be applicable. | ||
| - If a database-/schema-name is omitted while connecting, | ||
| the PostgreSQL drivers may default to the "username". | ||
| - The predefined [superuser] on an unconfigured CrateDB cluster is | ||
| called `crate`, defined without a password. | ||
| - For authenticating properly, please learn about the available | ||
| [authentication] options. | ||
| ``` |
There was a problem hiding this comment.
Reply
Tools like DBeaver will default to your username as "database" name. In CrateDB this currently sets your searchpath to username. Do you want that?
This is certainly not intended, [...] improving the documentation [makes sense].
Thanks again. Within the "Tip" section below, I've added this item:
- If a database-/schema-name is omitted while connecting,
the PostgreSQL drivers may default to the "username".
Report
There have been a few more updates to this section, aiming to compress relevant details about those matters into a single spot.
There was a problem hiding this comment.
^^
Connect: Improve "Tip" section about specifics of catalog v db v schema
CrateDB is different in different aspects regarding the semantics of
common database servers, because it does not implement "databases".This section aims to educate about the differences in a very concise
manner, including relevant hints that might save users from too many
permutations in probing failed connection attempts.-- 8cd4341
We compiled those details based on a few empirical exercises, and your advises. Please validate.
Please let us know if you can think of anything missing in this summary, or if existing items need to improve in wording and overall clarity.
There was a problem hiding this comment.
I guess it will not harm to merge this, now after refining it on behalf of multiple iterations. Please let me know about any improvements and wishes also in retrospective. Thanks for your valuable support so far!
About
A few fixes/improvements to different connection strings we are presenting on the documentation. For example:
ssl=trueargument on SQLAlchemy connection string./<dbname>argument from SQLAlchemy connection string, because it would cause errors.Preview
https://crate-clients-tools--151.org.readthedocs.build/en/151/connect/
/cc @surister, @simonprickett