Skip to content

Commit

Permalink
Merge branch 'crate:main' into storage-usage-guide
Browse files Browse the repository at this point in the history
  • Loading branch information
surister authored Dec 11, 2024
2 parents 753eb13 + 419da11 commit 90b6766
Show file tree
Hide file tree
Showing 9 changed files with 127 additions and 8 deletions.
4 changes: 4 additions & 0 deletions docs/_include/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@
[cloud-datashader-colab]: https://colab.research.google.com/github/crate/cratedb-examples/blob/amo/cloud-datashader/topic/timeseries/explore/cloud-datashader.ipynb
[cloud-datashader-github]: https://github.com/crate/cratedb-examples/blob/amo/cloud-datashader/topic/timeseries/explore/cloud-datashader.ipynb
[CTE]: inv:crate-reference#sql_dql_with
[CrateDB Cloud]: https://cratedb.com/product/cloud
[CrateDB Self-Managed]: https://cratedb.com/product/self-managed
[CrateDB's PostgreSQL interface]: inv:crate-reference#interface-postgresql
[crate-jdbc-standalone]: https://repo1.maven.org/maven2/io/crate/crate-jdbc-standalone/
[crate-jdbc-standalone-latest.jar]: https://repo1.maven.org/maven2/io/crate/crate-jdbc-standalone/2.7.0/crate-jdbc-standalone-2.7.0.jar
[dask-weather-data-colab]: https://colab.research.google.com/github/crate/cratedb-examples/blob/main/topic/timeseries/dask-weather-data-import.ipynb
[dask-weather-data-github]: https://github.com/crate/cratedb-examples/blob/main/topic/timeseries/dask-weather-data-import.ipynb
[Datashader]: https://datashader.org/
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/clustering/scale/auto.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ One of the unique features of CrateDB is that it is a multi-model distributed SQ

CrateDB's fully managed solution comes with a REST API which enables you to automate a lot of tasks. As CrateDB is world famous for its, highly scalable architecture, one of those tasks could be to scale a cluster out (horizontally) when needed, during a peak, for example, and back when possible to reduce costs.

![CrateDB-Scaling-Process|690x389](https://global.discourse-cdn.com/flex020/uploads/crate/original/2X/a/a10f95850f05a064ce022b4ccca45131c1c481cd.png){w=690px align=center}
![CrateDB-Scaling-Process|690x389](https://github.com/user-attachments/assets/f9ba40ff-4cee-45f5-8bfb-d4125c037ea0){w=690px align=center}

This small blog shows how you can use the API to scale out and scale back a cluster when needed.

Expand Down
6 changes: 3 additions & 3 deletions docs/admin/clustering/scale/demand.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ INSERT INTO test (ts) VALUES ('2022-11-18'), ('2022-11-19');
```

The shards will initially look like this:
![image|690x167](https://global.discourse-cdn.com/flex020/uploads/crate/original/1X/ac18a9cb507201d8e54771e320501f4aaac0eb16.png)
![Image](https://github.com/user-attachments/assets/045f66fc-4134-4363-a37a-711a449c43d5)

## Before deploying extra nodes

Expand Down Expand Up @@ -128,7 +128,7 @@ INSERT INTO test (ts) VALUES

We can see that data from before the event stays on the baseline nodes while data for the days of the event gets distributed over all nodes:

![image|690x220](https://global.discourse-cdn.com/flex020/uploads/crate/original/1X/b1c1a1ac42ac3d0eb644529e57c4b9c49eae2e87.png)
![Image](https://github.com/user-attachments/assets/b0f294a4-ff2b-4b84-8a34-aa782cb5a300)

The same can be checked programmatically with this query:

Expand Down Expand Up @@ -164,7 +164,7 @@ Let’s confirm it:
INSERT INTO test (ts) VALUES ('2022-12-19'), ('2022-12-20');
```

![image|690x73](https://global.discourse-cdn.com/flex020/uploads/crate/original/1X/72b9f0bd28fb88402ea951f9f8a9a15c7c491ad2.png)
![image|690x73]

When we are ready to decommission the temporary nodes, we need to move the data collected during the days of the event.

Expand Down
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
# -rate limited-, sleeping...
r"https://medium.com/.*",
r"http://api.open-notify.org/.*",
# Read timed out. (read timeout=15)
r"https://azure.microsoft.com/.*",
]

# Configure intersphinx.
Expand Down
102 changes: 102 additions & 0 deletions docs/integrate/datagrip/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
(datagrip)=
# DataGrip

:::{include} /_include/links.md
:::

```{div}
:style: "float: right; margin-left: 0.5em"
[![](https://blog.jetbrains.com/wp-content/uploads/2019/01/datagrip_icon.svg){w=120px}](https://www.jetbrains.com/datagrip/)
```

[DataGrip] is a cross-platform database IDE that is tailored to suit the
specific needs of professional SQL developers.

It is available as a standalone application and is also included into
other JetBrains products like IntelliJ IDEA and PyCharm.

Connecting DataGrip to CrateDB uses the [CrateDB JDBC Driver].

```{div}
:style: "clear: both"
```


## Install

::::{grid} 2
:::{grid-item}
For connecting to CrateDB, install the [CrateDB JDBC Driver]
using the "Custom JARs" option when adding a database driver.
:::
:::{grid-item}
![Image](https://github.com/user-attachments/assets/a8c1ada6-fd97-43f4-a1ba-91aba1520bdb){h=180px}
![Image](https://github.com/user-attachments/assets/1f925848-fac3-4265-8bd3-96f91daf03c9){h=180px}
:::
:::{grid-item}
[crate-jdbc-standalone] is the right choice here.
For example, download and use the [crate-jdbc-standalone-latest.jar] JAR file,
and select the driver class `io.crate.client.jdbc.CrateDriver`.
:::
:::{grid-item}
![Image](https://github.com/user-attachments/assets/50ccb304-5aaf-4f0b-8ae7-55445f06930c){w=400px}
:::
::::


## Connect

::::{grid} 2

:::{grid-item}
Now, you can add a Data Source using the CrateDB database driver.
Please specify database URL and credentials of your CrateDB cluster.
:::
:::{grid-item}
![Image](https://github.com/user-attachments/assets/147a3e8e-f1d7-413d-9e0c-1ced11333646){w=480px}
:::
:::{grid-item}
For connecting to [CrateDB Self-Managed] or [CrateDB Cloud],
use a connection URL like:
```
jdbc:crate://<host>:5432/
```
:::
:::{grid-item}
![Image](https://github.com/user-attachments/assets/c929aa64-f032-451c-9f9d-45e6aebb12e5){w=480px}
:::

::::


## Usage
After refreshing, you can browse the data tree, and use the Query Console.

![Image](https://github.com/user-attachments/assets/3350a955-0a53-41d7-905b-a71cc4a767e9){h=240px}
![Image](https://github.com/user-attachments/assets/d0a2a09d-a59f-4eda-a488-09d5ce15c08d){h=240px}



## Learn

:::{rubric} Tutorials
:::
- [Blog: Use CrateDB With DataGrip]

:::{rubric} Product
:::
- [CrateDB and DataGrip]

:::{rubric} Notes
:::
:::{note}
We are tracking interoperability issues per [Tool: DataGrip], and appreciate
any contributions and reports.
:::


[Blog: Use CrateDB With DataGrip]: https://cratedb.com/blog/use-cratedb-with-datagrip-an-advanced-database-ide
[CrateDB and DataGrip]: https://cratedb.com/integrations/cratedb-and-datagrip
[CrateDB JDBC Driver]: https://cratedb.com/docs/jdbc/
[DataGrip]: https://www.jetbrains.com/datagrip/
[Tool: DataGrip]: https://github.com/crate/crate/labels/tool%3A%20DataGrip
4 changes: 2 additions & 2 deletions docs/integrate/dbt/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,9 @@ the name generation according to your needs.

:::{grid-item}
:columns: auto auto 8 8
**Intro to Data Build Tool (dbt)**
**Introduction to dbt**

Learn how to get started using dbt (data-build-tool) by following along
Learn how to get started using dbt by following along
with an easy step-by-step tutorial.

In this video, you will learn how to install dbt, initialize a new project
Expand Down
12 changes: 12 additions & 0 deletions docs/integrate/ide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
(ide)=

# Database IDEs

Mostly through its PostgreSQL interface, CrateDB supports working with popular
database IDE (Integrated Development Environment) applications.

```{toctree}
:maxdepth: 2
datagrip/index
```
2 changes: 1 addition & 1 deletion docs/integrate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ This documentation section lists applications, frameworks, and libraries,
which can be used together with CrateDB, and outlines how to use them
optimally.


```{toctree}
:maxdepth: 2
ide
orm
df
etl/index
Expand Down
1 change: 0 additions & 1 deletion docs/migrate/rockset/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,6 @@ and Python example programs.
[clear commitment]: https://cratedb.com/blog/opensource-licensing-founder
[Converged Index™]: https://rockset.com/blog/converged-indexing-the-secret-sauce-behind-rocksets-fast-queries/
[CrateDB]: https://cratedb.com/database
[CrateDB Cloud]: https://cratedb.com/docs/cloud/
[CrateDB Editions]: https://cratedb.com/database/editions
[CrateDB SQL]: project:#sql
[DX]: https://en.wikipedia.org/wiki/User_experience#Developer_experience
Expand Down

0 comments on commit 90b6766

Please sign in to comment.