Skip to content

Commit f136e98

Browse files
committed
Connect: Improve index page
1 parent 961f5d8 commit f136e98

File tree

1 file changed

+30
-78
lines changed

1 file changed

+30
-78
lines changed

docs/connect/index.md

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

7-
This documentation section is about connecting your applications to CrateDB
8-
and CrateDB Cloud, using database drivers, compatibility adapters and dialects.
9-
107
:::::{grid}
118
:padding: 0
129

@@ -20,33 +17,27 @@ and CrateDB Cloud, using database drivers, compatibility adapters and dialects.
2017
CrateDB connectivity options at a glance.
2118

2219
You have a variety of options to connect to CrateDB, and to integrate it with
23-
off-the-shelf, 3rd-party, open-source, and proprietary applications.
20+
off-the-shelf, 3rd-party, open-source, and proprietary applications or frameworks.
2421

2522
:::{rubric} Protocol Support
2623
:::
2724
CrateDB supports both the HTTP protocol and the PostgreSQL wire protocol,
2825
which ensures that many clients that work with PostgreSQL, will also work with
29-
CrateDB. Through corresponding drivers, CrateDB is compatible with ODBC,
26+
CrateDB.
27+
28+
Through corresponding drivers, CrateDB is compatible with ODBC,
3029
JDBC, and other database API specifications. By supporting SQL, CrateDB is
3130
compatible with many standard database environments out of the box.
3231

32+
The HTTP protocol can be used to connect from environments where
33+
PostgreSQL-based communication is not applicable.
34+
35+
:::{rubric} Notes
36+
:::
3337
While it is generally recommended to use the PostgreSQL interface (PG) for maximum
3438
compatibility in PostgreSQL environments, the HTTP interface supports CrateDB
3539
bulk operations and BLOBs, which are not supported by the PostgreSQL
3640
protocol.
37-
38-
The HTTP protocol can also be used to connect from environments where
39-
PostgreSQL-based communication is not applicable.
40-
41-
:::{rubric} Details
42-
:::
43-
44-
CrateDB provides popular connectivity options with database drivers,
45-
applications, and frameworks.
46-
47-
To learn more, please refer to the documentation sections and hands-on
48-
tutorials about supported client drivers, libraries, and frameworks,
49-
and how to configure and use them with CrateDB optimally.
5041
::::
5142

5243

@@ -74,75 +65,36 @@ and how to configure and use them with CrateDB optimally.
7465
:::::
7566

7667

77-
::::{grid} 2 2 2 4
68+
:::::{grid} 1 2 2 2
69+
:margin: 4 4 0 0
7870
:padding: 0
71+
:gutter: 2
7972

80-
:::{grid-item-card}
81-
:columns: 12
82-
:link: connect-configure
83-
:link-type: ref
84-
:link-alt: Configure CrateDB connection string
85-
:padding: 3
86-
:class-card: sd-pt-1
87-
:class-footer: text-smaller
73+
::::{grid-item-card} {material-outlined}`lightbulb;2em` General information
74+
- {ref}`connect-configure`
8875

89-
Configure database URI
90-
+++
91-
In order to connect to CrateDB, your application or driver needs to be configured
92-
with corresponding connection properties. Please note that different applications
93-
and drivers may obtain connection properties in different formats.
94-
:::
76+
To connect to CrateDB, your application or driver needs to be configured
77+
with corresponding database URI and connection properties.
9578

96-
:::{grid-item-card}
97-
:columns: 12
98-
:link: connect-drivers
99-
:link-type: ref
100-
:link-alt: All drivers suitable for CrateDB
101-
:padding: 3
102-
:class-card: sd-pt-1
103-
:class-footer: text-smaller
79+
- {ref}`connect-drivers`
10480

105-
All drivers
81+
All available CrateDB drivers and adapters for supported programming languages,
82+
frameworks, and environments.
10683
+++
107-
Drivers and adapters for supported programming languages,
108-
frameworks, and environments.
109-
:::
110-
111-
:::{grid-item-card}
112-
:link: connect-java
113-
:link-type: ref
114-
:link-alt: Connect using Java
115-
:padding: 3
116-
:text-align: center
117-
:class-card: sd-pt-1
118-
119-
Java
120-
:::
121-
122-
:::{grid-item-card}
123-
:link: connect-javascript
124-
:link-type: ref
125-
:link-alt: Connect using JavaScript
126-
:padding: 3
127-
:text-align: center
128-
:class-card: sd-pt-1
129-
130-
JavaScript
131-
:::
132-
133-
:::{grid-item-card}
134-
:link: connect-python
135-
:link-type: ref
136-
:link-alt: Connect using Python
137-
:padding: 3
138-
:text-align: center
139-
:class-card: sd-pt-1
140-
141-
Python
142-
:::
84+
Database connectivity information.
85+
::::
14386

87+
::::{grid-item-card} {material-outlined}`lightbulb;2em` How to connect
88+
- {ref}`connect-java`
89+
- {ref}`connect-javascript`
90+
- {ref}`connect-php`
91+
- {ref}`connect-python`
92+
- {ref}`connect-ruby`
93+
+++
94+
Connection examples.
14495
::::
14596

97+
:::::
14698

14799
```{toctree}
148100
:maxdepth: 1

0 commit comments

Comments
 (0)