Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
128 changes: 84 additions & 44 deletions docs/connect/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <crate-admin-ui:index>`.
:::
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.
Expand All @@ -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 <crate-crash:index>`, 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}

Expand Down Expand Up @@ -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
Expand Down
71 changes: 71 additions & 0 deletions docs/feature/highlights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
(highlights)=

# Feature highlights

:::{div} sd-text-muted
Important fundamental features of CrateDB.
:::

:{material-outlined}`article;1.75em` {ref}`Document store <document>`:

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 <search-overview>`:

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 <query>`:

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 <solutions>`:

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 <categories>`:

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.
76 changes: 11 additions & 65 deletions docs/feature/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
(all-features)=
# All Features

:::{toctree}
:maxdepth: 1
:hidden:

Highlights <highlights>
:::

All features of CrateDB at a glance.

:::::{grid} 1 3 3 3
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.
>
> <small>-– Henrik Ingo, Nyrkiö Oy, independent database consultant, MongoDB</small>

> 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!
>
> <small>-- Daniel Hölbling-Inzko, Director of Engineering Analytics, Bitmovin</small>
Loading