Skip to content
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/connect/drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,6 @@ Ruby on Rails ActiveRecord adapter for CrateDB.


```{tip}
Please visit the [](#build-status) page for an overview about the integration
Please visit the :ref:`build-status` page for an overview about the integration
status of the client drivers listed above, and more.
```
206 changes: 137 additions & 69 deletions docs/home/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,64 @@ orphan: true
}
</style>

# CrateDB Documentation
# Welcome to CrateDB

Welcome to the official CrateDB Documentation. Whether you are a developer,
CrateDB is a **distributed SQL database** designed for **real-time analytics
and search** at scale. Whether you are working with time-series data, full-text
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**.

:::::{grid}
:padding: 4
:gutter: 2

::::{grid-item}
:class: rubric-slimmer
:columns: 6

:::{rubric} Why CrateDB?
:::
CrateDB was built for speed, scale, and simplicity:

* **Real-time performance:** Query millions of records per second with sub-second response times.
* **AI/ML-ready:** Store and serve data for modern AI pipelines.
* **Search + SQL**: Combine full-text search with rich SQL queries.
* **Geospatial & time-series**: Native support for IoT, sensor data, and location-based use cases.
* **Horizontal scalability**: Add nodes effortlessly to handle more data and users.
* **Resilient and fault-tolerant**: Built-in replication and recovery.
::::

::::{grid-item}
:class: rubric-slimmer
:columns: 6

:::{rubric} What Can You Build?
:::
CrateDB is used across industries to power:

* Real-time **dashboards and analytics**
* Hybrid **search and retrieval experiences**
* Large-scale **IoT telemetry and analytics**
* Complex **geospatial applications**
* Embedded **AI-driven insights**
* Modern **industrial data backends**
::::

:::::


:::{rubric} Benefits and Features
:::

Whether you are a developer,
database administrator, or just starting your journey with CrateDB, our
documentation provides the information and knowledge needed to build
real-time analytics and hybrid search applications that leverage CrateDB's
unique features.

:::{rubric} Benefits
:::
* In a unified data platform approach, CrateDB includes analyzing relational, JSON,
time-series, geospatial, full-text, and vector data within a single system,
* In a unified data platform, CrateDB lets you analyze relational, JSON,
time-series, geospatial, full-text, and vector data in a single system,
eliminating the need for multiple databases.
* The fully distributed SQL query engine, built on top of Apache Lucene,
and inheriting technologies from Elasticsearch/OpenSearch, provides performant
Expand All @@ -32,28 +78,28 @@ unique features.
indexing strategy.
* The flexible data schema dynamically adapts based on the data you ingest,
offering seamless integration and instant readiness for analysis.
* Columnar storage enables fast search query and aggregation performance.
* PostgreSQL wire protocol compatibility and a HTTP interface provide versatile
* Columnar storage enables fast query and aggregation performance.
* PostgreSQL wire protocol compatibility and an HTTP interface provide versatile
integration capabilities.
* AI-ready: The vector store subsystem integrates well
with an extensive 3rd party ecosystem of AI/ML frameworks for advanced data
with an extensive third-party ecosystem of AI/ML frameworks for advanced data
analysis and data-driven decisions.


::::::{grid} 1
:margin: 1
:padding: 2
## Get Started

:::{grid-item-card} {material-outlined}`rocket_launch;1.7em` CrateDB Cloud
:link: cloud-docs-index
We've put together guides to help you set up your CrateDB instance
quickly and easily. Enjoy reading!

:::{card} {material-outlined}`rocket_launch;1.7em` CrateDB Cloud
:link: cloud:index
:link-type: ref
:link-alt: CrateDB Cloud
:padding: 2
:class-title: sd-fs-5

Start with a fully managed CrateDB instance to accelerate and simplify working
with analytical data. CrateDB Cloud enables seamless deployment, monitoring,
backups, and scaling of CrateDB clusters on AWS, Azure or GCPs, eliminating
backups, and scaling of CrateDB clusters on AWS, Azure, or GCP, eliminating
the need for direct database management.

With CrateDB Cloud, you can skip infrastructure setup and focus on delivering
Expand All @@ -63,56 +109,19 @@ and various connectors to import data.
```{button-link} https://cratedb.com/docs/cloud/tutorials/quick-start.html
:color: primary
:expand:
**Start forever free cluster with 8 GB of storage**
**Start a forever-free cluster with 8 GB of storage**
```
:::

:::::{grid-item}
:margin: 0
:padding: 2

::::{grid} 2
:margin: 0
:padding: 0

:::{grid-item-card} {material-outlined}`lightbulb;1.7em` Database Features
:link: https://cratedb.com/docs/guide/feature/
:link-alt: Database Features
:class-title: sd-fs-5

Explore all functional, operational and advanced features of CrateDB at a glance.
:::

:::{grid-item-card} {material-outlined}`auto_stories;1.7em` Database Manual
:link: https://cratedb.com/docs/reference/
:link-alt: Database Manual
:class-title: sd-fs-5

Learn core CrateDB concepts, including data modeling, querying data,
aggregations, sharding, and more.
:::

::::
:::::

:::{grid-item-card} {material-outlined}`link;1.7em` Client Libraries
:link: https://cratedb.com/docs/crate/clients-tools/en/latest/connect/
:link-alt: CrateDB: Client Drivers and Libraries
:padding: 2
:::{card} {material-outlined}`not_started;1.7em` Getting Started
:link: getting-started
:link-type: ref
:link-alt: Getting started with CrateDB
: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 and adapters, CrateDB is compatible with [ODBC],
[JDBC], and other database API specifications.
Helpful guides about how to start working with your database cluster.
:::

::::::


## Learn

Expand All @@ -124,8 +133,8 @@ Learn about the fundamentals of CrateDB, guided and self-guided.
:padding: 0

:::{grid-item-card}
:link: https://cratedb.com/docs/guide/getting-started.html
:link-alt: Getting started with CrateDB
:link: getting-started
:link-type: ref
:padding: 3
: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
Expand All @@ -138,7 +147,8 @@ Learn how to interact with the database for the first time.
:::

:::{grid-item-card}
:link: https://cratedb.com/docs/guide/
:link: index
:link-type: ref
:link-alt: The CrateDB Guide
:padding: 3
:class-header: sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize
Expand Down Expand Up @@ -190,7 +200,8 @@ Learn about the fundamental tools that support working directly with CrateDB.
:padding: 0

:::{grid-item-card} Admin UI
:link: https://cratedb.com/docs/crate/admin-ui/
:link: crate-admin-ui:index
:link-type: ref
:link-alt: The CrateDB Admin UI
:padding: 3
:class-card: sd-pt-3
Expand All @@ -203,7 +214,8 @@ Learn about CrateDB's included web administration interface.
:::

:::{grid-item-card} Crash CLI
:link: https://cratedb.com/docs/crate/crash/
:link: crate-crash:index
:link-type: ref
:link-alt: The Crash CLI
:padding: 3
:class-card: sd-pt-3
Expand All @@ -218,11 +230,68 @@ 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

:::{grid-item-card} {material-outlined}`lightbulb;1.7em` Database Features
:link: features
:link-type: ref
:link-alt: Database Features
:class-title: sd-fs-5

Explore all functional, operational and advanced features of CrateDB at a glance.
:::

:::{grid-item-card} {material-outlined}`auto_stories;1.7em` Database Manual
:link: crate-reference:index
:link-type: ref
:link-alt: Database Manual
:class-title: sd-fs-5

Learn core CrateDB concepts, including data modeling, querying data,
aggregations, sharding, and more.
:::

::::
:::::

:::{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} Drivers and Integrations
:::

Learn about database client libraries, drivers, adapters, connectors,
and integrations with 3rd-party applications and frameworks.
and integrations with third-party applications and frameworks.

::::{grid} 2 3 3 3
:padding: 0
Expand Down Expand Up @@ -253,7 +322,7 @@ Discover integrations and solutions from the open-source community and CrateDB p
:class-footer: text-smaller
{material-outlined}`integration_instructions;3.5em`
+++
Learn about the variety of options to connect and integrate with 3rd-party applications.
Learn about the variety of options to connect and integrate with third-party applications.
:::


Expand Down Expand Up @@ -281,7 +350,7 @@ Learn how to use CrateDB by digesting concise examples.
::::{grid} 2 3 3 3
:padding: 0

:::{grid-item-card} CrateDB Examples
:::{grid-item-card} CrateDB Examples
:link: https://github.com/crate/cratedb-examples
:link-alt: CrateDB Examples
:padding: 3
Expand All @@ -294,7 +363,7 @@ Learn how to use CrateDB by digesting concise examples.
A collection of clear and concise examples how to work with CrateDB.
:::

:::{grid-item-card} Sample Apps
:::{grid-item-card} Sample Apps
:link: https://github.com/crate/crate-sample-apps/
:link-alt: CrateDB Sample Apps
:padding: 3
Expand Down Expand Up @@ -343,7 +412,6 @@ Make sure you also do not miss relevant [CrateDB customer stories].

[CrateDB customer stories]: https://www.youtube.com/playlist?list=PLDZqzXOGoWUJrAF_lVx9U6BzAGG9xYz_v
[HTTP protocol]: https://en.wikipedia.org/wiki/HTTP
[Integrations]: #integrate
[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
Expand Down