Skip to content

Commit 58267b2

Browse files
committed
Integrate: Add dedicated page about DBeaver
1 parent bec1b9a commit 58267b2

File tree

4 files changed

+90
-1
lines changed

4 files changed

+90
-1
lines changed

docs/_include/links.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
[cloud-datashader-github]: https://github.com/crate/cratedb-examples/blob/amo/cloud-datashader/topic/timeseries/explore/cloud-datashader.ipynb
88
[CTE]: inv:crate-reference#sql_dql_with
99
[CrateDB Cloud]: https://cratedb.com/product/cloud
10+
[CrateDB JDBC Driver]: https://cratedb.com/docs/jdbc/
1011
[CrateDB Self-Managed]: https://cratedb.com/product/self-managed
1112
[CrateDB's PostgreSQL interface]: inv:crate-reference#interface-postgresql
1213
[crate-jdbc-standalone]: https://repo1.maven.org/maven2/io/crate/crate-jdbc-standalone/
@@ -41,6 +42,7 @@
4142
[Multi-model Database]: https://cratedb.com/solutions/multi-model-database
4243
[nearest neighbor search]: https://en.wikipedia.org/wiki/Nearest_neighbor_search
4344
[Nested Data Structure]: https://cratedb.com/product/features/nested-data-structure
45+
[PostgreSQL JDBC Driver]: https://jdbc.postgresql.org/
4446
[query DSL based on JSON]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
4547
[RANK]: inv:crate-reference#window-functions-rank
4648
[Relational Database]: https://cratedb.com/solutions/relational-database

docs/integrate/datagrip/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,5 @@ any contributions and reports.
9797

9898
[Blog: Use CrateDB With DataGrip]: https://cratedb.com/blog/use-cratedb-with-datagrip-an-advanced-database-ide
9999
[CrateDB and DataGrip]: https://cratedb.com/integrations/cratedb-and-datagrip
100-
[CrateDB JDBC Driver]: https://cratedb.com/docs/jdbc/
101100
[DataGrip]: https://www.jetbrains.com/datagrip/
102101
[Tool: DataGrip]: https://github.com/crate/crate/labels/tool%3A%20DataGrip

docs/integrate/dbeaver/index.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
(dbeaver)=
2+
# DBeaver
3+
4+
:::{include} /_include/links.md
5+
:::
6+
7+
```{div}
8+
:style: "float: right; margin-left: 0.5em"
9+
[![](https://upload.wikimedia.org/wikipedia/commons/thumb/b/b5/DBeaver_logo.svg/512px-DBeaver_logo.svg.png){w=120px}](https://dbeaver.io/)
10+
```
11+
12+
[DBeaver] is a multipurpose cross-platform database tool for developers,
13+
database administrators, analysts, and everyone working with data.
14+
15+
It is available as an open-source version _DBeaver Community_ and
16+
as a commercial version _DBeaver PRO_.
17+
18+
19+
## Connect
20+
21+
::::{grid} 2
22+
23+
:::{grid-item}
24+
:columns: 7
25+
Please specify database URL and credentials of your CrateDB cluster.
26+
For connecting to CrateDB, the standard [PostgreSQL JDBC Driver]
27+
will be used.
28+
29+
When connecting to [CrateDB Self-Managed] on localhost,
30+
for evaluation purposes, use:
31+
```
32+
jdbc:postgresql://localhost:5432/crate
33+
```
34+
35+
When connecting to [CrateDB Cloud], use:
36+
```
37+
jdbc:postgresql://<clustername>.cratedb.net:5432/crate
38+
```
39+
:::
40+
:::{grid-item}
41+
:columns: 5
42+
![Image](https://github.com/user-attachments/assets/630fcc7c-21c5-4070-be72-e38041c19d8e){w=480px}
43+
:::
44+
45+
::::
46+
47+
48+
## Usage
49+
Use the tree menu on the left-hand pane to navigate to the `doc` schema and
50+
its tables. Navigate to the Data tab to browse your table data.
51+
52+
![Image](https://cratedb.com/hs-fs/hubfs/Screen-Shot-2019-04-05-at-17.15.05.png?width=1600&name=Screen-Shot-2019-04-05-at-17.15.05.png){h=240px}
53+
![Image](https://cratedb.com/hs-fs/hubfs/Screen-Shot-2019-04-05-at-17.15.13.png?width=1600&name=Screen-Shot-2019-04-05-at-17.15.13.png){h=240px}
54+
55+
56+
## Learn
57+
58+
:::{rubric} Tutorials
59+
:::
60+
- [Blog: Use CrateDB With DBeaver]
61+
62+
:::{rubric} Product
63+
:::
64+
- [CrateDB and DBeaver]
65+
66+
:::{rubric} Notes
67+
:::
68+
:::{note}
69+
A few data types of CrateDB need special considerations.
70+
- `ARRAY` types are recognised as such in reads, also work for inserts through the GUI.
71+
They need to use curly brackets syntax `{1,2}` instead of `[1,2]`.
72+
- `OBJECT` types are seen as string, and are ok to insert via GUI.
73+
- `GEO_POINT` types are seen as `STRING`, for insert through GUI, please use parentheses.
74+
- `GEO_SHAPE` types are seen as `STRING`, are ok to insert via GUI.
75+
- `FLOAT_VECTOR` types are seen as `ARRAY` on read, and can be inserted
76+
using the GUI with same considerations as `ARRAY`s.
77+
:::
78+
:::{note}
79+
We are tracking interoperability issues per [Tool: DBeaver], and appreciate
80+
any contributions and reports.
81+
:::
82+
83+
84+
[Blog: Use CrateDB With DBeaver]: https://cratedb.com/blog/cratedb-dbeaver
85+
[CrateDB and DBeaver]: https://cratedb.com/integrations/cratedb-and-dbeaver
86+
[DBeaver]: https://dbeaver.io/
87+
[Tool: DBeaver]: https://github.com/crate/crate/labels/tool%3A%20DBeaver

docs/integrate/ide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ database IDE (Integrated Development Environment) applications.
99
:maxdepth: 2
1010
1111
datagrip/index
12+
dbeaver/index
1213
```

0 commit comments

Comments
 (0)