|
| 1 | +(guides)= |
| 2 | +(howtos)= |
| 3 | +(tutorials)= |
| 4 | +(use-more-tutorials)= |
| 5 | + |
| 6 | +# Handbook |
| 7 | + |
| 8 | +Guides and tutorials about how to use CrateDB and CrateDB Cloud in practice. |
| 9 | + |
| 10 | + |
| 11 | +::::{grid} 4 |
| 12 | +:padding: 0 |
| 13 | + |
| 14 | +:::{grid-item-card} Installation |
| 15 | +:link: install |
| 16 | +:link-type: ref |
| 17 | +:link-alt: Installing CrateDB |
| 18 | +:padding: 1 |
| 19 | +:text-align: center |
| 20 | +:class-card: sd-pt-3 |
| 21 | +:class-body: sd-fs-1 |
| 22 | +:class-title: sd-fs-5 |
| 23 | + |
| 24 | +{material-outlined}`download_for_offline;1.3em` |
| 25 | +::: |
| 26 | + |
| 27 | + |
| 28 | +:::{grid-item-card} Administration |
| 29 | +:link: administration |
| 30 | +:link-type: ref |
| 31 | +:link-alt: CrateDB Administration |
| 32 | +:padding: 1 |
| 33 | +:text-align: center |
| 34 | +:class-card: sd-pt-3 |
| 35 | +:class-body: sd-fs-1 |
| 36 | +:class-title: sd-fs-5 |
| 37 | + |
| 38 | +{material-outlined}`auto_stories;1.3em` |
| 39 | +::: |
| 40 | + |
| 41 | + |
| 42 | +:::{grid-item-card} Performance Guides |
| 43 | +:link: performance |
| 44 | +:link-type: ref |
| 45 | +:link-alt: CrateDB Performance Guides |
| 46 | +:padding: 1 |
| 47 | +:text-align: center |
| 48 | +:class-card: sd-pt-3 |
| 49 | +:class-body: sd-fs-1 |
| 50 | +:class-title: sd-fs-5 |
| 51 | + |
| 52 | +{material-outlined}`speed;1.3em` |
| 53 | +::: |
| 54 | + |
| 55 | + |
| 56 | +:::: |
| 57 | + |
| 58 | + |
| 59 | +## Features |
| 60 | + |
| 61 | +:::{rubric} Highlights |
| 62 | +::: |
| 63 | + |
| 64 | +::::{grid} 1 2 3 3 |
| 65 | +:padding: 0 |
| 66 | + |
| 67 | +:::{grid-item-card} Document Store |
| 68 | +:link: document |
| 69 | +:link-type: ref |
| 70 | +:link-alt: Storing JSON documents using CrateDB's `OBJECT` data type |
| 71 | +:padding: 3 |
| 72 | +:text-align: center |
| 73 | +:class-card: sd-pt-3 |
| 74 | +:class-body: sd-fs-1 |
| 75 | +:class-title: sd-fs-5 |
| 76 | + |
| 77 | +{material-outlined}`article;1.3em` |
| 78 | +::: |
| 79 | + |
| 80 | +:::{grid-item-card} Search |
| 81 | +:link: search-overview |
| 82 | +:link-type: ref |
| 83 | +:link-alt: About CrateDB's search capabilities |
| 84 | +:padding: 3 |
| 85 | +:text-align: center |
| 86 | +:class-card: sd-pt-3 |
| 87 | +:class-body: sd-fs-1 |
| 88 | +:class-title: sd-fs-5 |
| 89 | + |
| 90 | +{material-outlined}`manage_search;1.3em` |
| 91 | +::: |
| 92 | + |
| 93 | +:::{grid-item-card} Advanced Querying |
| 94 | +:link: advanced-querying |
| 95 | +:link-type: ref |
| 96 | +:link-alt: About CrateDB's advanced querying capabilities |
| 97 | +:padding: 3 |
| 98 | +:text-align: center |
| 99 | +:class-card: sd-pt-3 |
| 100 | +:class-body: sd-fs-1 |
| 101 | +:class-title: sd-fs-5 |
| 102 | + |
| 103 | +{material-outlined}`engineering;1.3em` |
| 104 | +::: |
| 105 | + |
| 106 | +:::: |
| 107 | + |
| 108 | +:::{card} All features |
| 109 | +:link: all-features |
| 110 | +:link-type: ref |
| 111 | + |
| 112 | +CrateDB is a distributed and scalable SQL database for storing and analyzing |
| 113 | +massive amounts of data in near real-time, even with complex queries. It is |
| 114 | +based on Lucene, combines a unique set of features, and is PostgreSQL-compatible. |
| 115 | + |
| 116 | + |
| 117 | ++++ |
| 118 | +Read about all features of CrateDB at a glance. |
| 119 | +::: |
| 120 | + |
| 121 | + |
| 122 | +## Data ingestion |
| 123 | + |
| 124 | +Load data into CrateDB. |
| 125 | + |
| 126 | +::::{grid} 1 2 3 3 |
| 127 | +:padding: 0 |
| 128 | + |
| 129 | +:::{grid-item-card} ETL |
| 130 | +:link: etl |
| 131 | +:link-type: ref |
| 132 | +:link-alt: Load and export data into/from CrateDB |
| 133 | +:padding: 3 |
| 134 | +:text-align: center |
| 135 | +:class-card: sd-pt-3 |
| 136 | +:class-body: sd-fs-1 |
| 137 | +:class-title: sd-fs-5 |
| 138 | + |
| 139 | +{material-outlined}`transform;1.3em` |
| 140 | +::: |
| 141 | + |
| 142 | +:::{grid-item-card} CDC |
| 143 | +:link: cdc |
| 144 | +:link-type: ref |
| 145 | +:link-alt: Change Data Capture (CDC) into CrateDB |
| 146 | +:padding: 3 |
| 147 | +:text-align: center |
| 148 | +:class-card: sd-pt-3 |
| 149 | +:class-body: sd-fs-1 |
| 150 | +:class-title: sd-fs-5 |
| 151 | + |
| 152 | +{material-outlined}`double_arrow;1.3em` |
| 153 | +::: |
| 154 | + |
| 155 | +:::{grid-item-card} Telemetry |
| 156 | +:link: telemetry |
| 157 | +:link-type: ref |
| 158 | +:link-alt: Use CrateDB with metrics collection agents, brokers, and stores |
| 159 | +:padding: 3 |
| 160 | +:text-align: center |
| 161 | +:class-card: sd-pt-3 |
| 162 | +:class-body: sd-fs-1 |
| 163 | +:class-title: sd-fs-5 |
| 164 | + |
| 165 | +{material-outlined}`query_stats;1.3em` |
| 166 | +::: |
| 167 | + |
| 168 | +:::: |
| 169 | + |
| 170 | + |
| 171 | +## Solutions |
| 172 | + |
| 173 | +Learn how others are using CrateDB successfully. |
| 174 | + |
| 175 | +::::{grid} 1 2 3 3 |
| 176 | +:padding: 0 |
| 177 | + |
| 178 | +:::{grid-item-card} Solutions and use cases |
| 179 | +:link: solutions |
| 180 | +:link-type: ref |
| 181 | +:link-alt: Solutions built with CrateDB |
| 182 | +:padding: 1 |
| 183 | +:text-align: center |
| 184 | +:class-card: sd-pt-3 |
| 185 | +:class-body: sd-fs-1 |
| 186 | +:class-title: sd-fs-5 |
| 187 | + |
| 188 | +{material-outlined}`lightbulb;1.3em` |
| 189 | +::: |
| 190 | + |
| 191 | +:::: |
| 192 | + |
| 193 | + |
| 194 | +## Topics |
| 195 | + |
| 196 | +Learn how to apply CrateDB's features to optimally cover use-cases across different |
| 197 | +application and topic domains, for example, by connecting CrateDB with third-party |
| 198 | +software applications, libraries, and frameworks. |
| 199 | + |
| 200 | +::::{grid} 1 2 3 3 |
| 201 | +:padding: 0 |
| 202 | + |
| 203 | + |
| 204 | +:::{grid-item-card} Business Intelligence |
| 205 | +:link: bi |
| 206 | +:link-type: ref |
| 207 | +:link-alt: Analyse information with CrateDB |
| 208 | +:padding: 3 |
| 209 | +:text-align: center |
| 210 | +:class-card: sd-pt-3 |
| 211 | +:class-body: sd-fs-1 |
| 212 | +:class-title: sd-fs-5 |
| 213 | + |
| 214 | +{material-outlined}`analytics;1.3em` |
| 215 | +::: |
| 216 | + |
| 217 | +:::{grid-item-card} Data Visualization |
| 218 | +:link: visualization |
| 219 | +:link-type: ref |
| 220 | +:link-alt: Data visualization with CrateDB |
| 221 | +:padding: 3 |
| 222 | +:text-align: center |
| 223 | +:class-card: sd-pt-3 |
| 224 | +:class-body: sd-fs-1 |
| 225 | +:class-title: sd-fs-5 |
| 226 | + |
| 227 | +{material-outlined}`bar_chart;1.3em` |
| 228 | +::: |
| 229 | + |
| 230 | + |
| 231 | +:::{grid-item-card} Machine Learning |
| 232 | +:link: machine-learning |
| 233 | +:link-type: ref |
| 234 | +:link-alt: Machine Learning with CrateDB |
| 235 | +:padding: 3 |
| 236 | +:text-align: center |
| 237 | +:class-card: sd-pt-3 |
| 238 | +:class-body: sd-fs-1 |
| 239 | +:class-title: sd-fs-5 |
| 240 | + |
| 241 | +{material-outlined}`model_training;1.3em` |
| 242 | +::: |
| 243 | + |
| 244 | + |
| 245 | +:::{grid-item-card} Software Testing |
| 246 | +:link: testing |
| 247 | +:link-type: ref |
| 248 | +:link-alt: Software testing with CrateDB |
| 249 | +:padding: 3 |
| 250 | +:text-align: center |
| 251 | +:class-card: sd-pt-3 |
| 252 | +:class-body: sd-fs-1 |
| 253 | +:class-title: sd-fs-5 |
| 254 | + |
| 255 | +{material-outlined}`integration_instructions;1.3em` |
| 256 | +::: |
| 257 | + |
| 258 | + |
| 259 | +:::{grid-item-card} Time Series Data |
| 260 | +:link: timeseries |
| 261 | +:link-type: ref |
| 262 | +:link-alt: Managing Time Series Data with CrateDB |
| 263 | +:padding: 3 |
| 264 | +:text-align: center |
| 265 | +:class-card: sd-pt-3 |
| 266 | +:class-body: sd-fs-1 |
| 267 | +:class-title: sd-fs-5 |
| 268 | + |
| 269 | +{material-outlined}`stacked_line_chart;1.3em` |
| 270 | +::: |
| 271 | + |
| 272 | + |
| 273 | +:::: |
| 274 | + |
| 275 | + |
| 276 | +```{toctree} |
| 277 | +:hidden: |
| 278 | +
|
| 279 | +../install/index |
| 280 | +../connect/index |
| 281 | +../feature/index |
| 282 | +Ingestion <../ingest/index> |
| 283 | +../topic/index |
| 284 | +Solutions <../solution/index> |
| 285 | +../integrate/index |
| 286 | +../admin/index |
| 287 | +../performance/index |
| 288 | +``` |
0 commit comments