Skip to content

Commit af871ff

Browse files
committed
Getting started: Rework whole section
1 parent f2cf2ad commit af871ff

File tree

7 files changed

+101
-27
lines changed

7 files changed

+101
-27
lines changed

docs/_include/links.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[Admin UI]: inv:crate-admin-ui:*:label#index
12
[Amazon DynamoDB Streams]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html
23
[Amazon Kinesis Data Streams]: https://docs.aws.amazon.com/streams/latest/dev/introduction.html
34
[AWS Database Migration Service (AWS DMS)]: https://aws.amazon.com/dms/
@@ -7,8 +8,9 @@
78
[cloud-datashader-github]: https://github.com/crate/cratedb-examples/blob/amo/cloud-datashader/topic/timeseries/explore/cloud-datashader.ipynb
89
[CTE]: inv:crate-reference#sql_dql_with
910
[CrateDB BLOBs]: inv:crate-reference:*:label#blob_support
10-
[CrateDB Cloud]: https://cratedb.com/product/cloud
11+
[CrateDB Cloud]: inv:cloud:*:label#index
1112
[CrateDB JDBC Driver]: https://cratedb.com/docs/jdbc/
13+
[CrateDB Reference Manual]: inv:crate-reference:*:label#index
1214
[CrateDB Self-Managed]: https://cratedb.com/product/self-managed
1315
[CrateDB's PostgreSQL interface]: inv:crate-reference#interface-postgresql
1416
[crate-jdbc-standalone]: https://repo1.maven.org/maven2/io/crate/crate-jdbc-standalone/

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,9 +304,9 @@ use-cases.
304304
```{toctree}
305305
:hidden:
306306
307+
start/index
307308
install/index
308309
connect/index
309-
getting-started
310310
Ingestion <ingest/index>
311311
feature/index
312312
admin/index
Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1-
(use)=
2-
(getting-started)=
1+
# Connect to cluster
32

4-
# Getting Started
5-
6-
7-
{#introduction}
8-
## Introduction
3+
:::{include} /_include/links.md
4+
:::
5+
:::{include} /_include/styles.html
6+
:::
97

10-
Once CrateDB is [installed and running](#install), you can start to interact
8+
Once CrateDB is {ref}`installed and running <install>`, you can start to interact
119
with the database for the first time.
1210

1311

1412
{#use-admin-ui}
15-
### The Admin UI
16-
13+
## Admin UI
14+
:::{div}
1715
CrateDB ships with a browser-based administration interface called
18-
[Admin UI](inv:crate-admin-ui:*:label#index).
16+
[Admin UI].
17+
:::
1918
It is enabled on each CrateDB node, you can use it to inspect and
2019
interact with the whole CrateDB cluster in a number of ways.
2120

@@ -36,28 +35,21 @@ a dedicated user account for accessing the Admin UI. See [](#create-user).
3635

3736

3837
{#use-crash}
39-
### The CrateDB Shell
38+
## CrateDB Shell
4039

4140
The CrateDB Shell, called `crash`, is an interactive command-line interface
4241
(CLI) program for working with CrateDB on your favorite terminal. To learn more
43-
about it, please refer to its documentation at [](inv:crate-crash:*:label#index).
42+
about it, please refer to its documentation at {ref}`crate-crash:index`.
4443

4544
![image](https://cratedb.com/docs/crate/crash/en/latest/_images/query.png){width=320px}
4645

4746

4847
{#use-dive-in}
4948
{#use-start-building}
50-
## How to Connect
51-
There is a dedicated page which enumerates all the connectivity options.
52-
53-
- {ref}`connect`
54-
49+
## Adapters and drivers
50+
:::{div}
51+
- To learn how to connect to CrateDB using software drivers, see {ref}`connect`.
5552

56-
:::{tip}
57-
To learn more about all the details of CrateDB features, operations, and
58-
its SQL dialect, please also visit the [CrateDB Reference Manual].
53+
- To learn more about all the details of CrateDB features, operations, and
54+
its SQL dialect, please also visit the [CrateDB Reference Manual].
5955
:::
60-
61-
62-
[CrateDB Cloud]: inv:cloud:*:label#index
63-
[CrateDB Reference Manual]: inv:crate-reference:*:label#index

docs/start/create.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Create a cluster
2+
3+
:::{rubric} CrateDB Cloud
4+
:::
5+
6+
The fastest and easy way is to create a [CrateDB Cloud cluster][CrateDB Cloud Console].
7+
See also documentation about {ref}`creating a new cluster in CrateDB Cloud <cloud:quick-start>`.
8+
A free tier is available.
9+
10+
Basic support is included. If you need premium support, please [check out our support plans].
11+
12+
:::{rubric} CrateDB Self-Deployed
13+
:::
14+
15+
If you want to deploy CrateDB yourself, select the deployment model below:
16+
17+
* Deploy on-premises or locally: {ref}`install`
18+
* Deploy on your own Cloud: {ref}`install-cloud`
19+
20+
For support, please [check out our support plans].
21+
22+
23+
[check out our support plans]: https://cratedb.com/support/support-plans
24+
[CrateDB Cloud Console]: https://console.cratedb.cloud/

docs/start/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
(use)=
2+
(getting-started)=
3+
# Getting Started
4+
5+
```{toctree}
6+
:maxdepth: 1
7+
8+
create
9+
connect
10+
schema
11+
Ingesting data <../ingest/index>
12+
query
13+
```
14+
15+
16+
:::{note}
17+
To learn more about all the details of CrateDB features, operations, and
18+
its SQL dialect, please also visit the [CrateDB Reference Manual].
19+
:::
20+
21+
22+
[CrateDB Reference Manual]: inv:crate-reference:*:label#index

docs/start/query.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Querying data
2+
3+
SQL is the most widely used language for querying data and is the natural
4+
choice for people in many roles working with data in databases.
5+
6+
CrateDB extends industry-standard SQL with functionalities to support its
7+
data types, data I/O procedures, and cluster management.
8+
9+
To learn more, check out the {ref}`SQL syntax reference manual <crate-reference:sql>`.
10+
11+
12+
:::{note}
13+
🚧 _Please note this page is a work in progress._ 🚧
14+
:::

docs/start/schema.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Create table schema
2+
3+
In CrateDB you can create a table within a schema like
4+
```sql
5+
CREATE TABLE schema_name.table_name;
6+
```
7+
8+
Also, you can grant rights like so on a schema (even if it doesn’t explicitly exist yet):
9+
```sql
10+
GRANT DQL ON SCHEMA schema_name TO user_name;
11+
```
12+
13+
In CrateDB, schemas are just namespaces that are created and dropped implicitly.
14+
Therefore, when `GRANT`, `DENY` or `REVOKE` are invoked on a schema level,
15+
CrateDB takes the schema name provided without further validation.
16+
17+
18+
:::{note}
19+
🚧 _Please note this page is a work in progress._ 🚧
20+
:::

0 commit comments

Comments
 (0)