Integrate: Add dedicated page about DBeaver #157
Conversation
docs/integrate/dbeaver/index.md
Outdated
| ## Install | ||
|
|
||
| ::::{grid} 2 | ||
| :::{grid-item} | ||
| For connecting to CrateDB, the [CrateDB JDBC Driver] will be used. | ||
| ::: | ||
| :::{grid-item} | ||
| {w=480px} | ||
| ::: | ||
| :::: | ||
|
|
||
|
|
||
| ## Connect | ||
|
|
||
| ::::{grid} 2 | ||
|
|
||
| :::{grid-item} | ||
| Please specify database URL and credentials of your CrateDB cluster. | ||
|
|
||
| When connecting to [CrateDB Self-Managed] on localhost, | ||
| for evaluation purposes, use: | ||
| ``` | ||
| jdbc:crate://localhost:5432/ | ||
| ``` | ||
|
|
||
| When connecting to [CrateDB Cloud], use: | ||
| ``` | ||
| jdbc:crate://<clustername>.cratedb.net:5432/ | ||
| ``` | ||
| ::: | ||
| :::{grid-item} | ||
| {w=480px} | ||
| ::: | ||
| :::{grid-item} | ||
| When selecting CrateDB, drivers will be downloaded automatically | ||
| on the first use. | ||
|
|
||
| Alternatively, download and use the [crate-jdbc-standalone-2.7.0.jar] JAR file, | ||
| and select the driver class `io.crate.client.jdbc.CrateDriver`. | ||
| ::: | ||
| :::{grid-item} | ||
| {w=480px} | ||
| ::: | ||
|
|
||
| :::: |
There was a problem hiding this comment.
All of the information has been derived from the blog article, in order to set the stage for doing it better here. Effectively, using content that we provide elsewhere and bringing it into a better shape and layout.
The idea is to get to a canonical page like the one for DataGrip, that will include all the correct information for optimal usability of DBeaver with CrateDB. The previous section about DBeaver does not include any detailed information yet.
There was a problem hiding this comment.
We need to do at least two things here:
- @hlcianfagna and @hammerhead mentioned at Integrate: Add dedicated page about DataGrip #155 that the screenshots are all wrong and outdated. This should probably be refreshed.
- More detailed information about using DBeaver with CrateDB has been provided by @hlcianfagna at Asking about capabilities of the DBeaver integration crate-clients-tools#206 (comment). This should probably be added to the content of this page, other than commandeering it back to use the built-in integration for CrateDB?
Please let us know about anything else that you would like to see on this page, or send patches.
There was a problem hiding this comment.
That blog post is fairly outdated. There is a new CrateDB Connection in DBeaver for more than a year
dbeaver/dbeaver#20549
I am surprised there is no blog / community post about it.
There was a problem hiding this comment.
That blog post is fairly outdated. I am surprised there is no blog / community post about it.
I am not surprised. Around that time, many things started falling apart, stronger than before.
My intentions have been to wrap up the current status coming from dbeaver/dbeaver#20549 into a concise documentation page on our realms, like the one for DataGrip, which also was long overdue.
I didn't expect this would raise any significant attention, so I am extra happy you are joining here.
There was a problem hiding this comment.
Now, let's wrap it up into this document, if you agree? At GH-155, admonitions from @hlcianfagna and @hammerhead have mostly been about screenshots. Now, we see it is also about content, which might not be much, because everything works out of the box already?
So, what do you suggest? Just pick that single screenshot you added to the main PR description at dbeaver/dbeaver#20549 into the page, and call it a day?
If you like it, maybe you can share two more screenshots with me that reflect something along the lines of the DataGrip » Usage section, i.e. displaying a tree and a table, possibly showing an excerpt of sys.summits?
There was a problem hiding this comment.
I've just updated the patch based on a few suggestions and content floating around. Thanks for your support.
| :::{note} | ||
| A few data types of CrateDB need special considerations. | ||
| - `ARRAY` types are recognised as such in reads, also work for inserts through the GUI. | ||
| They need to use curly brackets syntax `{1,2}` instead of `[1,2]`. | ||
| - `OBJECT` types are seen as string, and are ok to insert via GUI. | ||
| - `GEO_POINT` types are seen as `STRING`, for insert through GUI, please use parentheses. | ||
| - `GEO_SHAPE` types are seen as `STRING`, are ok to insert via GUI. | ||
| - `FLOAT_VECTOR` types are seen as `ARRAY` on read, and can be inserted | ||
| using the GUI with same considerations as `ARRAY`s. | ||
| ::: |
There was a problem hiding this comment.
Thanks for providing this information per crate/crate-clients-tools#206 (comment), @hlcianfagna.
The same outcome has also been observed here, when verifying vanilla PostgreSQL connectivity support for CrateDB from .NET using Npgsql.
Please note this means it is just basic support that is provided here, because the standard driver does not support many special data types of CrateDB well. While this way of connecting to CrateDB works out of the box with DBeaver, which is a good thing, the CrateDB driver might provide better usability on some details.
There was a problem hiding this comment.
Outlook: We could possibly document those deviations at a single place, and then link to it, because it roughly outlines how basic PostgreSQL connectivity support for CrateDB is typically shaped and feels like.
amotl
requested review from
hammerhead,
hlcianfagna and
proddata
and removed request for
kneth,
proddata and
surister
About
Refactor an item from the Ecosystem Catalog into a dedicated page in the CrateDB Guide.
Preview
https://cratedb-guide--157.org.readthedocs.build/integrate/dbeaver/
References