Skip to content

Commit 23fcc7b

Browse files
amotlamotl
committed
Integrate: Add dedicated pages about DataGrip and DBeaver
1 parent 7aac0f4 commit 23fcc7b

File tree

4 files changed

+212
-1
lines changed

4 files changed

+212
-1
lines changed

‎docs/integrate/datagrip/index.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
(datagrip)=
2+
# DataGrip
3+
4+
```{div}
5+
:style: "float: right; margin-left: 0.5em"
6+
[![](https://blog.jetbrains.com/wp-content/uploads/2019/01/datagrip_icon.svg){w=120px}](https://www.jetbrains.com/datagrip/)
7+
```
8+
9+
[DataGrip] is a cross-platform database IDE that is tailored to suit the
10+
specific needs of professional SQL developers.
11+
12+
It is available as a standalone application and is also included into
13+
other JetBrains products like IntelliJ IDEA and PyCharm.
14+
15+
Connecting DataGrip to CrateDB uses the [CrateDB JDBC Driver].
16+
17+
```{div}
18+
:style: "clear: both"
19+
```
20+
21+
22+
## Install
23+
24+
::::{grid} 2
25+
:::{grid-item}
26+
For connecting to CrateDB, install the [CrateDB JDBC Driver]
27+
using the "Custom JARs" option when adding a database driver.
28+
:::
29+
:::{grid-item}
30+
![Image](https://github.com/user-attachments/assets/a8c1ada6-fd97-43f4-a1ba-91aba1520bdb){h=180px}
31+
![Image](https://github.com/user-attachments/assets/1f925848-fac3-4265-8bd3-96f91daf03c9){h=180px}
32+
:::
33+
:::{grid-item}
34+
[crate-jdbc-standalone] is the right choice here.
35+
For example, download and use the [crate-jdbc-standalone-2.7.0.jar] JAR file,
36+
and select the driver class `io.crate.client.jdbc.CrateDriver`.
37+
:::
38+
:::{grid-item}
39+
![Image](https://github.com/user-attachments/assets/50ccb304-5aaf-4f0b-8ae7-55445f06930c){w=400px}
40+
:::
41+
::::
42+
43+
44+
## Connect
45+
46+
::::{grid} 2
47+
48+
:::{grid-item}
49+
Now, you can add a Data Source using the CrateDB database driver.
50+
Please specify database URL and credentials of your CrateDB cluster.
51+
:::
52+
:::{grid-item}
53+
![Image](https://github.com/user-attachments/assets/147a3e8e-f1d7-413d-9e0c-1ced11333646){w=480px}
54+
:::
55+
:::{grid-item}
56+
When connecting to [CrateDB Self-Managed] on localhost,
57+
for evaluation purposes, use:
58+
```
59+
jdbc:crate://localhost:5432/
60+
```
61+
62+
When connecting to [CrateDB Cloud], use:
63+
```
64+
jdbc:crate://<clustername>.cratedb.net:5432/
65+
```
66+
:::
67+
:::{grid-item}
68+
![Image](https://github.com/user-attachments/assets/c929aa64-f032-451c-9f9d-45e6aebb12e5){w=480px}
69+
:::
70+
71+
::::
72+
73+
74+
## Usage
75+
After refreshing, you can browse the data tree, and use the Query Console.
76+
77+
![Image](https://github.com/user-attachments/assets/3350a955-0a53-41d7-905b-a71cc4a767e9){h=240px}
78+
![Image](https://github.com/user-attachments/assets/d0a2a09d-a59f-4eda-a488-09d5ce15c08d){h=240px}
79+
80+
81+
82+
## Learn
83+
84+
:::{rubric} Tutorials
85+
:::
86+
- [Blog: Use CrateDB With DataGrip]
87+
88+
:::{rubric} Product
89+
:::
90+
- [CrateDB and DataGrip]
91+
92+
:::{rubric} Notes
93+
:::
94+
:::{note}
95+
We are tracking interoperability issues per [Tool: DataGrip], and appreciate
96+
any contributions and reports.
97+
:::
98+
99+
100+
[Blog: Use CrateDB With DataGrip]: https://cratedb.com/blog/use-cratedb-with-datagrip-an-advanced-database-ide
101+
[CrateDB and DataGrip]: https://cratedb.com/integrations/cratedb-and-datagrip
102+
[CrateDB Cloud]: https://cratedb.com/product/cloud
103+
[CrateDB JDBC Driver]: https://cratedb.com/docs/jdbc/
104+
[CrateDB Self-Managed]: https://cratedb.com/product/self-managed
105+
[crate-jdbc-standalone]: https://repo1.maven.org/maven2/io/crate/crate-jdbc-standalone/
106+
[crate-jdbc-standalone-2.7.0.jar]: https://repo1.maven.org/maven2/io/crate/crate-jdbc-standalone/2.7.0/crate-jdbc-standalone-2.7.0.jar
107+
[DataGrip]: https://www.jetbrains.com/datagrip/
108+
[Tool: DataGrip]: https://github.com/crate/crate/labels/tool%3A%20DataGrip

‎docs/integrate/dbeaver/index.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
(dbeaver)=
2+
# DBeaver
3+
4+
```{div}
5+
:style: "float: right; margin-left: 0.5em"
6+
[![](https://upload.wikimedia.org/wikipedia/commons/thumb/b/b5/DBeaver_logo.svg/512px-DBeaver_logo.svg.png){w=120px}](https://dbeaver.io/)
7+
```
8+
9+
[DBeaver] is a multipurpose cross-platform database tool for developers,
10+
database administrators, analysts, and everyone working with data.
11+
12+
It is available as an open-source version _DBeaver Community_ and
13+
as a commercial version _DBeaver PRO_.
14+
15+
16+
## Install
17+
18+
::::{grid} 2
19+
:::{grid-item}
20+
For connecting to CrateDB, the [CrateDB JDBC Driver] will be used.
21+
:::
22+
:::{grid-item}
23+
![Image](https://github.com/user-attachments/assets/ebd11a53-4d4a-4a9b-bed2-25909e618929){w=480px}
24+
:::
25+
::::
26+
27+
28+
## Connect
29+
30+
::::{grid} 2
31+
32+
:::{grid-item}
33+
Please specify database URL and credentials of your CrateDB cluster.
34+
35+
When connecting to [CrateDB Self-Managed] on localhost,
36+
for evaluation purposes, use:
37+
```
38+
jdbc:crate://localhost:5432/
39+
```
40+
41+
When connecting to [CrateDB Cloud], use:
42+
```
43+
jdbc:crate://<clustername>.cratedb.net:5432/
44+
```
45+
:::
46+
:::{grid-item}
47+
![Image](https://github.com/user-attachments/assets/3288ab3f-a70a-42db-8b99-051ea3051c84){w=480px}
48+
:::
49+
:::{grid-item}
50+
When selecting CrateDB, drivers will be downloaded automatically
51+
on the first use.
52+
53+
Alternatively, download and use the [crate-jdbc-standalone-2.7.0.jar] JAR file,
54+
and select the driver class `io.crate.client.jdbc.CrateDriver`.
55+
:::
56+
:::{grid-item}
57+
![Image](https://github.com/user-attachments/assets/5436f893-06d8-433f-94b3-72dddb5a13e1){w=480px}
58+
:::
59+
60+
::::
61+
62+
63+
## Usage
64+
Use the tree menu on the left-hand pane to navigate to the `doc` schema and
65+
its tables. Navigate to the Data tab to browse your table data.
66+
67+
![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}
68+
![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}
69+
70+
71+
72+
## Learn
73+
74+
:::{rubric} Tutorials
75+
:::
76+
- [Blog: Use CrateDB With DBeaver]
77+
78+
:::{rubric} Product
79+
:::
80+
- [CrateDB and DBeaver]
81+
82+
83+
[Blog: Use CrateDB With DBeaver]: https://cratedb.com/blog/cratedb-dbeaver
84+
[CrateDB and DBeaver]: https://cratedb.com/integrations/cratedb-and-dbeaver
85+
[CrateDB Cloud]: https://cratedb.com/product/cloud
86+
[CrateDB JDBC Driver]: https://cratedb.com/docs/jdbc/
87+
[CrateDB Self-Managed]: https://cratedb.com/product/self-managed
88+
[crate-jdbc-standalone]: https://repo1.maven.org/maven2/io/crate/crate-jdbc-standalone/
89+
[crate-jdbc-standalone-2.7.0.jar]: https://repo1.maven.org/maven2/io/crate/crate-jdbc-standalone/2.7.0/crate-jdbc-standalone-2.7.0.jar
90+
[DBeaver]: https://dbeaver.io/

‎docs/integrate/ide.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
(ide)=
2+
3+
# Database IDEs
4+
5+
Mostly through its PostgreSQL interface, CrateDB supports working with popular
6+
database IDE (Integrated Development Environment) applications.
7+
8+
```{toctree}
9+
:maxdepth: 2
10+
11+
datagrip/index
12+
dbeaver/index
13+
```

‎docs/integrate/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ This documentation section lists applications, frameworks, and libraries,
99
which can be used together with CrateDB, and outlines how to use them
1010
optimally.
1111

12-
1312
```{toctree}
1413
:maxdepth: 2
1514
15+
ide
1616
orm
1717
df
1818
etl/index

0 commit comments

Comments
 (0)