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
2 changes: 1 addition & 1 deletion docs/en/developer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Databend provides REST APIs for direct integration and custom applications.

## Development Tools

- **[BendSQL CLI](/tutorials/connect/connect-to-databendcloud-bendsql)** - Command-line interface for Databend
- **[BendSQL CLI](/tutorials/getting-started/connect-to-databendcloud-bendsql)** - Command-line interface for Databend
- **[Databend Cloud Console](/guides/cloud/using-databend-cloud/worksheet)** - Web-based management interface

## Additional Resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ To view the dashboards shared with you by others, click **Dashboards** in the si

## Tutorials

- [Dashboarding COVID-19 Data](/tutorials/databend-cloud/dashboard)
- [Dashboarding COVID-19 Data](/tutorials/cloud-ops/dashboard)
2 changes: 1 addition & 1 deletion docs/en/guides/30-sql-clients/00-bendsql/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ bendsql
## Tutorials

- [Connecting to Self-Hosted Databend using BendSQL](/tutorials/)
- [Connecting to Databend Cloud using BendSQL](/tutorials/connect/connect-to-databendcloud-bendsql)
- [Connecting to Databend Cloud using BendSQL](/tutorials/getting-started/connect-to-databendcloud-bendsql)

## BendSQL Settings

Expand Down
4 changes: 2 additions & 2 deletions docs/en/guides/40-load-data/02-load-db/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ To download bend-ingest-kafka and learn more about the tool, visit the [GitHub r

## Tutorials

- [Loading from Kafka with bend-ingest-kafka](/tutorials/load/kafka-bend-ingest-kafka)
- [Loading from Kafka with databend-kafka-connect](/tutorials/load/kafka-databend-kafka-connect)
- [Loading from Kafka with bend-ingest-kafka](/tutorials/ingest-and-stream/kafka-bend-ingest-kafka)
- [Loading from Kafka with databend-kafka-connect](/tutorials/ingest-and-stream/kafka-databend-kafka-connect)
2 changes: 1 addition & 1 deletion docs/en/guides/57-data-management/02-data-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,4 @@ export AWS_SECRET_ACCESS_KEY=minioadmin

### Tutorials

- [Backing Up and Restoring Data with BendSave](/tutorials/recovery/bendsave)
- [Backing Up and Restoring Data with BendSave](/tutorials/operate-and-recover/bendsave)
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,4 @@ CONNECTION = (CONNECTION_NAME = 'my_s3_connection');

## Learn More

- [Linking Tables with ATTACH TABLE](/tutorials/databend-cloud/link-tables)
- [Linking Tables with ATTACH TABLE](/tutorials/cloud-ops/link-tables)
4 changes: 3 additions & 1 deletion docs/en/tutorials/_category_.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{
"label": "Tutorials"
"label": "Tutorials",
"link": { "type": "doc", "id": "index" },
"position": 0
}
4 changes: 4 additions & 0 deletions docs/en/tutorials/cloud-ops/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Cloud Operations",
"position": 6
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Analyzing AWS Billing
title: "Databend Cloud: AWS Billing"
sidebar_label: "AWS Billing"
---

In this tutorial, we'll walk you through the process of importing AWS billing data and conducting cost analysis using SQL. You'll learn how to load the AWS billing data into Databend Cloud, query it to find key cost drivers, and gain insights into your AWS usage.
Expand Down Expand Up @@ -271,4 +272,4 @@ WHERE
line_item_blended_cost IS NOT NULL
GROUP BY Instance_Type
ORDER BY Total_Cost DESC;
```
```
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Dashboarding COVID-19 Data
title: "Databend Cloud: Dashboard Tour"
sidebar_label: "Dashboard"
---
import StepsWrap from '@site/src/components/StepsWrap';
import StepContent from '@site/src/components/Steps/step-content';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Linking Tables with ATTACH TABLE
title: "Databend Cloud: Data Sharing via ATTACH TABLE"
sidebar_label: "Data Sharing"
---

In this tutorial, we'll walk you through how to link a table in Databend Cloud with an existing Databend table stored in an S3 bucket using the [ATTACH TABLE](/sql/sql-commands/ddl/table/attach-table) command.
Expand Down Expand Up @@ -57,7 +58,7 @@ SELECT snapshot_location FROM FUSE_SNAPSHOT('default', 'population');

## Step 2: Set Up Attached Tables in Databend Cloud

1. Connect to Databend Cloud using BendSQL. If you're unfamiliar with BendSQL, refer to this tutorial: [Connecting to Databend Cloud using BendSQL](../connect/connect-to-databendcloud-bendsql.md).
1. Connect to Databend Cloud using BendSQL. If you're unfamiliar with BendSQL, refer to this tutorial: [Connecting to Databend Cloud using BendSQL](../getting-started/connect-to-databendcloud-bendsql.md).

2. Execute the following statements to create two attached tables:
- The first table, `population_all_columns`, includes all columns from the source data.
Expand Down
3 changes: 0 additions & 3 deletions docs/en/tutorials/connect/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions docs/en/tutorials/databend-cloud/_category_.json

This file was deleted.

4 changes: 4 additions & 0 deletions docs/en/tutorials/develop/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Develop with Databend",
"position": 4
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Integrating with Databend Cloud using databend-driver
title: "Python: Databend Cloud with databend-driver"
---

In this tutorial, we'll walk you through how to use the `databend-driver` to connect to Databend Cloud, create a table, insert data, and retrieve results with Python.
Expand Down Expand Up @@ -53,4 +53,4 @@ for row in rows:
python main.py
(1, 'yy')
(2, 'xx')
```
```
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Integrating with Databend Cloud using databend-sqlalchemy
title: "Python: Databend Cloud with SQLAlchemy"
---

In this tutorial, we'll walk you through how to use the `databend-sqlalchemy` library to connect to Databend Cloud, create a table, insert data, and query results using Python.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Integrating with Self-Hosted Databend
title: "Python: Self-hosted Databend"
---

This tutorial demonstrates how to connect to a locally deployed Databend instance using Python. We'll cover three approaches—`databend-driver`, `databend-sqlalchemy` with the connector, and `databend-sqlalchemy` with the engine—to perform basic operations such as creating a database, adding a table, inserting data, querying, and cleaning up resources.
Expand Down Expand Up @@ -171,4 +171,4 @@ Readings in Database Systems Michael Stonebraker 2004
```

</TabItem>
</Tabs>
</Tabs>
4 changes: 4 additions & 0 deletions docs/en/tutorials/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Connect to Databend",
"position": 1
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Connecting to Self-Hosted Databend using BendSQL"
sidebar_label: "Connecting to Self-Hosted Databend (BendSQL)"
slug: /
title: "Connect with BendSQL (Self-hosted)"
sidebar_label: "Connect with BendSQL (Self-hosted)"
---

import StepsWrap from '@site/src/components/StepsWrap';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Connecting to Self-Hosted Databend using DBeaver"
sidebar_label: "Connecting to Self-Hosted Databend (DBeaver)"
title: "Connect with DBeaver (Self-hosted)"
sidebar_label: "Connect with DBeaver (Self-hosted)"
---

import StepsWrap from '@site/src/components/StepsWrap';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Connecting to Databend Cloud using BendSQL"
sidebar_label: "Connecting to Databend Cloud (BendSQL)"
title: "Connect to Databend Cloud with BendSQL"
sidebar_label: "Databend Cloud with BendSQL"
---

import StepsWrap from '@site/src/components/StepsWrap';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Connecting to Databend Cloud using DBeaver'
sidebar_label: 'Connecting to Databend Cloud (DBeaver)'
title: 'Connect to Databend Cloud with DBeaver'
sidebar_label: 'Databend Cloud with DBeaver'
---
import StepsWrap from '@site/src/components/StepsWrap';
import StepContent from '@site/src/components/Steps/step-content';
Expand Down
43 changes: 43 additions & 0 deletions docs/en/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
id: index
title: Tutorials
slug: /
sidebar_label: Overview
sidebar_position: 0
description: Find hands-on guides for connecting, ingesting, migrating, developing, and operating Databend.
---

Pick a task to get started:

## Connect to Databend
- [BendSQL (Self-hosted)](/tutorials/getting-started/connect-to-databend-bendsql)
- [DBeaver (Self-hosted)](/tutorials/getting-started/connect-to-databend-dbeaver)
- [BendSQL (Databend Cloud)](/tutorials/getting-started/connect-to-databendcloud-bendsql)
- [DBeaver (Databend Cloud)](/tutorials/getting-started/connect-to-databendcloud-dbeaver)

## Ingest & Stream Data
- [Kafka to Databend via Bend Ingest](/tutorials/ingest-and-stream/kafka-bend-ingest-kafka)
- [Kafka Connect Sink](/tutorials/ingest-and-stream/kafka-databend-kafka-connect)
- [Vector log ingestion to Databend Cloud](/tutorials/ingest-and-stream/automating-json-log-loading-with-vector)
- [MySQL/Redis dictionaries](/tutorials/ingest-and-stream/access-mysql-and-redis)
- [Query system metadata](/tutorials/ingest-and-stream/query-metadata)

## Migrate Databases
- [How to choose a MySQL migration path](/tutorials/migrate/)
- [MySQL CDC with Debezium](/tutorials/migrate/migrating-from-mysql-with-debezium)
- [MySQL CDC with Flink](/tutorials/migrate/migrating-from-mysql-with-flink-cdc)
- [MySQL batch: db-archiver / DataX / Addax](/tutorials/migrate/migrating-from-mysql-with-db-archiver)
- [Snowflake to Databend](/tutorials/migrate/migrating-from-snowflake)

## Develop with Databend
- [Python + Databend Cloud (driver)](/tutorials/develop/python/integrating-with-databend-cloud-using-databend-driver)
- [Python + Databend Cloud (SQLAlchemy)](/tutorials/develop/python/integrating-with-databend-cloud-using-databend-sqlalchemy)
- [Python + Self-hosted Databend](/tutorials/develop/python/integrating-with-self-hosted-databend)

## Operate & Recover
- [Disaster recovery with BendSave](/tutorials/operate-and-recover/bendsave)

## Cloud Operations
- [Understand AWS billing](/tutorials/cloud-ops/aws-billing)
- [Use the Databend Cloud dashboard](/tutorials/cloud-ops/dashboard)
- [Link tables across databases](/tutorials/cloud-ops/link-tables)
4 changes: 4 additions & 0 deletions docs/en/tutorials/ingest-and-stream/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Ingest & Stream Data",
"position": 2
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Accessing MySQL and Redis with Dictionaries
title: Access MySQL & Redis via Dictionaries
---

In this tutorial, we’ll guide you through accessing MySQL and Redis data using dictionaries in Databend. You’ll learn how to create dictionaries that map to these external data sources, enabling seamless data querying and integration.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Automating JSON Log Loading with Vector
title: Ingest JSON Logs with Vector (Cloud)
---

In this tutorial, we'll simulate generating logs locally, collect them using [Vector](https://vector.dev/), store them in S3, and automate their ingestion into Databend Cloud using scheduled tasks.
Expand Down Expand Up @@ -202,4 +202,4 @@ SELECT * FROM logs;
│ login │ 2024-12-08 10:00:00 │ 1 │
│ purchase │ 2024-12-08 10:05:00 │ 2 │
└──────────────────────────────────────────────────────────┘
```
```
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Loading from Kafka with bend-ingest-kafka
title: Ingest Kafka with Bend Ingest
---

In this tutorial, we'll guide you through setting up a Kafka environment using Docker and loading messages from Kafka into Databend Cloud with [bend-ingest-kafka](https://github.com/databendcloud/bend-ingest-kafka).
Expand Down Expand Up @@ -148,4 +148,4 @@ record_metadata: {"create_time":"2024-08-27T19:10:45.888Z","key":"","offset":0,"
raw_data: {"age":25,"id":2,"name":"Bob"}
record_metadata: {"create_time":"2024-08-27T19:10:52.946Z","key":"","offset":1,"partition":0,"topic":"test-topic"}
add_time: 2024-08-27 19:12:55.081470
```
```
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Loading from Kafka with databend-kafka-connect
title: Ingest Kafka with Kafka Connect
---

In this tutorial, we'll establish a connection between Kafka in Confluent Cloud and Databend Cloud using the Kafka Connect sink connector plugin, [databend-kafka-connect](https://github.com/databendcloud/databend-kafka-connect). Then, we'll demonstrate how to produce messages and load them into Databend Cloud.
Expand Down Expand Up @@ -185,4 +185,4 @@ Starting Kafka Producer. Use Ctrl-C or Ctrl-D to exit.

3. In Databend Cloud, verify that the data has been successfully loaded:

![alt text](../../../../static/img/documents/tutorials/kafka-5.png)
![alt text](../../../../static/img/documents/tutorials/kafka-5.png)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Querying Metadata
title: Inspect Databend Metadata
---

In this tutorial, we'll walk you through uploading a sample Parquet file to an internal stage, inferring the column definitions, and creating a table that includes file-level metadata fields. This is useful when you want to track the origin of each row or include metadata like file names and row numbers in your dataset.
Expand Down
3 changes: 0 additions & 3 deletions docs/en/tutorials/integrate/_category_.json

This file was deleted.

3 changes: 0 additions & 3 deletions docs/en/tutorials/load/_category_.json

This file was deleted.

5 changes: 3 additions & 2 deletions docs/en/tutorials/migrate/_category_.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{
"label": "Migrating from Databases"
}
"label": "Database Migration",
"position": 3
}
2 changes: 1 addition & 1 deletion docs/en/tutorials/migrate/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Data Migration to Databend
title: Plan Your Migration to Databend
---

# Data Migration to Databend
Expand Down
4 changes: 2 additions & 2 deletions docs/en/tutorials/migrate/migrating-from-mysql-with-addax.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Migrating from MySQL with Addax
sidebar_label: 'MySQL → Databend: Addax'
title: Migrate MySQL with Addax (Batch)
sidebar_label: 'MySQL → Databend: Addax (Batch)'
---

> **Capabilities**: Full Load, Incremental
Expand Down
6 changes: 3 additions & 3 deletions docs/en/tutorials/migrate/migrating-from-mysql-with-datax.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Migrating from MySQL with DataX
sidebar_label: 'MySQL → Databend: DataX'
title: Migrate MySQL with DataX (Batch)
sidebar_label: 'MySQL → Databend: DataX (Batch)'
---

> **Capabilities**: Full Load, Incremental
Expand Down Expand Up @@ -121,4 +121,4 @@ databend> select * from migrated_db.tb01;
| 1 | 4.1 | 2023-02-01 07:11:08.501000 | test2 |
| 1 | 4.1 | 2023-02-01 07:11:08.501000 | test2 |
+------+------+----------------------------+-------+
```
```
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Migrating from MySQL with db-archiver
sidebar_label: 'MySQL → Databend: db-archiver'
title: Migrate MySQL with db-archiver (Batch)
sidebar_label: 'MySQL → Databend: db-archiver (Batch)'
---

> **Capabilities**: Full Load, Incremental
Expand Down Expand Up @@ -109,7 +109,7 @@ Bye

## Step 3: Set Up Target in Databend Cloud

1. Connect to Databend Cloud using BendSQL. If you're unfamiliar with BendSQL, refer to this tutorial: [Connecting to Databend Cloud using BendSQL](../connect/connect-to-databendcloud-bendsql.md).
1. Connect to Databend Cloud using BendSQL. If you're unfamiliar with BendSQL, refer to this tutorial: [Connecting to Databend Cloud using BendSQL](../getting-started/connect-to-databendcloud-bendsql.md).
2. Copy and paste the following SQL to create a target table named **my_table**:

```sql
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Migrating from MySQL with Debezium
sidebar_label: 'MySQL → Databend: Debezium'
title: Migrate MySQL with Debezium (CDC)
sidebar_label: 'MySQL → Databend: Debezium (CDC)'
---

> **Capabilities**: CDC, Full Load
Expand Down Expand Up @@ -92,4 +92,4 @@ quarkus.log.level=INFO
quarkus.log.category."org.eclipse.jetty".level=WARN
```

You're all set! If you query the products table in Databend, you will see that the data from MySQL has been successfully synchronized. Feel free to perform insertions, updates, or deletions in MySQL, and you will observe the corresponding changes reflected in Databend as well.
You're all set! If you query the products table in Databend, you will see that the data from MySQL has been successfully synchronized. Feel free to perform insertions, updates, or deletions in MySQL, and you will observe the corresponding changes reflected in Databend as well.
Loading
Loading