Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: refactor quick start materials #11114

Merged
merged 2 commits into from
Apr 19, 2023
Merged

docs: refactor quick start materials #11114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58a047f
added
soyeric128 Apr 18, 2023
6d77e2a
Update index.md
soyeric128 Apr 18, 2023
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
3 changes: 3 additions & 0 deletions docs/doc/01-guides/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Quickstarts"
}
161 changes: 108 additions & 53 deletions docs/doc/01-guides/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,105 +1,160 @@
---
title: Get Started
title: Quick Start Resources
---

These tutorials are intended to help you get started with Databend:
Welcome to our Quick Start Resources page!

## Deploying Databend
Whether you're a newbie to Databend or looking to refresh your knowledge, this page is designed to help you get up and running quickly 🚀. We've compiled a list of key documents to help you navigate our documentation and learn the essentials of Databend. From deployment guides to usecases, this page will provide you with everything you need to begin using Databend effectively.

## Databend Setup

Learn various deployment modes and connection options with Databend to customize your setup.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="Deploy" label="Deploy" default>

* [Understanding Deployment Modes](../10-deploy/00-understanding-deployment-modes.md)
* [Deploying a Standalone Databend](../10-deploy/02-deploying-databend.md)
* [Expanding a Standalone Databend](../10-deploy/03-expanding-to-a-databend-cluster.md)
* [Deploying a Query Cluster on Kubernetes](../10-deploy/04-deploying-databend-on-kubernetes.md)
* [Deploying a Local Databend (for Non-Production Use)](../10-deploy/05-deploying-local.md)
* [Local and Docker Deployments (Non-Production Use)](../10-deploy/05-deploying-local.md)
* [Databend Cloud (Beta)](../02-cloud/index.md)

## Connecting to Databend
</TabItem>

<TabItem value="Connect" label="Connect">

* [Connecting to Databend with bendsql](../11-integrations/30-access-tool/01-bendsql.md)
* [Connecting to Databend with JDBC](../11-integrations/30-access-tool/02-jdbc.md)
* [Connecting to Databend with MySQL-Compatible Clients](../11-integrations/30-access-tool/00-mysql.md)

* [How to Connect Databend with MySQL Client](../11-integrations/00-api/01-mysql-handler.md)
* [How to Connect Databend with ClickHouse HTTP Handler](../11-integrations/00-api/02-clickhouse-handler.md)
* [How to Connect Databend with REST API](../11-integrations/00-api/00-rest.md)
* [How to Connect Databend with MySQL-Compatible Clients](../11-integrations/30-access-tool/00-mysql.md)
* [How to Connect Databend with bendsql](../11-integrations/30-access-tool/01-bendsql.md)
* [How to Execute Queries in Python](../03-develop/01-python.md)
* [How to Query Databend in Jupyter Notebooks](../11-integrations/20-gui-tool/00-jupyter.md)
* [How to Execute Queries in Golang](../03-develop/00-golang.md)
* [How to Execute Queries in Node.js](../03-develop/02-nodejs.md)
</TabItem>

## Loading Data into Databend
<TabItem value="Manage" label="Manage">

* [How to Load Data from Databend Stages](../12-load-data/00-stage.md)
* [How to Load Data from Amazon S3](../12-load-data/01-s3.md)
* [How to Load Data from Local File System](../12-load-data/02-local.md)
* [How to Load Data from Remote Files](../12-load-data/04-http.md)
* [Managing Databend Settings](../10-deploy/06-manage-settings.md)
* [Backing Up and Restoring a Meta Service Cluster](../10-deploy/06-metasrv/30-metasrv-backup-restore.md)
* [Backing Up and Restoring Schema Data](../10-deploy/09-upgrade/10-backup-and-restore-schema.md)
* [Upgrading Databend](../10-deploy/09-upgrade/50-upgrade.md)

</TabItem>
</Tabs>

## Data Load & Unload

Databend makes it easy to load data from various sources, stage, Amazon S3, local and remote files, and so on.

* [Loading Data from Databend Stages](../12-load-data/00-stage.md)
* [Loading Data from Amazon S3](../12-load-data/01-s3.md)
* [Loading Data from Local File System](../12-load-data/02-local.md)
* [Loading Data from Remote Files](../12-load-data/04-http.md)
* [Querying Data in Staged Files](../12-load-data/05-querying-stage.md)
* [Transforming Data During a Load](../12-load-data/06-data-load-transform.md)
* [Unloading Data from Databend](../12-unload-data/index.md)

## Unloading Data from Databend

* [How to Unload Data from Databend](../12-unload-data/index.md)
## Data & User Management

### Managing Data
To make the most of Databend, learn how to manage your database by inserting, updating, and deleting data, creating and dropping databases and tables, and managing user-defined functions and views. Explore advanced features like generating SQL with AI and managing users, roles, and privileges for fine-grained control.

* [COPY](../14-sql-commands/10-dml/dml-copy-into-table.md)
* [INSERT](../14-sql-commands/10-dml/dml-insert.md)
* [DELETE](../14-sql-commands/10-dml/dml-delete-from.md)
* [UPDATE](../14-sql-commands/10-dml/dml-update.md)
* [REPLACE](../14-sql-commands/10-dml/dml-replace.md)
<Tabs>
<TabItem value="Data" label="Data" default>

## Managing Users
* [How to Insert Data into a Table](../14-sql-commands/10-dml/dml-insert.md)
* [How to Update Data in a Table](../14-sql-commands/10-dml/dml-update.md)
* [How to Replace a Row in a Table](../14-sql-commands/10-dml/dml-replace.md)
* [How to Delete One or More Rows from a Table](../14-sql-commands/10-dml/dml-delete-from.md)

* [How to Create a User](../14-sql-commands/00-ddl/30-user/01-user-create-user.md)
* [How to Grant Privileges to a User](../14-sql-commands/00-ddl/30-user/10-grant-privileges.md)
* [How to Revoke Privileges from a User](../14-sql-commands/00-ddl/30-user/11-revoke-privileges.md)
* [How to Create a Role](../14-sql-commands/00-ddl/30-user/04-user-create-role.md)
* [How to Grant Privileges to a Role](../14-sql-commands/00-ddl/30-user/10-grant-privileges.md)
* [How to Grant Role to a User](../14-sql-commands/00-ddl/30-user/20-grant-role.md)
* [How to Revoke Role from a User](../14-sql-commands/00-ddl/30-user/21-revoke-role.md)
</TabItem>

## Managing Databases
<TabItem value="Database" label="Database" >

* [How to Create a Database](../14-sql-commands/00-ddl/10-database/ddl-create-database.md)
* [How to Drop a Database](../14-sql-commands/00-ddl/10-database/ddl-drop-database.md)

## Managing Tables
</TabItem>

<TabItem value="Table" label="Table" >

* [How to Create a Table](../14-sql-commands/00-ddl/20-table/10-ddl-create-table.md)
* [How to Drop a Table](../14-sql-commands/00-ddl/20-table/20-ddl-drop-table.md)
* [How to Rename a Table](../14-sql-commands/00-ddl/20-table/30-ddl-rename-table.md)
* [How to Truncate a Table](../14-sql-commands/00-ddl/20-table/40-ddl-truncate-table.md)
* [How to Add/Drop Table Column](../14-sql-commands/00-ddl/20-table/90-alter-table-column.md)

## Managing Views
</TabItem>

<TabItem value="View" label="View" >

* [How to Create a View](../14-sql-commands/00-ddl/60-view/ddl-create-view.md)
* [How to Drop a View](../14-sql-commands/00-ddl/60-view/ddl-drop-view.md)
* [How to Alter a View](../14-sql-commands/00-ddl/60-view/ddl-alter-view.md)

## Managing User-Defined Functions
</TabItem>

<TabItem value="Function" label="Function" >

* [How to Create a User-Defined Function](../14-sql-commands/00-ddl/50-udf/ddl-create-function.md)
* [How to Drop a User-Defined Function](../14-sql-commands/00-ddl/50-udf/ddl-drop-function.md)
* [How to Alter a User-Defined Function](../14-sql-commands/00-ddl/50-udf/ddl-alter-function.md)


## AI Functions

* [Generating SQL with AI](../15-sql-functions/61-ai-functions/01-ai-to-sql.md)
* [Creating Embedding Vectors](../15-sql-functions/61-ai-functions/02-ai-embedding-vector.md)
* [Text Completion with AI](../15-sql-functions/61-ai-functions/03-ai-text-completion.md)
* [Computing Text Similarities](../15-sql-functions/61-ai-functions/04-ai-cosine-distance.md)

## Backup & Restore
</TabItem>

<TabItem value="User" label="User" >

* [How to Create a User](../14-sql-commands/00-ddl/30-user/01-user-create-user.md)
* [How to Grant Privileges to a User](../14-sql-commands/00-ddl/30-user/10-grant-privileges.md)
* [How to Revoke Privileges from a User](../14-sql-commands/00-ddl/30-user/11-revoke-privileges.md)
* [How to Create a Role](../14-sql-commands/00-ddl/30-user/04-user-create-role.md)
* [How to Grant Privileges to a Role](../14-sql-commands/00-ddl/30-user/10-grant-privileges.md)
* [How to Grant Role to a User](../14-sql-commands/00-ddl/30-user/20-grant-role.md)
* [How to Revoke Role from a User](../14-sql-commands/00-ddl/30-user/21-revoke-role.md)

</TabItem>
</Tabs>

## Integrations

Databend's rich ecosystem offers a range of powerful tools and integrations, allowing you to work more efficiently and effectively.

<Tabs>
<TabItem value="Visualizations" label="Visualizations" default>

* [Jupyter Notebook](../11-integrations/20-gui-tool/00-jupyter.md)
* [Grafana](../11-integrations/20-gui-tool/02-grafana.md)
* [Metabase](../11-integrations/20-gui-tool/03-metabase.md)
* [Redash](../11-integrations/20-gui-tool/04-redash.md)

</TabItem>

<TabItem value="APIs" label="APIs" default>

* [HTTP Handler](../11-integrations/00-api/00-rest.md)
* [MySQL Handler](../11-integrations/00-api/01-mysql-handler.md)
* [ClickHouse Handler](../11-integrations/00-api/02-clickhouse-handler.md)
* [Streaming Load API](../11-integrations/00-api/03-streaming-load.md)
* [File Upload API](../11-integrations/00-api/10-put-to-stage.md)

</TabItem>

<TabItem value="Languages" label="Languages">

* [How to Back Up Meta Data](../10-deploy/06-metasrv/30-metasrv-backup-restore.md)
* [How to Back Up Databases](../10-deploy/09-upgrade/10-backup-and-restore-schema.md)
* [Golang](../03-develop/00-golang.md)
* [Python](../03-develop/01-python.md)
* [Node.js](../03-develop/02-nodejs.md)
* [Java](../03-develop/03-java.md)

## Use Cases
</TabItem>
</Tabs>

* [How to Analyze Nginx Access Logs with Databend](../21-use-cases/02-analyze-nginx-logs-with-databend-and-vector.md)
* [How to Do User Retention Analysis with Databend](../21-use-cases/03-analyze-user-retention-with-databend.md)
* [How to Do Conversion Funnel Analysis with Databend](../21-use-cases/04-analyze-funnel-with-databend.md)
## Next Steps

## Performance
Congratulations on completing the Quick Start materials 👏👏👏!

* [How to Benchmark Databend](../21-use-cases/01-analyze-ontime-with-databend-on-ec2-and-s3.md)
We hope you found them helpful in getting up and running with Databend. To continue your journey with Databend, we encourage you to check out our documentation, which provides in-depth information on Databend's features and capabilities. You can also join our [community](../00-overview/index.md#community) to connect with other Databend users and get help with any questions or issues you may have.