Skip to content

Commit

Permalink
Features: Add dedicated pages about...
Browse files Browse the repository at this point in the history
blob, cloud, cluster, fdw, query, replication, snapshot, sql, vector
  • Loading branch information
amotl committed Mar 5, 2024
1 parent 270a4ab commit 9d205d0
Show file tree
Hide file tree
Showing 12 changed files with 179 additions and 5 deletions.
2 changes: 2 additions & 0 deletions docs/_include/styles.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@
TODO: Upstream to crate-docs-theme.
-->
<style>
/*
.sd-card-body {
line-height: 1.1em;
}
*/
.sd-card-footer {
font-size: small;
}
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/clustering/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _clustering:
.. _admin-clustering:

==========
Clustering
Expand Down
6 changes: 6 additions & 0 deletions docs/feature/blob/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
(blob)=

# BLOB Store

:::{todo} Implement.
:::
6 changes: 6 additions & 0 deletions docs/feature/cloud/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
(cloud)=

# Cloud Native

:::{todo} Implement.
:::
25 changes: 25 additions & 0 deletions docs/feature/cluster/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
(clustering)=

# Clustering

:::{todo} Implement.

About scalability through partitioning, sharding, and replication.
Also about cross cluster replication.
:::


:::{seealso}
**Domains:**
[](#metrics-store)
[](#analytics)
[](#industrial)
[](#timeseries)
[](#machine-learning)

**Product:**
[Relational Database]
:::


[Relational Database]: https://cratedb.com/solutions/relational-database
15 changes: 15 additions & 0 deletions docs/feature/fdw/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
(fdw)=

# Foreign Data Wrapper

:::{todo} Implement.
:::


:::{seealso}
**Product:**
[Relational Database]
:::


[Relational Database]: https://cratedb.com/solutions/relational-database
50 changes: 46 additions & 4 deletions docs/feature/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,55 @@

All features of CrateDB at a glance.

```{toctree}
:maxdepth: 1
:::::{grid} 1 3 3 3
:margin: 4 4 0 0
:padding: 0
:gutter: 2

document/index
::::{grid-item-card} {material-outlined}`lightbulb;2em` Fundamentals
:::{toctree}
:maxdepth: 1
sql/index
relational/index
document/index
search/index
geospatial/index
blob/index
vector/index
:::
+++
CrateDB combines the advantages of traditional SQL databases with the
best properties of NoSQL databases.
::::

::::{grid-item-card} {material-outlined}`group;2em` Operational
:::{toctree}
:maxdepth: 1
cluster/index
snapshot/index
connectivity/index
cloud/index
:::
+++
CrateDB scales horizontally using a shared-nothing
architecture, inherited from Elasticsearch.
::::

::::{grid-item-card} {material-outlined}`read_more;2em` More
:::{toctree}
:maxdepth: 1
query/index
generated/index
fdw/index
udf/index
```
replication/index
:::
+++
Advanced features supporting daily data
operations, all based on standard SQL.
::::

:::::


:::{rubric} Features and Use Cases
Expand Down Expand Up @@ -60,3 +98,7 @@ full-text search engine library.


::::


```{include} /_include/styles.html
```
16 changes: 16 additions & 0 deletions docs/feature/query/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
(query)=
(querying)=

# Advanced Querying

:::{todo} Implement.
:::


(aggregation)=
(aggregations)=

## Aggregations

:::{todo} Implement.
:::
6 changes: 6 additions & 0 deletions docs/feature/replication/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
(replication)=

# Cross-Cluster Replication

:::{todo} Implement.
:::
6 changes: 6 additions & 0 deletions docs/feature/snapshot/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
(snapshot)=

# Snapshots

:::{todo} Implement.
:::
34 changes: 34 additions & 0 deletions docs/feature/sql/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
(sql)=

# SQL

:::{todo} Implement.
:::


CrateDB is wire-protocol compatible to PostgreSQL, and you can use all of its
features using plain SQL.
Other than integrating well with commodity systems using standard database
access interfaces like ODBC or JDBC, it provides a proprietary HTTP interface
on top.

You have a variety of options to connect to CrateDB, and to integrate it with
off-the-shelve, 3rd-party, open-source, and proprietary applications.

See {ref}`connect`.


:::{seealso}
**Domains:**
[](#metrics-store)
[](#analytics)
[](#industrial)
[](#timeseries)
[](#machine-learning)

**Product:**
[Relational Database]
:::


[Relational Database]: https://cratedb.com/solutions/relational-database
16 changes: 16 additions & 0 deletions docs/feature/vector/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
(hnsw)=
(vector)=

# Vector Store

:::{todo} Implement.
:::


:::{seealso}
**Product:**
[Relational Database]
:::


[Relational Database]: https://cratedb.com/solutions/relational-database

0 comments on commit 9d205d0

Please sign in to comment.