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.

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

Update description for SQL references #2632

Merged
merged 8 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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/sql/commands/sql-comment-on.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: sql-comment-on
title: COMMENT ON
description: Add comments on tables or columns
description: Add comments on tables or columns.
slug: /sql-comment-on
---
<head>
Expand Down
2 changes: 1 addition & 1 deletion docs/sql/commands/sql-create-secret.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: sql-create-secret
title: CREATE SECRET
description: Create a secret to store crediencials.
description: Create a secret to store credentials.
slug: /sql-create-secret
---
<head>
Expand Down
2 changes: 1 addition & 1 deletion docs/sql/commands/sql-create-sink.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: sql-create-sink
title: CREATE SINK
description: Create a sink.
description: Deliver data processed in RisingWave to the sink.
WanYixian marked this conversation as resolved.
Show resolved Hide resolved
slug: /sql-create-sink
---
<head>
Expand Down
2 changes: 1 addition & 1 deletion docs/sql/commands/sql-set-background-ddl.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: sql-set-background-ddl
title: SET BACKGROUND_DDL
description: Run Data Definition Language (DDL) operations in the background.
description: Run Data Definition Language operations in the background.
WanYixian marked this conversation as resolved.
Show resolved Hide resolved
slug: /sql-set-background-ddl
---
<head>
Expand Down
2 changes: 1 addition & 1 deletion docs/sql/commands/sql-set-time-zone.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: sql-set-time-zone
title: SET TIME ZONE
description: Set time zone.
description: Specify time zone as needed.
WanYixian marked this conversation as resolved.
Show resolved Hide resolved
slug: /sql-set-time-zone
---
<head>
Expand Down
2 changes: 1 addition & 1 deletion docs/sql/commands/sql-start-transaction.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: sql-start-transaction
title: START TRANSACTION
description: Start a transaction.
description: Start a read-only transaction.
slug: /sql-start-transaction
---
<head>
Expand Down
1 change: 1 addition & 0 deletions docs/sql/query-syntax/query-syntax-from-clause.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-from-clause
slug: /query-syntax-from-clause
title: FROM clause
description: Specify the data source for a query.
---
<head>
<link rel="canonical" href="https://docs.risingwave.com/docs/current/query-syntax-from-clause/" />
Expand Down
1 change: 1 addition & 0 deletions docs/sql/query-syntax/query-syntax-generated-columns.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-generated-columns
slug: /query-syntax-generated-columns
title: Generated columns
description: Generated from other columns in a table or source.
WanYixian marked this conversation as resolved.
Show resolved Hide resolved
---
<head>
<link rel="canonical" href="https://docs.risingwave.com/docs/current/query-syntax-generated-columns/" />
Expand Down
1 change: 1 addition & 0 deletions docs/sql/query-syntax/query-syntax-group-by-clause.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-group-by-clause
slug: /query-syntax-group-by-clause
title: GROUP BY clause
description: Group rows with similar values.
---
<head>
<link rel="canonical" href="https://docs.risingwave.com/docs/current/query-syntax-group-by-clause/" />
Expand Down
1 change: 1 addition & 0 deletions docs/sql/query-syntax/query-syntax-having-clause.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-having-clause
slug: /query-syntax-having-clause
title: HAVING clause
description: Filter results based on specified conditions.
---
<head>
<link rel="canonical" href="https://docs.risingwave.com/docs/current/query-syntax-having-clause/" />
Expand Down
2 changes: 2 additions & 0 deletions docs/sql/query-syntax/query-syntax-join-clause.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
id: query-syntax-join-clause
slug: /query-syntax-join-clause
title: Joins
Description: Combine the results of tables by matching column values.

---
<head>
<link rel="canonical" href="https://docs.risingwave.com/docs/current/query-syntax-join-clause/" />
Expand Down
1 change: 1 addition & 0 deletions docs/sql/query-syntax/query-syntax-limit-clause.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-limit-clause
slug: /query-syntax-limit-clause
title: LIMIT clause
description: Restrict the number of rows fetched.
---
<head>
<link rel="canonical" href="https://docs.risingwave.com/docs/current/query-syntax-limit-clause/" />
Expand Down
1 change: 1 addition & 0 deletions docs/sql/query-syntax/query-syntax-literals.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-literals
slug: /query-syntax-literals
title: Literals
description: Enhance data representation accuracy.
---
<head>
<link rel="canonical" href="https://docs.risingwave.com/docs/current/query-syntax-literals/" />
Expand Down
2 changes: 1 addition & 1 deletion docs/sql/query-syntax/query-syntax-order-by-clause.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: query-syntax-order-by-clause
title: ORDER BY clause
description: Use the ORDER BY clause to sort the result set of a query.
description: Sort the result set of a query.
slug: /query-syntax-order-by-clause
---
<head>
Expand Down
1 change: 1 addition & 0 deletions docs/sql/query-syntax/query-syntax-set-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-set-operations
slug: /query-syntax-set-operations
title: Set operations
description: Combine query results.
---
<head>
<link rel="canonical" href="https://docs.risingwave.com/docs/current/query-syntax-set-operations/" />
Expand Down
1 change: 1 addition & 0 deletions docs/sql/query-syntax/query-syntax-value-exp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-value-exp
slug: /query-syntax-value-exp
title: Value expressions
description: Represent fixed values in SQL commands.
---
<head>
<link rel="canonical" href="https://docs.risingwave.com/docs/current/query-syntax-value-exp/" />
Expand Down
1 change: 1 addition & 0 deletions docs/sql/query-syntax/query-syntax-values-clause.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-values-clause

title: VALUES clause
description: Generate one or more rows of data as a table expression.
---

In RisingWave, the `VALUES` clause is used to generate one or more rows of data as a table expression. It is commonly used in SQL queries to create temporary tables or to insert data into a table.
Expand Down
1 change: 1 addition & 0 deletions docs/sql/query-syntax/query-syntax-where-clause.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-where-clause
slug: /query-syntax-where-clause
title: WHERE clause
description: Specify any conditions or filters.
---
<head>
<link rel="canonical" href="https://docs.risingwave.com/docs/current/query-syntax-where-clause/" />
Expand Down
1 change: 1 addition & 0 deletions docs/sql/query-syntax/query-syntax-with-clause.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-with-clause
slug: /query-syntax-with-clause
title: WITH clause
description: Add supplemental statements for a query.
---
<head>
<link rel="canonical" href="https://docs.risingwave.com/docs/current/query-syntax-with-clause/" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: query-syntax-with-ordinality-clause
slug: /query-syntax-with-ordinality-clause
title: WITH ORDINALITY clause
description: Add an additional integer column to the table.
---

The `WITH ORDINALITY` clause can be used with set functions in the `FROM` clause of a query. An additional integer column will be added to the table, which numbers the rows returned by the function, starting from 1. By default, the generated column is named `ordinality`.
Expand Down
65 changes: 2 additions & 63 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -681,69 +681,8 @@ const sidebars: SidebarsConfig = {
},
items: [
{
type: "doc",
id: "sql/query-syntax/query-syntax-literals",
label: "Literals",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-value-exp",
label: "Value expressions",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-generated-columns",
label: "Generated columns",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-from-clause",
label: "FROM clause",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-where-clause",
label: "WHERE clause",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-group-by-clause",
label: "GROUP BY clause",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-having-clause",
label: "HAVING clause",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-order-by-clause",
label: "ORDER BY clause",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-limit-clause",
label: "LIMIT clause",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-values-clause",
label: "VALUES clause",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-set-operations",
label: "Set operations",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-with-clause",
label: "WITH clause",
},
{
type: "doc",
id: "sql/query-syntax/query-syntax-with-ordinality-clause",
label: "WITH ORDINALITY clause",
type: "autogenerated",
dirName: "sql/query-syntax",
},
],
},
Expand Down
Loading