Skip to content

Commit eeadf59

Browse files
amotlamotl
committed
Features: Add dedicated pages about...
blob, cloud, cluster, fdw, query, replication, snapshot, sql, vector
1 parent bb18f77 commit eeadf59

File tree

12 files changed

+179
-5
lines changed

12 files changed

+179
-5
lines changed

‎docs/_include/styles.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44
TODO: Upstream to crate-docs-theme.
55
-->
66
<style>
7+
/*
78
.sd-card-body {
89
line-height: 1.1em;
910
}
11+
*/
1012
.sd-card-footer {
1113
font-size: small;
1214
}

‎docs/admin/clustering/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _clustering:
1+
.. _admin-clustering:
22

33
==========
44
Clustering

‎docs/feature/blob/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
(blob)=
2+
3+
# BLOB Store
4+
5+
:::{todo} Implement.
6+
:::

‎docs/feature/cloud/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
(cloud)=
2+
3+
# Cloud Native
4+
5+
:::{todo} Implement.
6+
:::

‎docs/feature/cluster/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
(clustering)=
2+
3+
# Clustering
4+
5+
:::{todo} Implement.
6+
7+
About scalability through partitioning, sharding, and replication.
8+
Also about cross cluster replication.
9+
:::
10+
11+
12+
:::{seealso}
13+
**Domains:**
14+
[](#metrics-store) •
15+
[](#analytics) •
16+
[](#industrial) •
17+
[](#timeseries) •
18+
[](#machine-learning)
19+
20+
**Product:**
21+
[Relational Database]
22+
:::
23+
24+
25+
[Relational Database]: https://cratedb.com/solutions/relational-database

‎docs/feature/fdw/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
(fdw)=
2+
3+
# Foreign Data Wrapper
4+
5+
:::{todo} Implement.
6+
:::
7+
8+
9+
:::{seealso}
10+
**Product:**
11+
[Relational Database]
12+
:::
13+
14+
15+
[Relational Database]: https://cratedb.com/solutions/relational-database

‎docs/feature/index.md

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,55 @@
55

66
All features of CrateDB at a glance.
77

8-
```{toctree}
9-
:maxdepth: 1
8+
:::::{grid} 1 3 3 3
9+
:margin: 4 4 0 0
10+
:padding: 0
11+
:gutter: 2
1012

11-
document/index
13+
::::{grid-item-card} {material-outlined}`lightbulb;2em` Fundamentals
14+
:::{toctree}
15+
:maxdepth: 1
16+
sql/index
1217
relational/index
18+
document/index
1319
search/index
1420
geospatial/index
21+
vector/index
22+
blob/index
23+
:::
24+
+++
25+
CrateDB combines the advantages of traditional SQL databases with the
26+
best properties of NoSQL databases.
27+
::::
28+
29+
::::{grid-item-card} {material-outlined}`group;2em` Operational
30+
:::{toctree}
31+
:maxdepth: 1
32+
cluster/index
33+
snapshot/index
1534
connectivity/index
35+
cloud/index
36+
:::
37+
+++
38+
CrateDB scales horizontally using a shared-nothing
39+
architecture, inherited from Elasticsearch.
40+
::::
41+
42+
::::{grid-item-card} {material-outlined}`read_more;2em` More
43+
:::{toctree}
44+
:maxdepth: 1
45+
query/index
1646
generated/index
47+
fdw/index
1748
udf/index
18-
```
49+
replication/index
50+
:::
51+
+++
52+
Advanced features supporting daily data
53+
operations, all based on standard SQL.
54+
::::
55+
56+
:::::
1957

2058

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

6199

62100
::::
101+
102+
103+
```{include} /_include/styles.html
104+
```

‎docs/feature/query/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
(query)=
2+
(querying)=
3+
4+
# Advanced Querying
5+
6+
:::{todo} Implement.
7+
:::
8+
9+
10+
(aggregation)=
11+
(aggregations)=
12+
13+
## Aggregations
14+
15+
:::{todo} Implement.
16+
:::

‎docs/feature/replication/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
(replication)=
2+
3+
# Cross-Cluster Replication
4+
5+
:::{todo} Implement.
6+
:::

‎docs/feature/snapshot/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
(snapshot)=
2+
3+
# Snapshots
4+
5+
:::{todo} Implement.
6+
:::

‎docs/feature/sql/index.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
(sql)=
2+
3+
# SQL
4+
5+
:::{todo} Implement.
6+
:::
7+
8+
9+
CrateDB is wire-protocol compatible to PostgreSQL, and you can use all of its
10+
features using plain SQL.
11+
Other than integrating well with commodity systems using standard database
12+
access interfaces like ODBC or JDBC, it provides a proprietary HTTP interface
13+
on top.
14+
15+
You have a variety of options to connect to CrateDB, and to integrate it with
16+
off-the-shelve, 3rd-party, open-source, and proprietary applications.
17+
18+
See {ref}`connect`.
19+
20+
21+
:::{seealso}
22+
**Domains:**
23+
[](#metrics-store) •
24+
[](#analytics) •
25+
[](#industrial) •
26+
[](#timeseries) •
27+
[](#machine-learning)
28+
29+
**Product:**
30+
[Relational Database]
31+
:::
32+
33+
34+
[Relational Database]: https://cratedb.com/solutions/relational-database

‎docs/feature/vector/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
(hnsw)=
2+
(vector)=
3+
4+
# Vector Store
5+
6+
:::{todo} Implement.
7+
:::
8+
9+
10+
:::{seealso}
11+
**Product:**
12+
[Relational Database]
13+
:::
14+
15+
16+
[Relational Database]: https://cratedb.com/solutions/relational-database

0 commit comments

Comments
 (0)