|
1 | 1 | (connect)= |
2 | 2 | (connectivity)= |
3 | 3 |
|
4 | | - |
5 | 4 | # Connectivity |
6 | 5 |
|
7 | | -All the CrateDB connectivity options at a glance. |
| 6 | +:::{include} /_include/links.md |
| 7 | +::: |
8 | 8 |
|
9 | | -You have a variety of options to connect to CrateDB, and to integrate it with |
10 | | -off-the-shelve, 3rd-party, open-source, and proprietary applications. |
| 9 | +:::::{grid} |
| 10 | +:padding: 0 |
11 | 11 |
|
12 | | -{tags-primary}`Connect` |
13 | | -{tags-primary}`Import` |
14 | | -{tags-primary}`Export` |
15 | | -{tags-primary}`Extract` |
16 | | -{tags-primary}`Load` |
17 | | -{tags-primary}`ETL` |
| 12 | +::::{grid-item} |
| 13 | +:class: rubric-slimmer |
| 14 | +:columns: auto 9 9 9 |
18 | 15 |
|
19 | 16 |
|
20 | | -## Interfaces and Protocols |
| 17 | +:::{rubric} Overview |
| 18 | +::: |
| 19 | +CrateDB connectivity options at a glance. |
21 | 20 |
|
22 | | -CrateDB supports both the [HTTP protocol] and the [PostgreSQL wire protocol], |
| 21 | +You have a variety of options to connect to CrateDB, and to integrate it with |
| 22 | +off-the-shelve, 3rd-party, open-source, and proprietary applications. |
| 23 | + |
| 24 | +:::{rubric} About |
| 25 | +::: |
| 26 | +CrateDB supports both the HTTP protocol and the PostgreSQL wire protocol, |
23 | 27 | which ensures that many clients that work with PostgreSQL, will also work with |
24 | 28 | CrateDB. |
25 | 29 |
|
26 | | -Through corresponding drivers, CrateDB is compatible with [ODBC], |
27 | | -[JDBC], and other database API specifications. |
28 | | -By supporting [SQL], CrateDB is compatible with many standard database |
| 30 | +Through corresponding drivers, CrateDB is compatible with JDBC, ODBC, |
| 31 | +and other database API specifications. |
| 32 | +By supporting SQL, CrateDB is compatible with many standard database |
29 | 33 | environments out of the box. |
30 | 34 |
|
31 | | -- [CrateDB HTTP interface] |
32 | | -- [CrateDB PostgreSQL interface] |
33 | | -- [CrateDB SQL protocol] |
34 | | - |
35 | | -To learn more, please refer to the documentation sections about supported |
36 | | -client drivers, libraries, and frameworks, and corresponding tutorials. |
37 | | - |
38 | | - |
39 | | -## Drivers and Integrations |
| 35 | +:::{rubric} Details |
| 36 | +::: |
40 | 37 |
|
41 | 38 | CrateDB provides plenty of connectivity options with database drivers, |
42 | 39 | applications, and frameworks, in order to get time series data in and |
43 | 40 | out of CrateDB, and to connect to other applications. |
44 | 41 |
|
45 | | -- [Drivers and Integrations] |
46 | | -- [](inv:crate-clients-tools#connect) |
47 | | -- [](inv:crate-clients-tools#df) |
48 | | -- [](inv:crate-clients-tools#etl) |
49 | | -- [](inv:crate-clients-tools#metrics) |
| 42 | +To learn more, please refer to the documentation sections and hands-on |
| 43 | +tutorials about supported client drivers, libraries, and frameworks, |
| 44 | +and how to configure and use them with CrateDB optimally. |
| 45 | +:::: |
| 46 | + |
| 47 | + |
| 48 | +::::{grid-item} |
| 49 | +:class: rubric-slim |
| 50 | +:columns: auto 3 3 3 |
| 51 | + |
| 52 | +```{rubric} Reference Manual |
| 53 | +``` |
| 54 | +- [HTTP interface] |
| 55 | +- [PostgreSQL interface] |
| 56 | +- [SQL query syntax] |
| 57 | + |
| 58 | +```{rubric} Protocols and API Standards |
| 59 | +``` |
| 60 | +- [HTTP protocol] |
| 61 | +- [PostgreSQL wire protocol] |
| 62 | +- [JDBC] |
| 63 | +- [ODBC] |
| 64 | +- [SQL] |
| 65 | +:::: |
| 66 | + |
| 67 | +::::: |
| 68 | + |
| 69 | + |
| 70 | +## Synopsis |
| 71 | + |
| 72 | +In order to provide a CrateDB instance for testing purposes, use, for |
| 73 | +example, Docker. |
| 74 | +```shell |
| 75 | +docker run --rm -it --publish=4200:4200 --publish=5432:5432 crate/crate:nightly |
| 76 | +``` |
| 77 | +:::{tip} |
| 78 | +The [CrateDB Examples] repository also includes a collection of |
| 79 | +clear and concise examples how to connect to and work with CrateDB, |
| 80 | +using different environments, applications, or frameworks. |
| 81 | +::: |
50 | 82 |
|
51 | | -## Tutorials |
52 | 83 |
|
53 | | -Hands-on tutorials about CrateDB fundamentals about data I/O, as well as about |
54 | | -properly configuring and connecting relevant 3rd-party software components to |
55 | | -work optimally with CrateDB. |
| 84 | +## Learn |
56 | 85 |
|
57 | | -:::{rubric} Overview |
58 | | -::: |
59 | | -- [](#integrate) |
60 | | -- [](#etl) |
61 | | -- [](#integrate-metrics) |
62 | | -- [](#performance) |
| 86 | +::::{grid} 2 3 3 3 |
| 87 | +:padding: 0 |
63 | 88 |
|
64 | | -:::{rubric} Community Tutorials |
| 89 | +:::{grid-item-card} Ecosystem Catalog |
| 90 | +:link: catalog |
| 91 | +:link-type: ref |
| 92 | +:link-alt: Ecosystem Catalog |
| 93 | +:padding: 3 |
| 94 | +:class-card: sd-pt-3 |
| 95 | +:class-title: sd-fs-5 |
| 96 | +:class-body: sd-text-center |
| 97 | +:class-footer: text-smaller |
| 98 | +{material-outlined}`category;3.5em` |
| 99 | ++++ |
| 100 | +Explore all open-source and partner applications and solutions. |
65 | 101 | ::: |
66 | | -- [Community Tutorials Overview] |
67 | | -- [Fundamentals of the COPY FROM statement] |
68 | 102 |
|
| 103 | +:::{grid-item-card} Driver Support |
| 104 | +:link: crate-clients-tools:connect |
| 105 | +:link-type: ref |
| 106 | +:link-alt: Driver Support |
| 107 | +:padding: 3 |
| 108 | +:class-card: sd-pt-3 |
| 109 | +:class-title: sd-fs-5 |
| 110 | +:class-body: sd-text-center |
| 111 | +:class-footer: text-smaller |
| 112 | +{material-outlined}`link;3.5em` |
| 113 | ++++ |
| 114 | +List of HTTP and PostgreSQL client drivers, and tutorials. |
| 115 | +::: |
69 | 116 |
|
70 | | -:::{todo} |
71 | | -Bring page into the same shape as the others in this section. |
| 117 | +:::{grid-item-card} Integration Tutorials |
| 118 | +:link: integrate |
| 119 | +:link-type: ref |
| 120 | +:link-alt: Integration Tutorials |
| 121 | +:padding: 3 |
| 122 | +:class-card: sd-pt-3 |
| 123 | +:class-title: sd-fs-5 |
| 124 | +:class-body: sd-text-center |
| 125 | +:class-footer: text-smaller |
| 126 | +{material-outlined}`local_library;3.5em` |
| 127 | ++++ |
| 128 | +Learn how to integrate CrateDB with applications and tools. |
72 | 129 | ::: |
73 | 130 |
|
| 131 | +:::: |
| 132 | + |
| 133 | + |
74 | 134 |
|
75 | | -[Community Tutorials Overview]: https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015 |
76 | | -[CrateDB HTTP interface]: inv:crate-reference:*:label#interface-http |
77 | | -[CrateDB PostgreSQL interface]: inv:crate-reference:*:label#interface-postgresql |
78 | | -[CrateDB SQL protocol]: inv:crate-reference:*:label#sql |
79 | | -[Drivers and Integrations]: inv:crate-clients-tools:*:label#index |
80 | | -[Fundamentals of the COPY FROM statement]: https://community.cratedb.com/t/fundamentals-of-the-copy-from-statement/1178 |
| 135 | +[CrateDB Examples]: https://github.com/crate/cratedb-examples |
| 136 | +[Driver Support]: inv:crate-clients-tools:*:label#connect |
| 137 | +[Ecosystem Catalog]: inv:crate-clients-tools:*:label#index |
| 138 | +[HTTP interface]: inv:crate-reference:*:label#interface-http |
81 | 139 | [HTTP protocol]: https://en.wikipedia.org/wiki/HTTP |
82 | 140 | [JDBC]: https://en.wikipedia.org/wiki/Java_Database_Connectivity |
83 | 141 | [ODBC]: https://en.wikipedia.org/wiki/Open_Database_Connectivity |
| 142 | +[PostgreSQL interface]: inv:crate-reference:*:label#interface-postgresql |
84 | 143 | [PostgreSQL wire protocol]: https://www.postgresql.org/docs/current/protocol.html |
85 | 144 | [SQL]: https://en.wikipedia.org/wiki/Sql |
| 145 | +[SQL query syntax]: inv:crate-reference:*:label#sql |
| 146 | + |
| 147 | + |
| 148 | +```{include} /_include/styles.html |
| 149 | +``` |
0 commit comments