diff --git a/docs/feature/index.md b/docs/feature/index.md index 4a41966..b952613 100644 --- a/docs/feature/index.md +++ b/docs/feature/index.md @@ -1,8 +1,11 @@ (feature)= (features)= - +(all-features)= # All Features +:::{include} /_include/styles.html +::: + All features of CrateDB at a glance. :::::{grid} 1 3 3 3 @@ -10,11 +13,12 @@ All features of CrateDB at a glance. :padding: 0 :gutter: 2 -::::{grid-item-card} {material-outlined}`lightbulb;2em` Fundamentals +::::{grid-item-card} {material-outlined}`lightbulb;2em` Functional :::{toctree} :maxdepth: 1 sql/index +connectivity/index relational/index document/index search/index @@ -31,11 +35,6 @@ industry-standard SQL. :::{toctree} :maxdepth: 1 -connectivity/index -::: -:::{toctree} -:maxdepth: 1 - cluster/index snapshot/index cloud/index @@ -50,6 +49,7 @@ architecture, inherited from Elasticsearch. ::::{grid-item-card} {material-outlined}`read_more;2em` Advanced :::{toctree} :maxdepth: 1 + query/index generated/index cursor/index @@ -65,90 +65,84 @@ operations, all based on standard SQL. ::::: -:::{rubric} Features and Use Cases -::: - -Foundational features of CrateDB, and how they are applied within software -solutions and application platforms in different scenarios and environments. - - -:::{rubric} Features +:::{rubric} Connect and Integrate ::: +Connect to CrateDB using traditional database drivers, and integrate CrateDB +with popular 3rd-party applications in open-source and proprietary software +landscapes. ::::{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 +:::{grid-item-card} {material-outlined}`link;2em` Connectivity +:link: connectivity :link-type: ref -:link-alt: About CrateDB's OBJECT data type +:link-alt: About connection options with CrateDB -Learn how to use CrateDB's OBJECT data type to efficiently store JSON or -other structured data, also nested, and how to query this data with ease. +Connect to your CrateDB cluster using drivers, frameworks, and adapters. +++ **What's inside:** -CrateDB can do the same like Lotus Notes / Domino, CouchDB, MongoDB, -and PostgreSQL's JSON data type. +Connectivity and integration options with database drivers +and applications, libraries, and frameworks. ::: -:::{grid-item-card} {material-outlined}`manage_search;2em` Full-Text Search -:link: fulltext +:::{grid-item-card} {material-outlined}`sync;2em` Import and Export +:link: import-export :link-type: ref -:link-alt: About CrateDB's full-text search capabilities +:link-alt: About time series data import and export -Learn 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. +Import data into and export data from your CrateDB cluster. +++ **What's inside:** -Like Elasticsearch, CrateDB is based on Lucene, the premier industry-grade -full-text search engine library. +A variety of options to connect and integrate with 3rd-party +ETL applications. ::: :::: -:::{rubric} See Also +:::{rubric} Highlights ::: -Connect to and integrate with CrateDB. +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}`link;2em` Connectivity -:link: connectivity + +:::{grid-item-card} {material-outlined}`description;2em` Document Store +:link: document :link-type: ref -:link-alt: About connection options with CrateDB +:link-alt: About CrateDB's OBJECT data type -Connect to your CrateDB cluster using drivers, frameworks, and adapters. +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:** -Connectivity and integration options with database drivers -and applications, libraries, and frameworks. +CrateDB can do the same like Lotus Notes / Domino, CouchDB, MongoDB, +and PostgreSQL's JSON data type. ::: -:::{grid-item-card} {material-outlined}`sync;2em` Import and Export -:link: import-export +:::{grid-item-card} {material-outlined}`manage_search;2em` Full-Text Search +:link: fulltext :link-type: ref -:link-alt: About time series data import and export +:link-alt: About CrateDB's full-text search capabilities -Import data into and export data from your CrateDB cluster. +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:** -A variety of options to connect and integrate with 3rd-party -ETL applications. +Like Elasticsearch, CrateDB is based on Lucene, the premier industry-grade +full-text search engine library. ::: - :::: - - -```{include} /_include/styles.html -``` diff --git a/docs/index.md b/docs/index.md index 8f246fb..9a1d64d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,6 +8,13 @@ Guides and tutorials about how to use CrateDB and CrateDB Cloud in practice. +:::{card} Introduction +:link: all-features +:link-type: ref + +Start by reading about all features of CrateDB at a glance. +::: + 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.