-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Integrate: Add dedicated page about DBeaver #157
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| (dbeaver)= | ||
| # DBeaver | ||
|
|
||
| :::{include} /_include/links.md | ||
| ::: | ||
|
|
||
| ```{div} | ||
| :style: "float: right; margin-left: 0.5em" | ||
| [{w=120px}](https://dbeaver.io/) | ||
| ``` | ||
|
|
||
| [DBeaver] is a multipurpose cross-platform database tool for developers, | ||
| database administrators, analysts, and everyone working with data. | ||
|
|
||
| It is available as an open-source version _DBeaver Community_ and | ||
| as a commercial version _DBeaver PRO_. | ||
|
|
||
|
|
||
| ## Connect | ||
|
|
||
| ::::{grid} 2 | ||
|
|
||
| :::{grid-item} | ||
| :columns: 7 | ||
| Please specify database URL and credentials of your CrateDB cluster. | ||
| For connecting to CrateDB, the standard [PostgreSQL JDBC Driver] | ||
| will be used. | ||
|
|
||
| When connecting to [CrateDB Self-Managed] on localhost, | ||
| for evaluation purposes, use: | ||
| ``` | ||
| jdbc:postgresql://localhost:5432/crate | ||
| ``` | ||
|
|
||
| When connecting to [CrateDB Cloud], use: | ||
| ``` | ||
| jdbc:postgresql://<clustername>.cratedb.net:5432/crate | ||
| ``` | ||
| ::: | ||
| :::{grid-item} | ||
| :columns: 5 | ||
| {w=480px} | ||
| ::: | ||
|
|
||
| :::: | ||
|
|
||
|
|
||
| ## Usage | ||
| Use the tree menu on the left-hand pane to navigate to the `doc` schema and | ||
| its tables. Navigate to the Data tab to browse your table data. | ||
|
|
||
| {h=240px} | ||
| {h=240px} | ||
|
|
||
|
|
||
| ## Learn | ||
|
|
||
| :::{rubric} Tutorials | ||
| ::: | ||
| - [Blog: Use CrateDB With DBeaver] | ||
|
|
||
| :::{rubric} Product | ||
| ::: | ||
| - [CrateDB and DBeaver] | ||
|
|
||
| :::{rubric} Notes | ||
| ::: | ||
| :::{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. | ||
| ::: | ||
| :::{note} | ||
| We are tracking interoperability issues per [Tool: DBeaver], and appreciate | ||
| any contributions and reports. | ||
| ::: | ||
|
|
||
|
|
||
| [Blog: Use CrateDB With DBeaver]: https://cratedb.com/blog/cratedb-dbeaver | ||
| [CrateDB and DBeaver]: https://cratedb.com/integrations/cratedb-and-dbeaver | ||
| [DBeaver]: https://dbeaver.io/ | ||
| [Tool: DBeaver]: https://github.com/crate/crate/labels/tool%3A%20DBeaver | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,4 +9,5 @@ database IDE (Integrated Development Environment) applications. | |
| :maxdepth: 2 | ||
|
|
||
| datagrip/index | ||
| dbeaver/index | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.