diff --git a/docs/connect/application.md b/docs/connect/application.md index 4e228a47..4ebf1f0f 100644 --- a/docs/connect/application.md +++ b/docs/connect/application.md @@ -9,12 +9,92 @@ Connect to CrateDB from database shells and IDEs. ::: +:::{rubric} Admin Tools +::: + +Learn about the fundamental tools that support working directly with CrateDB. + +::::{grid} 2 2 2 4 +:gutter: 3 +:padding: 0 + +:::{grid-item-card} CrateDB Admin UI +:link: use-admin-ui +:link-type: ref +:link-alt: The CrateDB Admin UI +:padding: 2 +:class-card: sd-pt-3 +:class-title: sd-fs-6 +:class-body: sd-text-center +:class-footer: text-smaller +{material-outlined}`admin_panel_settings;3.5em` ++++ +CrateDB includes a web administration interface. +::: + +:::{grid-item-card} CrateDB Shell +:link: use-crash +:link-type: ref +:link-alt: The Crash CLI +:padding: 2 +:class-card: sd-pt-3 +:class-title: sd-fs-6 +:class-body: sd-text-center +:class-footer: text-smaller +{material-outlined}`terminal;3.5em` ++++ +The CrateDB command-line interface (CLI). +::: + +:::: + +(ide)= +(connect-ide)= +:::{rubric} Database IDEs +::: + +Mostly through its PostgreSQL interface, CrateDB supports working with popular +database IDE (Integrated Development Environment) applications. + + +:::::{grid} 2 2 2 4 +:gutter: 3 +:padding: 0 + +::::{grid-item-card} DataGrip +:link: datagrip +:link-type: ref +:link-alt: Connect to CrateDB using DataGrip +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-6 +```{image} /_assets/icon/datagrip-logo.svg +:height: 60px +``` +:::: + +::::{grid-item-card} DBeaver +:link: dbeaver +:link-type: ref +:link-alt: Connect to CrateDB using DBeaver +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-6 +```{image} /_assets/icon/dbeaver-logo.svg +:height: 60px +``` +:::: + +::::: + (use-admin-ui)= ## CrateDB Admin UI :::{div} CrateDB ships with a browser-based administration interface called -[Admin UI]. +{ref}`Admin UI `. ::: The Admin UI is enabled on each CrateDB node. You can use it to inspect and interact with the whole CrateDB cluster in various ways. @@ -40,9 +120,9 @@ a dedicated user account for accessing the Admin UI. See {ref}`create-user`. (use-crash)= ## CrateDB Shell -The CrateDB Shell, called `crash`, is an interactive command-line interface -(CLI) program for working with CrateDB on your favorite terminal. To learn more -about it, please refer to its documentation at {ref}`crate-crash:index`. +The {ref}`CrateDB Shell `, called `crash`, +is an interactive command-line interface +(CLI) program for working with CrateDB on your favorite terminal. ![crash default screen after executing a query](https://cratedb.com/docs/crate/crash/en/latest/_images/query.png){width=320px} @@ -224,46 +304,6 @@ echo '{"stmt": "SELECT 42.42;"}' \ :::: -(ide)= -(connect-ide)= -## Database IDEs - -Mostly through its PostgreSQL interface, CrateDB supports working with popular -database IDE (Integrated Development Environment) applications. - - -:::::{grid} 2 2 2 4 -:gutter: 3 -:padding: 0 - -::::{grid-item-card} DataGrip -:link: datagrip -:link-type: ref -:link-alt: Connect to CrateDB using DataGrip -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-6 -```{image} /_assets/icon/datagrip-logo.svg -:height: 60px -``` -:::: - -::::{grid-item-card} DBeaver -:link: dbeaver -:link-type: ref -:link-alt: Connect to CrateDB using DBeaver -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-6 -```{image} /_assets/icon/dbeaver-logo.svg -:height: 60px -``` -:::: - -::::: - [curl]: https://curl.se/ [crash]: inv:crate-crash:*:label#index diff --git a/docs/feature/highlights.md b/docs/feature/highlights.md new file mode 100644 index 00000000..00ccc335 --- /dev/null +++ b/docs/feature/highlights.md @@ -0,0 +1,71 @@ +(highlights)= + +# Feature highlights + +:::{div} sd-text-muted +Important fundamental features of CrateDB. +::: + +:{material-outlined}`article;1.75em` {ref}`Document store `: + + Store JSON documents or other structured data, also nested, using + CrateDB’s OBJECT and ARRAY container data types. + Query this data with ease, fully indexed thus performant from the + start, optionally using relational joins. + + **What's inside:** + CrateDB can do the same like Lotus Notes / Domino, CouchDB, MongoDB, + and PostgreSQL's JSON data type. + +:{material-outlined}`manage_search;2em` {ref}`Unified search `: + + Like Elasticsearch and Solr, CrateDB is based on Apache Lucene, + the premier industry-grade full-text search engine library. + + CrateDB offers native BM25 term search and vector search + on large volumes of unstructured information, all using SQL. + CrateDB enables you to build powerful full-text and semantic + search experiences for websites, applications, and enterprise data. + + **What's inside:** + Learn how to leverage full-text, geospatial-, + vector-, and hybrid-search capabilities. + +:{material-outlined}`engineering;2em` {ref}`Advanced querying `: + + Mix full-text search with time series aspects, and run powerful + aggregations or other kinds of complex queries on your data. + CrateDB supports effective time series analysis with fast aggregations, + relational features for JOIN operations, and a rich set of built-in functions. + + **What's inside:** + Aggregations with gap filling / interpolation, common table expressions (CTEs), + LAG / LEAD window functions, time bucketing, HyperLogLog, LOCF/NOCB, LTTB, UNNEST. + + +:::{rubric} Related sections +::: + +:{material-outlined}`lightbulb;2em` {ref}`Solutions and use cases `: + + Learn how to use CrateDB for time series use-cases, + about industry solutions built with CrateDB and + how others are using CrateDB successfully with + both standard software components and in + proprietary system landscapes. + + **What's inside:** + Solutions built with CrateDB. + Time series data. Industrial big data. + Real-time raw-data analytics. Machine learning. + +:{material-outlined}`numbers;2em` {ref}`Categories / Topics `: + + Learn how to apply CrateDB's features to optimally cover + different application categories and topic domains. + For example, connect CrateDB with third-party + software applications, libraries, and frameworks. + + **What's inside:** + Business intelligence, data lineage, data migrations, data visualization, + programming frameworks, software testing. diff --git a/docs/feature/index.md b/docs/feature/index.md index cfe721c3..03e0c406 100644 --- a/docs/feature/index.md +++ b/docs/feature/index.md @@ -3,6 +3,13 @@ (all-features)= # All Features +:::{toctree} +:maxdepth: 1 +:hidden: + +Highlights +::: + All features of CrateDB at a glance. :::::{grid} 1 3 3 3 @@ -59,7 +66,7 @@ operations, all based on standard SQL. ::::: -:::{rubric} Connect and Integrate +:::{rubric} Related sections ::: Connect to CrateDB using traditional database drivers, and integrate CrateDB with popular 3rd-party applications in open-source and proprietary software @@ -73,9 +80,10 @@ landscapes. :::{grid-item-card} {material-outlined}`link;2em` Connectivity :link: connect :link-type: ref -:link-alt: About connection options with CrateDB +:link-alt: About connectivity options with CrateDB -Connect to your CrateDB cluster using drivers, frameworks, and adapters. +Connect to your CrateDB cluster using drivers, connectors, +adapters, and frameworks. +++ **What's inside:** Connectivity and integration options with database drivers @@ -96,65 +104,3 @@ ETL applications. ::: :::: - - -:::{rubric} Highlights -::: - -Important fundamental features of CrateDB, and how they are applied within software -solutions and application platforms in different scenarios and environments. - -::::{grid} 1 2 2 2 -:margin: 4 4 0 0 -:padding: 0 -:gutter: 2 - - -:::{grid-item-card} {material-outlined}`description;2em` Document Store -:link: document -:link-type: ref -:link-alt: About CrateDB's OBJECT data type - -Learn about CrateDB's OBJECT data type, how to efficiently store JSON -or other structured data, also nested, and how to query this data with -ease, fully indexed thus performant from the start, optionally using -relational joins. -+++ -**What's inside:** -CrateDB can do the same like Lotus Notes / Domino, CouchDB, MongoDB, -and PostgreSQL's JSON data type. -::: - - -:::{grid-item-card} {material-outlined}`manage_search;2em` Full-Text Search -:link: fulltext -:link-type: ref -:link-alt: About CrateDB's full-text search capabilities - -Learn about CrateDB's Okapi BM25 implementation, how to set up your database -for full-text search, and how to query text data efficiently, to make sense -of large volumes of unstructured information. -+++ -**What's inside:** -Like Elasticsearch and Solr, CrateDB is based on Lucene, the premier -industry-grade full-text search engine library. -::: - -:::: - - -:::{rubric} Quotes -::: - -> When using CrateDB, a project that got started around the same time, it's like -you've stumbled into an alternative reality where Elastic is a proper database. -> -> -– Henrik Ingo, Nyrkiö Oy, independent database consultant, MongoDB - -> CrateDB enables use cases we couldn't satisfy with other -database systems, also with databases which are even stronger -focused on the time series domain. -> -> CrateDB is not your normal database! -> -> -- Daniel Hölbling-Inzko, Director of Engineering Analytics, Bitmovin diff --git a/docs/handbook/index.md b/docs/handbook/index.md index 5aea1ea7..62ccaa55 100644 --- a/docs/handbook/index.md +++ b/docs/handbook/index.md @@ -3,255 +3,143 @@ # Handbook :::{div} sd-text-muted -About using CrateDB and CrateDB Cloud in practice. +Use CrateDB and CrateDB Cloud in practice. ::: +:::{rubric} Instructions, how-to guides, tutorials, and explanations +::: -::::{grid} 2 2 3 3 +:::::{grid} 2 3 3 3 :gutter: 2 :padding: 0 -:::{grid-item-card} Getting Started -:link: getting-started -:link-type: ref -:link-alt: Getting started with CrateDB -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`rocket_launch;1.3em` -::: - -:::{grid-item-card} Installation +::::{grid-item-card} :link: install :link-type: ref -:link-alt: Installing CrateDB -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`download_for_offline;1.3em` -::: +{material-outlined}`download_for_offline;2em`   **Install CrateDB** ++++ +Install CrateDB on different operating systems and environments. +:::: -:::{grid-item-card} Connect +::::{grid-item-card} :link: connect :link-type: ref -:link-alt: Connecting to CrateDB -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`settings_input_svideo;1.3em` -::: - +{material-outlined}`settings_input_svideo;2em`   **Connect to CrateDB** ++++ +Database drivers, libraries, adapters, and connectors. :::: +::::: -## Learn -How-to guides, tutorials, and explanations. - -::::{grid} 2 2 3 3 +:::::{grid} 2 3 3 3 :gutter: 2 :padding: 0 -:::{grid-item-card} How-to guides +::::{grid-item-card} :link: howtos :link-type: ref -:link-alt: How-to guides about CrateDB -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`integration_instructions;1.3em` -::: +{material-outlined}`integration_instructions;2em`   **How-to guides** ++++ +Instructions how to get tasks done with CrateDB. +:::: -:::{grid-item-card} Tutorials +::::{grid-item-card} :link: tutorials :link-type: ref -:link-alt: Tutorials about CrateDB -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`school;1.3em` -::: +{material-outlined}`school;2em`   **Tutorials** ++++ +Acquire skills and knowledge about CrateDB. +:::: -:::{grid-item-card} Explanations +::::{grid-item-card} :link: explanations :link-type: ref -:link-alt: Explanations about subject matters concerning CrateDB -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`lightbulb;1.3em` -::: - -:::{grid-item-card} Administration -:link: administration -:link-type: ref -:link-alt: CrateDB Administration -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`manage_accounts;1.3em` -::: - -:::{grid-item-card} Performance guides -:link: performance -:link-type: ref -:link-alt: CrateDB Performance guides -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`speed;1.3em` -::: - +{material-outlined}`lightbulb;2em`   **Explanations** ++++ +Broaden and deepen your knowledge and understanding of CrateDB. :::: +::::: -## Features - -:::{rubric} Highlights +:::{rubric} Best practice guides ::: -::::{grid} 2 2 3 3 +:::::{grid} 2 3 3 3 :gutter: 2 :padding: 0 -:::{grid-item-card} Document Store -:link: document -:link-type: ref -:link-alt: Storing JSON documents using CrateDB's `OBJECT` data type -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`article;1.3em` -::: - -:::{grid-item-card} Search -:link: search-overview -:link-type: ref -:link-alt: About CrateDB's search capabilities -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`manage_search;1.3em` -::: - -:::{grid-item-card} Advanced Querying -:link: advanced-querying +::::{grid-item-card} +:link: administration :link-type: ref -:link-alt: About CrateDB's advanced querying capabilities -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`engineering;1.3em` -::: - +{material-outlined}`manage_accounts;2em`   **Administration** ++++ +Best practices for administering CrateDB database clusters. :::: -:::{card} All features -:link: all-features +::::{grid-item-card} +:link: performance :link-type: ref - -CrateDB is a distributed and scalable SQL database for storing and analyzing -massive amounts of data in near real-time, even with complex queries. It is -based on Lucene, combines a unique set of features, and is PostgreSQL-compatible. - -![CrateDB feature overview diagram](https://cratedb.com/hs-fs/hubfs/nativesql.png?width=800&name=nativesql.png) +{material-outlined}`speed;2em`   **Performance guides** +++ -Read about all features of CrateDB at a glance. -::: +Best practices and tips for sharding, scaling, and performance tuning. +:::: +::::: -## Data ingestion +:::{rubric} Data loading / import / ingestion +::: Load data from many sources into CrateDB. -::::{grid} 2 2 3 3 +:::::{grid} 2 3 3 3 :gutter: 2 :padding: 0 -:::{grid-item-card} ETL +::::{grid-item-card} :link: etl :link-type: ref -:link-alt: Load and export data into/from CrateDB -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`transform;1.3em` -::: +{material-outlined}`transform;2em`   **ETL** ++++ +Load and export data into/from CrateDB. +Integrate CrateDB with ETL and ELT applications and frameworks. +:::: -:::{grid-item-card} CDC +::::{grid-item-card} :link: cdc :link-type: ref -:link-alt: Change Data Capture (CDC) into CrateDB -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`double_arrow;1.3em` -::: +{material-outlined}`double_arrow;2em`   **CDC** ++++ +Change Data Capture (CDC) into CrateDB. +Integrate CrateDB with CDC applications and frameworks. +:::: -:::{grid-item-card} Telemetry +::::{grid-item-card} :link: telemetry :link-type: ref -:link-alt: Use CrateDB with metrics collection agents, brokers, and stores -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 -{material-outlined}`query_stats;1.3em` -::: - +{material-outlined}`query_stats;2em`   **Telemetry** ++++ +Collect telemetry data into CrateDB. +Use CrateDB with metrics collection agents, brokers, and stores. :::: +::::: -## Solutions and topics +## See also -::::{grid} 1 2 2 2 +:::::{grid} 2 3 3 3 :gutter: 2 :padding: 0 -:::{grid-item-card} {material-outlined}`lightbulb;2em` Solutions and use cases -:link: solutions -:link-type: ref -:link-alt: Solutions built with CrateDB -Learn how to use CrateDB for time series use-cases, -about industry solutions built with CrateDB and -how others are using CrateDB successfully with -both standard software components and in -proprietary system landscapes. -+++ -**What's inside:** -Time series data. Industrial big data. -Real-time raw-data analytics. Machine learning. -::: - -:::{grid-item-card} {material-outlined}`numbers;2em` Categories / Topics -:link: topics +::::{grid-item-card} +:link: all-features :link-type: ref -:link-alt: CrateDB topics overview -Learn how to apply CrateDB's features to optimally cover -different application categories and topic domains. -For example, connect CrateDB with third-party -software applications, libraries, and frameworks. +{material-outlined}`star;2em`   **All features** +++ -**What's inside:** -Business intelligence, data lineage, data migrations, data visualization, -programming frameworks, software testing. -::: - +All features of CrateDB at a glance. :::: +::::: ```{toctree} diff --git a/docs/index.md b/docs/index.md index dbd51707..ab52879e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,49 +23,22 @@ search, or large volumes of structured and semi-structured data, CrateDB gives you the **power of SQL**, the **scalability of NoSQL**, and the **flexibility of a modern data platform**. -See our [Product overview] to learn more about high-level features and use cases. +See our [product overview] and {ref}`features overview ` to learn +more about high-level features and use cases. This documentation is about helping you get started, explore in practice, and operate in details. - -## Get Started - -:::{card} {material-outlined}`not_started;1.7em` CrateDB Cloud -:link: first-steps -:link-type: ref -:link-alt: Getting started with CrateDB Cloud -:class-title: sd-fs-5 - -Start with a fully managed FREE FOREVER CrateDB instance to quickly explore -features through guided tutorials or on your own with custom data. -+++ -```{button-ref} first-steps -:color: primary -:expand: -**Get started with CrateDB Cloud** -``` -::: - - -## Learn - -:::{rubric} Introduction -::: -Learn about the fundamentals of CrateDB, guided and self-guided. - -::::{grid} 2 2 2 4 -:padding: 0 -:gutter: 0 +::::{grid} 2 2 2 3 +:gutter: 3 :::{grid-item-card} :link: getting-started :link-type: ref -:padding: 2 :class-header: sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize :class-body: sd-text-center sd-fs-5 :class-footer: text-smaller -Getting Started +Getting started ^^^ {material-outlined}`not_started;3.5em` +++ @@ -73,226 +46,104 @@ Learn how to interact with the database for the first time. ::: :::{grid-item-card} -:link: handbook +:link: connect :link-type: ref -:link-alt: The CrateDB Handbook -:padding: 2 -:class-header: sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize -:class-body: sd-text-center sd-fs-5 -:class-footer: text-smaller -The CrateDB Handbook -^^^ -{material-outlined}`hiking;3.5em` -+++ -Guides and tutorials about how to use CrateDB in practice. -::: - -:::{grid-item-card} -:link: https://learn.cratedb.com/ -:link-alt: The CrateDB Academy -:padding: 2 +:link-alt: CrateDB: Client Drivers and Libraries :class-header: sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize :class-body: sd-text-center sd-fs-5 :class-footer: text-smaller -Academy Courses +Connect ^^^ -{material-outlined}`school;3.5em` +{material-outlined}`link;3.5em` +++ -A learning hub dedicated to data enthusiasts. +Database drivers, libraries, adapters, and connectors. ::: :::{grid-item-card} -:link: https://community.cratedb.com/ -:link-alt: The CrateDB Community Portal -:padding: 2 +:link: integrate +:link-type: ref +:link-alt: Integrations :class-header: sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize :class-body: sd-text-center sd-fs-5 :class-footer: text-smaller -Community Portal +Integrate ^^^ -{material-outlined}`groups;3.5em` +{material-outlined}`integration_instructions;3.5em` +++ -A hangout place for members of the CrateDB community. +Integrate with third-party applications and frameworks. ::: :::: -:::{rubric} Admin Tools +:::{rubric} Start ::: -Learn about the fundamental tools that support working directly with CrateDB. - -::::{grid} 2 3 3 3 -:padding: 0 - -:::{grid-item-card} Admin UI -:link: crate-admin-ui:index -:link-type: ref -:link-alt: The CrateDB Admin UI -:padding: 2 -:class-card: sd-pt-3 -:class-title: sd-fs-5 -:class-body: sd-text-center -:class-footer: text-smaller -{material-outlined}`admin_panel_settings;3.5em` -+++ -Learn about CrateDB's included web administration interface. -::: - -:::{grid-item-card} Crash CLI -:link: crate-crash:index -:link-type: ref -:link-alt: The Crash CLI -:padding: 2 -:class-card: sd-pt-3 -:class-title: sd-fs-5 -:class-body: sd-text-center -:class-footer: text-smaller -{material-outlined}`terminal;3.5em` -+++ -A command-line interface (CLI) tool for working with CrateDB. -::: - -:::: - - -:::{rubric} Resources -::: - -::::::{grid} 1 -:margin: 1 -:padding: 2 - -:::::{grid-item} -:margin: 0 -:padding: 2 ::::{grid} 2 -:margin: 0 -:padding: 0 +:gutter: 3 -:::{grid-item-card} {material-outlined}`lightbulb;1.7em` Database Features -:link: features -:link-type: ref -:link-alt: Database Features +:::{grid-item-card} {material-outlined}`not_started;1.7em` CrateDB Cloud +:link: https://console.cratedb.cloud/ +:link-type: url +:link-alt: Getting started with CrateDB Cloud :class-title: sd-fs-5 -Explore all functional, operational and advanced features of CrateDB at a glance. +Start with a fully managed FREE FOREVER CrateDB instance to quickly explore +features through guided tutorials or on your own with custom data. ++++ +```{button-ref} first-steps +:color: primary +:expand: +**Start with CrateDB Cloud** +``` ::: -:::{grid-item-card} {material-outlined}`auto_stories;1.7em` Database Manual -:link: crate-reference:index +:::{grid-item-card} {material-outlined}`download_for_offline;1.7em` Install CrateDB +:link: install :link-type: ref -:link-alt: Database Manual +:link-alt: Install CrateDB :class-title: sd-fs-5 -Learn core CrateDB concepts, including data modeling, querying data, -aggregations, sharding, and more. +Install CrateDB on different operating systems and environments, +for on-premises operations and development purposes. ::: :::: -::::: -:::{grid-item-card} {material-outlined}`link;1.7em` Connectivity Options -:link: connect -:link-type: ref -:link-alt: CrateDB: Client Drivers and Libraries -:padding: 2 -:class-title: sd-fs-5 - -Learn how to connect your applications using database drivers, libraries, -adapters, and connectors. - -CrateDB supports both the [HTTP protocol] and the [PostgreSQL wire protocol], -ensuring compatibility with many PostgreSQL clients. -Through corresponding drivers, adapters, and client libraries, CrateDB is -compatible with [ODBC], [JDBC], and other database API specifications. +:::{rubric} Testimonials ::: -:::{grid-item-card} {material-outlined}`integration_instructions;1.7em` Integrations -:link: integrate -:link-type: ref -:link-alt: Integrations -:padding: 2 -:class-title: sd-fs-5 - -Explore the many options for integrating with third-party applications and -frameworks. -::: - -:::::: +> When using CrateDB, a project that got started around the same time, it's like +you've stumbled into an alternative reality where Elastic is a proper database. +> +> -– Henrik Ingo, Nyrkiö Oy, independent database consultant, MongoDB -:::{rubric} Examples -::: +> CrateDB enables use cases we couldn't satisfy with other +database systems, also with databases which are even stronger +focused on the time series domain. +> +> CrateDB is not your normal database! +> +> -- Daniel Hölbling-Inzko, Director of Engineering Analytics, Bitmovin -Learn how to use CrateDB by digesting concise examples. - -::::{grid} 2 3 3 3 -:padding: 0 - -:::{grid-item-card} CrateDB Examples -:link: https://github.com/crate/cratedb-examples -:link-alt: CrateDB Examples -:padding: 2 -:class-card: sd-pt-3 -:class-title: sd-fs-5 -:class-body: sd-text-center -:class-footer: text-smaller -{material-outlined}`play_circle;3.5em` -+++ -A collection of clear, concise examples of how to work with CrateDB. -::: -:::{grid-item-card} Sample Apps -:link: https://github.com/crate/crate-sample-apps/ -:link-alt: CrateDB Sample Apps -:padding: 2 -:class-card: sd-pt-3 -:class-title: sd-fs-5 -:class-body: sd-text-center -:class-footer: text-smaller -{material-outlined}`apps;3.5em` -+++ -Canonical guestbook demo applications implemented with different client libraries. +:::{rubric} Learn ::: -:::: - +:::{card} All features +:link: all-features +:link-type: ref -:::{rubric} Videos -::: -::::{card} Today's data challenges and a high level overview of CrateDB -:class-title: sd-fs-4 -:class-body: sd-text-center -:class-footer: sd-fs-6 +CrateDB is a distributed and scalable SQL database for storing and analyzing +massive amounts of data in near real-time, even with complex queries. It is +based on Lucene, combines a unique set of features, and is PostgreSQL-compatible. -:::{youtube} cByAOsaYddQ -::: +![CrateDB feature overview diagram](https://cratedb.com/hs-fs/hubfs/nativesql.png?width=800&name=nativesql.png) +++ -_Webinar: Turbocharge your aggregations, search & AI models & get real-time insights._ - -:::{div} text-smaller -Discover CrateDB, the leading real-time analytics database. It provides the -flexibility, speed, and scalability necessary to master today's data challenges. -Watch this video to learn how CrateDB empowers you with real-time insights -into your data to fuel advanced analytics, search, and AI models—enabling -informed decisions that drive meaningful impact. +Read about all features of CrateDB at a glance. ::: -:::: -::::{card} CrateDB curated videos -:class-footer: sd-fs-6 -In [this video playlist] Simon Prickett shares videos he has been part of that -show what CrateDB is and how you can use it for a variety of projects. -Don't miss the relevant [CrateDB customer stories]. -:::: [Product overview]: https://cratedb.com/database -[CrateDB customer stories]: https://www.youtube.com/playlist?list=PLDZqzXOGoWUJrAF_lVx9U6BzAGG9xYz_v -[HTTP protocol]: https://en.wikipedia.org/wiki/HTTP -[JDBC]: https://en.wikipedia.org/wiki/Java_Database_Connectivity -[ODBC]: https://en.wikipedia.org/wiki/Open_Database_Connectivity -[PostgreSQL wire protocol]: https://www.postgresql.org/docs/current/protocol.html -[this video playlist]: https://www.youtube.com/playlist?list=PL3cZtICBssphXl5rHgsgG9vTNAVTw_Veq diff --git a/docs/ingest/index.md b/docs/ingest/index.md index bf671e87..183e6c64 100644 --- a/docs/ingest/index.md +++ b/docs/ingest/index.md @@ -2,17 +2,23 @@ # CrateDB data ingestion :::{div} sd-text-muted -Data ingestion methods for CrateDB at a glance. +Data ingestion / loading / import methods for CrateDB at a glance. ::: -:::::{grid} 1 1 2 2 -:margin: 4 4 0 0 -:padding: 0 -:gutter: 2 -:class-container: ul-li-wide +:::{toctree} +:maxdepth: 2 +:hidden: + +etl/index +cdc/index +telemetry/index +::: -::::{grid-item-card} {material-outlined}`file_upload;2em` Load data using CrateDB -- {ref}`Import files ` +## {material-outlined}`file_upload;1.5em` Using CrateDB + +Data import methods supported by CrateDB natively. + +:{ref}`Import files `: Load data from the local filesystem or from remote sources using CrateDB's native `COPY FROM` SQL statement. @@ -21,58 +27,50 @@ Data ingestion methods for CrateDB at a glance.
**Formats:** CSV, JSON Lines -- {ref}`fdw` +:{ref}`fdw`: Make data in remote database servers available as tables within CrateDB. You can then query these foreign tables like regular user tables. -+++ -Data import methods supported by CrateDB natively. -:::: -::::{grid-item-card} {material-outlined}`cloud_upload;2em` Load data using CrateDB Cloud -- {ref}`Import files ` +## {material-outlined}`cloud_upload;1.5em` Using CrateDB Cloud + +Data import methods provided by CrateDB Cloud. - Managed data loading from remote sources using CrateDB Cloud's ETL subsystem. +:{ref}`Import files `: + + Managed data loading from remote sources using CrateDB Cloud's ETL services. **Protocols:** HTTP, Blob Storage (AWS S3, Azure)
**Formats:** CSV, JSON Lines, Parquet -- {ref}`MongoDB CDC integration ` +:{ref}`MongoDB CDC integration `: CrateDB Cloud enables continuous data ingestion from MongoDB using Change Data Capture (CDC), providing seamless, real-time synchronization of your data. -+++ -Data import methods provided by CrateDB Cloud. -:::: -::::{grid-item-card} {material-outlined}`arrow_circle_up;2em` Load data using external systems -- {ref}`Extract Transform Load (ETL) ` +## {material-outlined}`arrow_circle_up;1.5em` Using external systems + +Supported industry-standard systems and frameworks. + +:{ref}`Extract Transform Load (ETL) `: Ingest data with polyglot data integration platforms or libraries and complete ETL solutions. -- {ref}`cdc` +:{ref}`cdc`: Integrate with third-party change-data-capture (CDC) tools. -- {ref}`telemetry` +:{ref}`telemetry`: Ingest telemetry data—metrics, logs, and traces—from monitoring and sensor collector systems. -+++ -Supported industry-standard frameworks and paradigms. -:::: - -::::: - + Store metrics and telemetry data for the long term, with the benefits of + using standard database interfaces, SQL query language, and horizontal + scalability through clustering as you go. -```{toctree} -:maxdepth: 2 -:hidden: - -etl/index -cdc/index -telemetry/index -``` + **What's inside:** + Never retire old records to cold storage, + always have them ready for historical analysis. diff --git a/docs/solution/index.md b/docs/solution/index.md index 5b5472de..f26c6b5c 100644 --- a/docs/solution/index.md +++ b/docs/solution/index.md @@ -7,6 +7,9 @@ CrateDB is a distributed and scalable SQL database for storing and analyzing massive amounts of data in near real-time, even with complex queries. It is PostgreSQL-compatible, and based on Lucene. + +Learn how its features are applied within software solutions and application +platforms in different scenarios and environments. ::: :::{toctree} @@ -18,60 +21,51 @@ analytics/index machine-learning/index ::: -## Explanations +## Overview :::{div} sd-text-muted About time series and long-term data storage, real-time analytics, and machine learning. ::: -::::{grid} 1 2 2 2 -:gutter: 2 -:padding: 0 +:{material-outlined}`stacked_line_chart;1.5em` {ref}`Time series data `: -:::{grid-item-card} {material-outlined}`stacked_line_chart;2em` Time series data -:link: timeseries -:link-type: ref -:link-alt: About CrateDB for time series data analysis -Enhance your understanding of how to use CrateDB for time series use-cases, -and how to apply time series modeling and analysis procedures to your data. -+++ -**What's inside:** -- Advanced statistical analysis -- Data visualization -- Machine learning -- Scientific computing -::: + **About CrateDB for time series data analysis.** + + Enhance your understanding of how to use CrateDB for time series use-cases, + and how to apply time series modeling and analysis procedures to your data. + + **What's inside:** + - Advanced statistical analysis + - Data visualization + - Machine learning + - Scientific computing -:::{grid-item-card} {material-outlined}`manage_history;2em` Long-term store -:link: longterm-store -:link-type: ref -:link-alt: About storing time series data for the long term -Permanently keeping your raw data accessible for querying yields insightful -analysis opportunities other systems can't provide easily. -+++ -**What's inside:** -- Time-based bucketing. -- Advanced querying. -- Import data using Dask. -- Optimizing storage for historic time series data. -::: +:{material-outlined}`manage_history;1.5em` {ref}`Long-term store `: -:::{grid-item-card} {material-outlined}`model_training;2em` Machine learning -:link: machine-learning -:link-type: ref -:link-alt: About CrateDB for machine learning applications -Get an overview of how CrateDB provides support for different kinds of -machine learning tasks, and learn how to integrate CrateDB with machine -learning frameworks and tools. -+++ -**What's inside:** -- Vector store: Vector search, Hybrid search, LangChain -- Text-to-SQL: LlamaIndex, MCP, MindsDB -- Time series analysis: R, TensorFlow -- MLOps and model training: MLflow, PyCaret, scikit-learn -::: + **About storing time series data for the long term.** -:::: + Permanently keeping your raw data accessible for querying yields insightful + analysis opportunities other systems can't provide easily. + + **What's inside:** + - Time-based bucketing. + - Advanced querying. + - Import data using Dask. + - Optimizing storage for historic time series data. + +:{material-outlined}`model_training;2em` {ref}`Machine learning `: + + **About CrateDB for machine learning applications.** + + Get an overview of how CrateDB provides support for different kinds of + machine learning tasks, and learn how to integrate CrateDB with machine + learning frameworks and tools. + + **What's inside:** + - Vector store: Vector search, Hybrid search, LangChain + - Text-to-SQL: LlamaIndex, MCP, MindsDB + - Time series analysis: R, TensorFlow + - MLOps and model training: MLflow, PyCaret, scikit-learn ## Case studies @@ -116,41 +110,3 @@ to their unique value, downsampling is not applicable. ::: :::: - -## See also - -:::{div} sd-text-muted -Other notable features of CrateDB. -::: - -::::{grid} 1 2 2 2 -:margin: 4 4 0 0 -:padding: 0 -:gutter: 2 - -:::{grid-item-card} {material-outlined}`search;2em` Full-text and semantic search -:link: search-overview -:link-type: ref -:link-alt: About CrateDB's search features -CrateDB enables you to build powerful search experiences for websites, -applications, and enterprise data. -+++ -**What's inside:** -Learn how to leverage full-text, geospatial-, -vector-, and hybrid-search capabilities. -::: - -:::{grid-item-card} {material-outlined}`manage_history;2em` Metrics and telemetry data store -:link: metrics-store -:link-type: ref -:link-alt: Using CrateDB as a long-term metrics store -Store metrics and telemetry data for the long term, with the benefits of -using standard database interfaces, SQL query language, and horizontal -scalability through clustering as you go. -+++ -**What's inside:** -Never retire old records to cold storage, -always have them ready for historical analysis. -::: - -:::: diff --git a/docs/start/application/index.md b/docs/start/application/index.md index 7fa075a1..1207f008 100644 --- a/docs/start/application/index.md +++ b/docs/start/application/index.md @@ -13,7 +13,7 @@ :link-type: url A JavaScript guestbook app with several backend implementations. +++ -Each uses a different client library to communicate with CrateDB over HTTP. +Each application uses a different client library to communicate with CrateDB over HTTP. ::: :::{grid-item-card} Geospatial data @@ -25,6 +25,15 @@ Select a point of interest on a map, then drill up to the corresponding region. ::: +:::{grid-item-card} Assorted examples +:link: https://github.com/crate/cratedb-examples +:link-type: url +A collection of clear, concise examples about how to work with CrateDB. ++++ +The repository includes a variety of executable code snippets +covering a wide range of clients and integrations. +::: + :::: diff --git a/docs/start/index.md b/docs/start/index.md index f1ae544a..4e23b70f 100644 --- a/docs/start/index.md +++ b/docs/start/index.md @@ -72,7 +72,61 @@ and explore key features. :::{rubric} Learn more ::: -To learn more about CrateDB, we invite you to explore the other sections +Learn more about CrateDB, guided and self-guided. + +::::{grid} 2 2 2 4 +:padding: 0 +:gutter: 0 + +:::{grid-item-card} +:link: handbook +:link-type: ref +:link-alt: The CrateDB Handbook +:padding: 2 +:class-header: sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize +:class-body: sd-text-center sd-fs-5 +:class-footer: text-smaller +The CrateDB Handbook +^^^ +{material-outlined}`hiking;3.5em` ++++ +Guides and tutorials about how to use CrateDB in practice. +::: + +:::{grid-item-card} +:link: https://learn.cratedb.com/ +:link-alt: The CrateDB Academy +:padding: 2 +:class-header: sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize +:class-body: sd-text-center sd-fs-5 +:class-footer: text-smaller +Academy Courses +^^^ +{material-outlined}`school;3.5em` ++++ +A learning hub dedicated to data enthusiasts. +::: + +:::{grid-item-card} +:link: https://community.cratedb.com/ +:link-alt: The CrateDB Community Portal +:padding: 2 +:class-header: sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize +:class-body: sd-text-center sd-fs-5 +:class-footer: text-smaller +Community Portal +^^^ +{material-outlined}`groups;3.5em` ++++ +A hangout place for members of the CrateDB community. +::: + +:::: + +:::{rubric} See also +::: + +We invite you to explore the other sections of the documentation. :::::{card} @@ -190,16 +244,16 @@ Get access to more resources to continue learning. ::::: - ```{toctree} :maxdepth: 1 :hidden: -first-steps +First steps modelling/index query/index ingest application/index +video/index ``` diff --git a/docs/start/video/index.md b/docs/start/video/index.md new file mode 100644 index 00000000..64310a55 --- /dev/null +++ b/docs/start/video/index.md @@ -0,0 +1,37 @@ +(video)= +(videos)= + +# Videos and webinars + +::::{card} +:class-title: sd-fs-4 +:class-body: sd-text-center +:class-footer: sd-fs-6 + +Today's data challenges and a high-level overview of CrateDB. +:::{youtube} cByAOsaYddQ +::: ++++ +_Webinar: Turbocharge your aggregations, search & AI models & get real-time insights._ + +:::{div} text-smaller +Discover CrateDB, the leading real-time analytics database. It provides the +flexibility, speed, and scalability necessary to master today's data challenges. +Watch this video to learn how CrateDB empowers you with real-time insights +into your data to fuel advanced analytics, search, and AI models—enabling +informed decisions that drive meaningful impact. +::: +:::: + +::::{card} CrateDB curated videos +:class-footer: sd-fs-6 + +In [this video playlist] Simon Prickett shares videos that +show what CrateDB is and how you can apply it in various scenarios +across many projects. +Don't miss the relevant [CrateDB customer stories]. +:::: + + +[CrateDB customer stories]: https://www.youtube.com/playlist?list=PLDZqzXOGoWUJrAF_lVx9U6BzAGG9xYz_v +[this video playlist]: https://www.youtube.com/playlist?list=PL3cZtICBssphXl5rHgsgG9vTNAVTw_Veq diff --git a/docs/topic/index.md b/docs/topic/index.md index b7602916..237493cf 100644 --- a/docs/topic/index.md +++ b/docs/topic/index.md @@ -1,3 +1,4 @@ +(categories)= (domain)= (domains)= (topic)= diff --git a/docs/tutorial/index.md b/docs/tutorial/index.md index 5ff44281..9be6ff25 100644 --- a/docs/tutorial/index.md +++ b/docs/tutorial/index.md @@ -43,6 +43,22 @@ Learn how to combine time series data with metadata. ::::: +:::{rubric} Courses +::: + +:::::{grid} 2 +:gutter: 3 +:padding: 0 + +::::{grid-item-card} {material-outlined}`school;2em`   The CrateDB Academy +:link: https://learn.cratedb.com/ +:link-type: url +:link-alt: The CrateDB Academy +A learning hub dedicated to data enthusiasts, including educational material +about CrateDB fundamentals and advanced time series. +:::: + +::::: ## Integrations @@ -74,23 +90,6 @@ Learn how to integrate CrateDB with 3rd-party, industry-standard products. - {ref}`r-tutorial` -## Academy - -:::{card} -:width: 50% -:link: https://learn.cratedb.com/ -:link-alt: The CrateDB Academy -:class-header: sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize -:class-body: sd-text-center sd-fs-5 -:class-footer: text-smaller -Academy Courses -^^^ -{material-outlined}`school;3.5em` -+++ -A learning hub dedicated to data enthusiasts, including educational material -about CrateDB fundamentals and advanced time series. -::: - :::{note} You can expect the more recent documents to be more up-to-date than previous