Skip to content

Commit 7822ba0

Browse files
committed
Connect: Improve guidance re. learning path and reference styles
1 parent 94dfc73 commit 7822ba0

File tree

1 file changed

+61
-55
lines changed

1 file changed

+61
-55
lines changed

docs/connect/index.md

Lines changed: 61 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -4,66 +4,17 @@
44
:::{include} /_include/links.md
55
:::
66

7-
:::::{grid}
8-
:padding: 0
9-
10-
::::{grid-item}
11-
:class: rubric-slimmer
12-
:columns: auto 9 9 9
13-
14-
15-
:::{rubric} Overview
16-
:::
7+
:::{div} sd-text-muted
178
CrateDB connectivity options at a glance.
18-
19-
You have a variety of options to connect to CrateDB, and to integrate it with
20-
off-the-shelf, 3rd-party, open-source, and proprietary applications or frameworks.
21-
22-
:::{rubric} Protocol Support
239
:::
24-
CrateDB supports both the HTTP protocol and the PostgreSQL wire protocol,
25-
which ensures that many clients that work with PostgreSQL, will also work with
26-
CrateDB.
27-
28-
Through corresponding drivers, CrateDB is compatible with ODBC,
29-
JDBC, and other database API specifications. By supporting SQL, CrateDB is
30-
compatible with many standard database environments out of the box.
31-
32-
The HTTP protocol can be used to connect from environments where
33-
PostgreSQL-based communication is not applicable.
34-
35-
:::{rubric} Notes
36-
:::
37-
While it is generally recommended to use the PostgreSQL interface (PG) for maximum
38-
compatibility in PostgreSQL environments, the HTTP interface supports CrateDB
39-
bulk operations and BLOBs, which are not supported by the PostgreSQL
40-
protocol.
41-
::::
42-
43-
44-
::::{grid-item}
45-
:class: rubric-slim
46-
:columns: auto 3 3 3
47-
48-
```{rubric} Reference
49-
```
50-
- [HTTP interface]
51-
- [PostgreSQL interface]
52-
53-
```{rubric} Related
54-
```
55-
- [Authentication]
56-
- [SQL query syntax]
57-
- [Bulk operations]
58-
- [BLOB support][CrateDB BLOBs]
59-
- {ref}`All drivers <connect-drivers>`
60-
::::
61-
62-
:::::
6310

11+
Choose from a variety of options to connect to CrateDB, and to integrate it with
12+
off-the-shelf, third-party, open-source, and proprietary applications, drivers,
13+
and frameworks.
6414

6515
:::{rubric} Get started
6616
:::
17+
6718
To get started,
6819
please learn about typical connection URI formats for CrateDB and its
6920
default client applications.
@@ -76,7 +27,7 @@ default client applications.
7627
:link: connect-configure
7728
:link-type: ref
7829
:link-alt: CrateDB connect URI
79-
Database URI and connection properties.
30+
Database URI and connection properties for different drivers.
8031
::::
8132

8233
::::{grid-item-card} {material-outlined}`apps;2em` Applications
@@ -91,6 +42,7 @@ Use CLI programs or database IDEs to connect to CrateDB.
9142

9243
:::{rubric} Drivers by language
9344
:::
45+
9446
CrateDB drivers and adapters for supported programming languages, frameworks, and environments.
9547

9648
:::::{grid} 2 2 2 4
@@ -164,6 +116,60 @@ CrateDB drivers and adapters for supported programming languages, frameworks, an
164116
:::::
165117

166118

119+
:::{rubric} Protocol Support
120+
:::
121+
122+
CrateDB supports both the HTTP protocol and the PostgreSQL wire protocol,
123+
which ensures that many clients that work with PostgreSQL, will also work with
124+
CrateDB.
125+
126+
Through corresponding drivers, CrateDB is compatible with ODBC,
127+
JDBC, and other database API specifications. By supporting SQL, CrateDB is
128+
compatible with many standard database environments out of the box.
129+
130+
The HTTP protocol can be used to connect from environments where
131+
PostgreSQL-based communication is not applicable.
132+
133+
:::{note}
134+
While it is generally recommended to use the PostgreSQL interface (PG) for maximum
135+
compatibility in PostgreSQL environments, the HTTP interface supports CrateDB
136+
bulk operations and BLOBs, which are not supported by the PostgreSQL
137+
protocol.
138+
:::
139+
140+
:::{rubric} Further reading
141+
:::
142+
143+
:::::{grid} 1 3 3 3
144+
:margin: 4 4 0 0
145+
:padding: 0
146+
:gutter: 2
147+
148+
::::{grid-item-card} {material-outlined}`article;1.5em` Documentation
149+
:columns: 3
150+
- [HTTP interface]
151+
- [PostgreSQL interface]
152+
::::
153+
154+
::::{grid-item-card} {material-outlined}`link;1.5em` Related
155+
:columns: 3
156+
- [Authentication]
157+
- [SQL query syntax]
158+
- [Bulk operations]
159+
- [BLOB support][CrateDB BLOBs]
160+
::::
161+
162+
::::{grid-item-card} {material-outlined}`read_more;1.5em` Read more
163+
:columns: 6
164+
- {ref}`All drivers <connect-drivers>`
165+
- {ref}`All integrations <integrate>`
166+
- {ref}`Ingestion methods <ingest>`
167+
- {ref}`connect-natural`
168+
::::
169+
170+
:::::
171+
172+
167173
```{toctree}
168174
:maxdepth: 1
169175
:hidden:

0 commit comments

Comments
 (0)