Skip to content

Commit b172e61

Browse files
soyeric128soyeric128
authored
updates (#1139)
1 parent 4cda382 commit b172e61

File tree

16 files changed

+93
-109
lines changed

16 files changed

+93
-109
lines changed

‎docs/en/guides/20-cloud/00-new-account.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
---
2-
title: Activate Databend Cloud
2+
title: Getting Started
33
---
44

55
import StepsWrap from '@site/src/components/StepsWrap';
66
import StepContent from '@site/src/components/Steps/step-content';
77

8-
In order to create an account on Databend Cloud, your organization must first have beta access to the platform. This topic outlines the steps for applying for beta access as an organization, as well as signing up and logging in to your Databend Cloud account.
8+
This topic outlines the steps for applying for beta access as an organization, as well as signing up and logging in to your Databend Cloud account.
9+
10+
:::tip
11+
Databend Cloud is fully compatible with various mainstream browsers, including Chrome, Microsoft Edge, Firefox, Opera, and Safari, providing users with great convenience and flexibility in usage.
12+
13+
- Databend Cloud recommends upgrading your browser to the latest version.
14+
15+
- If you encounter any issues related to your browser while using Databend Cloud, please create a ticket to contact Databend Cloud for effective assistance.
16+
17+
- Databend Cloud does not support Internet Explorer.
18+
:::
919

1020
## Apply for Beta Access
1121

‎docs/en/guides/20-cloud/20-manage/00-organization.md renamed to ‎docs/en/guides/20-cloud/10-using-databend-cloud/00-organization.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,34 @@
11
---
2-
title: Organization
2+
title: Organization & Members
33
---
44

5-
## What is Organization?
5+
This topic explains the concept of an organization and its members in Databend Cloud.
6+
7+
## Understanding Organization
68

79
Organization is an essential concept in Databend Cloud. All the users, databases, warehouses, and other objects in Databend Cloud are associated with an organization. An organization is a group for managing users and their resources.
810

911
In an organization of Databend Cloud, data and resources are shared among all users of the organization. Users can collaborate with each other to manage and analyze the organization's data effectively by taking advantage of the cloud-native features.
1012

1113
Please note that each organization in Databend Cloud has its own pricing plan and billing settings. Data is not shared across organizations, and organizations cannot be combined either if your company owns multiple organizations in Databend Cloud.
1214

13-
## Creating an Organization
15+
### Creating an Organization
1416

15-
When you provide an organization name during the signup process, you create an organization in Databend Cloud with your account as an Admin account. You will also need to select a pricing plan, a cloud provider, and a region for the new organization. For more information, see [Activate Databend Cloud](../00-new-account.md)).
17+
When you provide an organization name during the signup process, you create an organization in Databend Cloud with your account as an Admin account. You will also need to select a pricing plan, a cloud provider, and a region for the new organization. For more information, see [Activate Databend Cloud](../00-new-account.md).
1618

1719
![](@site/static/img/documents/getting-started/01.jpg)
1820

1921
:::tip
2022
If you're invited by a user who already belongs to an organization in Databend Cloud, the textbox will show that organization's name. In this case, you cannot create another organization.
2123
:::
2224

23-
## Switching to Another Organization
25+
### Switching to Another Organization
2426

2527
If you're a Databend Cloud user who has accepted invitations from multiple organizations, you can switch between these organizations by clicking on the organization name in the top left corner of the page and selecting the organization you want to switch to.
2628

2729
![Alt text](@site/static/img/documents/overview/switch-org.gif)
2830

29-
## Managing Organization Settings
31+
### Managing Organization Settings
3032

3133
You must be assigned the Admin role to manage the organization settings. The Organization Settings page is visible only to the organization's admin users. To go to the Organization Settings page, click the Settings icon in the left sidebar, then click **Organization**.
3234

@@ -35,3 +37,28 @@ The Organization Settings page shows the current settings of the organization. Y
3537
- Organization's display name
3638

3739
- Organization's display slug: When an organization is created, Databend Cloud generates and uses a short random string as the organization slug. The best practice is to change it to your company's name to identify the addresses of your company's resources in Databend Cloud. For example, if you set it to `tpl`, your database URLs will be `https://app.databend.com/tpl/data/databases/<database_name>`.
40+
41+
## Understanding Members
42+
43+
To view all the members in your organization, go to **Manage** > **Members**. This page provides a list of all members, including their email addresses, roles, join times, and last active times. If you're an `account_admin`, you can also change a member's role or remove a member from your organization.
44+
45+
- The roles listed show the roles assigned to users when they were invited. While these roles can be changed on the page, they cannot be revoked using SQL. However, you can grant additional roles or privileges to users based on their email addresses. These user accounts, identified by their email addresses, can also function as SQL users in Databend Cloud. Example:
46+
47+
```sql
48+
GRANT ROLE writer to '[email protected]';
49+
GRANT SELECT ON *.* TO '[email protected]';
50+
```
51+
52+
- The page does not display users created using SQL. To view the SQL users that have been created, use the [SHOW USERS](/sql/sql-commands/ddl/user/user-show-users) command.
53+
54+
### Inviting New Members
55+
56+
To invite a new member to your organization, navigate to the **Manage** > **Members** page and click on **Invite New Member**. In the dialog box that appears, enter the user's email address and select a role from the list. This list includes built-in roles and any created roles created for your organization. For more information about the roles, see [Roles](/guides/security/access-control/roles).
57+
58+
An invitation email will be sent to the invited user. Inside the email, there will be a link that the user can click on to initiate the signup process.
59+
60+
:::note
61+
- Inviting new members to the organization is a privilege restricted to account_admin roles only.
62+
63+
- If your organization is under the Trial Plan, it permits a maximum of one user. In such a case, you won't have the capability to extend invitations to additional members.
64+
:::

‎docs/en/guides/20-cloud/10-using-databend-cloud/00-warehouses.md renamed to ‎docs/en/guides/20-cloud/10-using-databend-cloud/01-warehouses.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
---
2-
title: Work with Warehouses
2+
title: Warehouses
33
---
44

5-
## What is Warehouse?
6-
75
The warehouse is an essential component of Databend Cloud. A warehouse represents a set of computing capacities including CPU, memory, and local caches. You must run a warehouse to perform the following SQL tasks in Databend Cloud:
86

97
- Query data with the SELECT statement

‎docs/en/guides/20-cloud/10-using-databend-cloud/01-worksheet.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Work with Worksheets
2+
title: Worksheets
33
---
44
import DbSVG from '@site/static/img/icon/database.svg'
55
import RoleSVG from '@site/static/img/icon/role.svg'
@@ -30,8 +30,6 @@ The query result shows in the output area. You can click **Export** to save the
3030
:::tip
3131
- To make it easier for you to edit SQL statements, you can select a table in the database list and click the "..." button next to it. Then, follow the menu prompts to choose to copy the table name or all column names to the SQL input area on the right in one click.
3232

33-
- AI assistance is available for editing SQL statements within the Databend Cloud editor. Simply type "/" at the beginning of a new line and input your query, like "Query the current time". The editor will display an AI-generated SQL statement. For additional guidance on the statement, highlight it, and click **Edit** to explain your desired changes or request further assistance. Alternatively, click **Chat** to engage in a conversation with AI for more comprehensive support.
34-
3533
- If you enter multiple statements in the SQL input area, Databend Cloud will only execute the statement where the cursor is located. You can move the cursor to execute other statements. Additionally, you can use keyboard shortcuts: Ctrl + Enter (Windows) or Command + Enter (Mac) to execute the current statement, and Ctrl + Shift + Enter (Windows) or Command + Shift + Enter (Mac) to execute all statements.
3634
:::
3735

‎docs/en/guides/20-cloud/10-using-databend-cloud/02-dashboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Work with Dashboards
2+
title: Dashboards
33
---
44
import StepsWrap from '@site/src/components/StepsWrap';
55
import StepContent from '@site/src/components/Steps/step-content';

‎docs/en/guides/20-cloud/10-using-databend-cloud/04-search.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎docs/en/guides/20-cloud/10-using-databend-cloud/_category_.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"label": "Work with Databend Cloud"
3-
}
2+
"label": "Fundamentals"
3+
}

‎docs/en/guides/20-cloud/20-manage/02-usage-and-billing.md renamed to ‎docs/en/guides/20-cloud/20-manage/00-costs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Usage
2+
title: Managing Costs
33
---
44

5-
This topic describes how to view and control your usage within Databend Cloud.
5+
This topic describes how to view and limit your costs within Databend Cloud.
66

7-
## Viewing Your Usage
7+
## Viewing Your Costs
88

99
If you are an admin user, you can access your organization's usage statistics by clicking **Manage** > **Usage**.
1010

@@ -20,7 +20,7 @@ Clicking on **View more** will provide more detailed statistical data:
2020
- On the left, filters can be applied based on time range, category, and records.
2121
- On the right, consumption data, trends, and details will be displayed.
2222

23-
## Controlling Your Usage
23+
## Limiting Your Costs
2424

2525
For admin users, Databend Cloud offers the option to set a spending limit for their organization. This allows administrators to control the maximum amount of money spent on the platform. To do this, go to the homepage and click on **Activate Spending Limit**. On the next page, you can turn on the **Enable Spending Limit** button and specify the maximum monthly spending allowed for your organization.
2626

‎docs/en/guides/20-cloud/20-manage/01-members.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

‎docs/en/guides/20-cloud/10-using-databend-cloud/03-monitor.md renamed to ‎docs/en/guides/20-cloud/20-manage/01-monitor.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11
---
2-
title: "Monitor Databend Cloud"
2+
title: "Monitoring Usage"
33
---
44

55
Databend Cloud provides monitoring functionality to help you gain a comprehensive understanding of your and your organization members' usage on the platform. To access the **Monitor** page, click **Monitor** in the sidebar menu on the homepage. The page includes the following tabs:
66

77
- [Metrics](#metrics)
88
- [SQL History](#sql-history)
9-
- [Audit](#audit)
10-
11-
:::note
12-
The **SQL History** and **Audit** tabs are visible only to admin members.
13-
:::
9+
- [Task History](#task-history)
10+
- [Audit](#audit): Visible to `account_admin` users only.
1411

1512
## Metrics
1613

17-
The **Metrics** page presents charts that visually illustrate usage statistics for the following metrics, covering data from the past hour, day, or week:
14+
The **Metrics** tab presents charts that visually illustrate usage statistics for the following metrics, covering data from the past hour, day, or week:
1815

1916
- Storage Size
2017
- SQL Query Count
@@ -25,13 +22,17 @@ The **Metrics** page presents charts that visually illustrate usage statistics f
2522

2623
## SQL History
2724

28-
The **SQL History** page displays a list of SQL statements that have been executed by all users within your organization. By clicking **Filter** at the top of the list, you can filter records by multiple dimensions.
25+
The **SQL History** tab displays a list of SQL statements that have been executed by all users within your organization. By clicking **Filter** at the top of the list, you can filter records by multiple dimensions.
2926

3027
Clicking a record on the **SQL History** page reveals detailed information on how Databend Cloud executed the SQL statement, providing access to the following tabs:
3128

3229
- **Query Details**: Includes Query State (success or failure), Rows Scanned, Warehouse, Bytes Scanned, Start Time, End Time, and Handler Type.
3330
- **Query Profile**: Illustrates how the SQL statement was executed. For more information, see [Query Profile](/guides/query/query-profile).
3431

32+
## Task History
33+
34+
The **Task History** tab offers a comprehensive log of all executed tasks within your organization, enabling users to review task settings and monitor their status.
35+
3536
## Audit
3637

37-
The **Audit** page records the operation logs of all organization members, including the operation type, operation time, IP address, and the account of the operator. By clicking **Filter** at the top of the list, you can filter records by multiple dimensions.
38+
The **Audit** tab records the operation logs of all organization members, including the operation type, operation time, IP address, and the account of the operator. By clicking **Filter** at the top of the list, you can filter records by multiple dimensions.

‎docs/en/guides/20-cloud/20-manage/02-ai-features.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: AI-Powered Features
3+
---
4+
5+
With the inclusion of AI-powered features, Databend Cloud allows you to engage in natural language conversations to receive help, assistance, and solutions. These AI-powered features are enabled by default, but you can disable them if desired by navigating to **Manage** > **Settings**.
6+
7+
### AI Chat for Assistance
8+
9+
AI Chat enables natural language interactions, allowing for intuitive information retrieval and streamlined problem-solving.
10+
11+
To launch an AI-Chat:
12+
13+
1. Click the magnifying glass icon located in the sidebar to open the search box.
14+
15+
2. Click on **Chat** to navigate to the Chat tab.
16+
17+
3. Enter your question.
18+
19+
![Alt text](@site/static/img/documents/worksheet/ai-chat.gif)
20+
21+
### AI-Powered SQL Assistant
22+
23+
AI assistance is available for editing SQL statements within the Databend Cloud editor. Simply type "/" at the beginning of a new line and input your query, like "Query the current time". The editor will display an AI-generated SQL statement. For additional guidance on the statement, highlight it, and click **Edit** to explain your desired changes or request further assistance. Alternatively, click **Chat** to engage in a conversation with AI for more comprehensive support.

‎docs/en/guides/20-cloud/20-manage/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"label": "Manage Databend Cloud"
2+
"label": "Managing Databend Cloud"
33
}

‎docs/en/guides/20-cloud/20-manage/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
title: Manage Databend Cloud
2+
title: Managing Databend Cloud
33
---
44

55
import IndexOverviewList from '@site/src/components/IndexOverviewList';
66

7-
<IndexOverviewList />
8-
7+
<IndexOverviewList />

‎docs/en/guides/20-cloud/index.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,5 @@ title: Databend Cloud
44

55
import IndexOverviewList from '@site/src/components/IndexOverviewList';
66

7-
:::tip
8-
Databend Cloud is fully compatible with various mainstream browsers, including Chrome, Microsoft Edge, Firefox, Opera, and Safari, providing users with great convenience and flexibility in usage.
9-
10-
- Databend Cloud recommends upgrading your browser to the latest version.
11-
12-
- If you encounter any issues related to your browser while using Databend Cloud, please create a ticket to contact Databend Cloud for effective assistance.
13-
14-
- Databend Cloud does not support Internet Explorer.
15-
:::
16-
177
<IndexOverviewList />
188

‎docs/en/guides/20-cloud/10-using-databend-cloud/05-privatelink.md renamed to ‎docs/en/guides/30-sql-clients/03-privatelink.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: "Connect to Databend Cloud with AWS PrivateLink"
2+
title: "Connecting to Databend Cloud with AWS PrivateLink"
3+
sidebar_label: "AWS PrivateLink"
34
---
45

56
# Why PrivateLink

‎docs/en/guides/20-cloud/10-using-databend-cloud/06-aws-iam-role.md renamed to ‎docs/en/guides/40-load-data/00-stage/06-aws-iam-role.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Access your own AWS S3 bucket in Databend Cloud with IAM Role"
2+
title: "Creating External Stage with AWS IAM Role"
33
---
44

55
# Why IAM Role

0 commit comments

Comments
 (0)