Skip to content

Commit 5e4c848

Browse files
committed
Connect/Java: Refurbish landing page
1 parent d443192 commit 5e4c848

File tree

2 files changed

+38
-25
lines changed

2 files changed

+38
-25
lines changed

docs/_include/logos.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<!-- markdownlint-disable MD034 -->
2+
<!-- markdownlint-disable MD053 -->
3+
4+
[CrateDB logo]: https://avatars.githubusercontent.com/u/4048232?s=200&v=4
5+
[Hibernate logo]: https://logo.svgcdn.com/devicon/hibernate-original.svg
6+
[jOOQ logo]: https://www.jooq.org/img/jooq-logo-black.png
7+
[JUnit logo]: https://avatars.githubusercontent.com/u/874086?s=200&v=4
8+
[PostgreSQL logo]: https://jdbc.postgresql.org/icons/postgreslogo.svg

docs/connect/java/index.md

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,85 +5,82 @@
55

66
:::{include} /_include/links.md
77
:::
8+
:::{include} /_include/logos.md
9+
:::
810

911
:::{div} sd-text-muted
10-
Java applications mostly use JDBC to connect to CrateDB.
12+
Connect to CrateDB and CrateDB Cloud from Java.
1113
:::
1214

13-
## Protocols
14-
15-
### JDBC
15+
## JDBC
1616

1717
:::{div}
18-
[JDBC] is a standard Java API that provides a common interface for accessing
18+
[JDBC] is the standard Java API that provides a common interface for accessing
1919
databases in Java.
2020
:::
2121

2222
:::{rubric} Driver options
2323
:::
2424

2525
:::{div}
26-
You have two JDBC driver options: The [PostgreSQL
27-
JDBC Driver] and the {ref}`crate-jdbc:index`.
26+
You have two JDBC driver options: The {ref}`postgresql-jdbc` Driver
27+
and the {ref}`cratedb-jdbc` Driver.
2828
PostgreSQL JDBC uses the `jdbc:postgresql://` protocol identifier,
2929
while CrateDB JDBC uses `jdbc:crate://`.
3030
:::
3131

3232
You are encouraged to probe the PostgreSQL JDBC Driver first. This is the
3333
most convenient option, specifically if the system you are connecting with
34-
already includes the driver jar.
34+
already includes the PostgreSQL driver JAR file, and you can't change it.
3535

3636
However, applications using the PostgreSQL JDBC Driver may emit PostgreSQL-specific
37-
SQL that CrateDB does not understand. Use the CrateDB JDBC Driver instead
37+
SQL that CrateDB does not understand, while the framework assumes the
38+
database would understand the PostgreSQL dialect completely.
39+
In this case, use the CrateDB JDBC Driver instead
3840
to ensure compatibility and allow downstream components to handle
3941
CrateDB-specific behavior, for example, by employing a CrateDB-specific
40-
SQL dialect implementation.
42+
SQL dialect implementation for their purposes and realms.
4143

4244
The {ref}`crate-jdbc:internals` page includes more information
4345
about compatibility and differences between the two driver variants,
4446
and more details about the CrateDB JDBC Driver.
4547

46-
### HTTP
47-
48-
You can also talk to CrateDB using HTTP, using any HTTP library of your choice.
49-
Below is a quick example using Apache Commons HTTP.
50-
51-
52-
## Driver list
48+
:::{rubric} Adapters and drivers
49+
:::
5350

5451
:::::{grid} 2 2 2 3
55-
:gutter: 3
52+
:gutter: 2
5653
:padding: 0
5754

58-
::::{grid-item-card} {fab}`java;fa-xl` PostgreSQL JDBC
55+
::::{grid-item-card} ![PostgreSQL logo][PostgreSQL logo]{height=40px} &nbsp; PostgreSQL JDBC
5956
:link: postgresql-jdbc
6057
:link-type: ref
6158
:link-alt: PostgreSQL JDBC (pgJDBC)
6259
The PostgreSQL JDBC driver.
6360
::::
6461

65-
::::{grid-item-card} {fab}`java;fa-xl` CrateDB JDBC
62+
::::{grid-item-card} ![CrateDB logo][CrateDB logo]{height=40px} &nbsp; CrateDB JDBC
6663
:link: cratedb-jdbc
6764
:link-type: ref
6865
:link-alt: CrateDB JDBC
6966
The CrateDB JDBC driver.
7067
::::
7168

72-
::::{grid-item-card} {fab}`hibernate` Hibernate
69+
::::{grid-item-card} ![Hibernate logo][Hibernate logo]{height=40px} &nbsp; Hibernate
7370
:link: hibernate
7471
:link-type: ref
7572
:link-alt: Hibernate with CrateDB
7673
A Quarkus/Panache example using Hibernate.
7774
::::
7875

79-
::::{grid-item-card} {fab}`jooq` jOOQ
80-
:link: hibernate
76+
::::{grid-item-card} ![jOOQ logo][jOOQ logo]{height=40px} &nbsp; jOOQ
77+
:link: jooq
8178
:link-type: ref
8279
:link-alt: jOOQ with CrateDB
8380
A jOOQ example.
8481
::::
8582

86-
::::{grid-item-card} {fab}`junit` Software testing
83+
::::{grid-item-card} ![JUnit logo][JUnit logo]{height=40px} &nbsp; Software testing
8784
:link: java-testing
8885
:link-type: ref
8986
:link-alt: Software testing with CrateDB and Java
@@ -92,7 +89,15 @@ JUnit and Testcontainers for CrateDB.
9289

9390
:::::
9491

95-
{material-outlined}`apps;2em`
92+
## HTTP
93+
94+
You can also talk to CrateDB using HTTP, using any HTTP library of your choice.
95+
Below is a quick example using Apache Commons HTTP.
96+
97+
:::{todo}
98+
Add example.
99+
:::
100+
96101

97102
:::{toctree}
98103
:maxdepth: 1

0 commit comments

Comments
 (0)