Skip to content

Commit

Permalink
save work
Browse files Browse the repository at this point in the history
  • Loading branch information
WanYixian committed Nov 26, 2024
1 parent 21fb5e9 commit b502494
Show file tree
Hide file tree
Showing 48 changed files with 120 additions and 131 deletions.
20 changes: 10 additions & 10 deletions cloud/develop-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Developers can refer to the user documentation for RisingWave to develop streami
title="RisingWave user docs"
icon="arrow-right"
iconType="solid"
href="/docs/current/intro/"
href="/cloud/intro"
horizontal
/>
<Card
Expand All @@ -27,7 +27,7 @@ Developers can refer to the user documentation for RisingWave to develop streami

## How to use the docs

RisingWave is a rapidly evolving system, with [new features](/release-notes/) added with each release. However, this also means some features may not function properly in older versions. Therefore, when using the RisingWave user docs, it's important to select the corresponding documentation version based on the RisingWave version in your project.
RisingWave is a rapidly evolving system, with [new features](/changelog/release-notes) added with each release. However, this also means some features may not function properly in older versions. Therefore, when using the RisingWave user docs, it's important to select the corresponding documentation version based on the RisingWave version in your project.

### Check RisingWave version

Expand All @@ -49,7 +49,7 @@ Select the version of the corresponding docs when using the RisingWave user docs

<CardGroup cols={3}>
<Card title="Integrations" icon="puzzle-piece" href="/integrations/overview" iconType="solid"> See how RisingWave can integrate with your existing data stack. Vote for your favorite data tools and streaming services to help us prioritize the integration development. </Card>
<Card title="Sources" icon="database"href="/docs/current/data-ingestion/" iconType="solid"> Connect to and ingest data from external sources such as databases and message brokers. See supported data sources. </Card>
<Card title="Sources" icon="database"href="/ingestion/overview" iconType="solid"> Connect to and ingest data from external sources such as databases and message brokers. See supported data sources. </Card>
<Card title="Sinks" icon="arrow-right-from-bracket"href="/delivery/overview" iconType="solid"> Stream processed data out of RisingWave to message brokers and databases. See supported data destinations. </Card>
</CardGroup>

Expand All @@ -63,20 +63,20 @@ Select the version of the corresponding docs when using the RisingWave user docs
SQL syntax and functionality supported by RisingWave. While RisingWave is wire-compatible with PostgreSQL, it has some unique features and notable differences.

<p>
<a href="/docs/current/sql-references/" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Overview</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
<a href="/sql/overview" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Overview</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
</p>

<p>
<a href="/docs/current/sql-references/" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Commands</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
<a href="/sql/overview" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Commands</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
</p>
<p>
<a href="/docs/current/sql-commands/" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Query syntax</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
<a href="/sql/commands/overview" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Query syntax</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
</p>
<p>
<a href="/docs/current/query-syntax/" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Data types</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
<a href="/sql/query-syntax/overview" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Data types</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
</p>
<p>
<a href="/docs/current/sql-functions/" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Functions and operators</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
<a href="/sql/functions/overview" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Functions and operators</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
</p>

</Card>
Expand Down Expand Up @@ -122,10 +122,10 @@ Continue to learn about RisingWave.
<a href="/reference/architecture" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Architecture</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
</p>
<p>
<a href="/docs/current/risingwave-flink-comparison/" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>RisingWave vs. Apache Flink</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
<a href="/faq/risingwave-flink-comparison" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>RisingWave vs. Apache Flink</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
</p>
<p>
<a href="/release-notes/" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Release notes</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
<a href="/changelog/release-notes" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Release notes</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
</p>

</Card>
Expand Down
11 changes: 2 additions & 9 deletions cloud/monitor-materialized-views.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,11 @@ mode: wide
---

1. Go to the [project details page](/cloud/check-status-and-metrics/#check-project-details).

2. Select the **Workspace** \> **Materialized Views** tab.
<Frame>
<img src="/images/cloud/monitor-materialized-views/cluster-details-mv.png"/>
</Frame>

3. Click on a materialized view to see the details.
You can view the direct acyclic graph of streaming executors for maintaining the materialized view.
<Frame>
<img src="/images/cloud/monitor-materialized-views/mv-graph-84eb70c2007f85ef2ce5489a7de35e5a.png"/>
</Frame>

4. You can click **< > SQL** to see the query defined in the materialized view (i.e. the `AS` clause).
<Frame>
<img src="/images/cloud/monitor-materialized-views/mv-graph-sql.png"/>
</Frame>

2 changes: 1 addition & 1 deletion cloud/update-database-version.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Update RisingWave version"
description: "When a newer version of RisingWave is available, you can update the database version of your project to the latest. See the [Release Notes of RisingWave](/release-notes/) for feature updates of each version."
description: "When a newer version of RisingWave is available, you can update the database version of your project to the latest. See the [Release Notes of RisingWave](/changelog/release-notes) for feature updates of each version."
---

## Prerequisite
Expand Down
2 changes: 1 addition & 1 deletion integrations/sources/hivemq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ For detailed setup, refer to the [HiveMQ Quick Start Guide](https://docs.hivemq.

## Set Up a RisingWave cluster

To ingest data into RisingWave, you'll need to create a RisingWave cluster. Sign up for a free plan at [RisingWave Cloud](https://cloud.risingwave.com/) to explore its features. You can refer to the [RisingWave Documentation](https://docs.risingwave.com/docs/current/intro/) for comprehensive, step-by-step instructions. For further assistance or to join the community, connect with us on [Slack](https://www.risingwave.com/slack).
To ingest data into RisingWave, you'll need to create a RisingWave cluster. Sign up for a free plan at [RisingWave Cloud](https://cloud.risingwave.com/) to explore its features. You can refer to the [RisingWave Documentation](/cloud/intro) for comprehensive, step-by-step instructions. For further assistance or to join the community, connect with us on [Slack](https://www.risingwave.com/slack).

![RisingWave Cloud Sign-Up](/images/risingwave_cloud_sign_up.png)

Expand Down
4 changes: 2 additions & 2 deletions python-sdk/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This SDK provides a simple way to perform ad-hoc queries, subscribe to changes,
[risingwave-py](https://pypi.org/project/risingwave-py/) is a RisingWave Python SDK that provides the following capabilities:
- Interact with RisingWave via Pandas DataFrame.
- Subscribe and process changes from RisingWave tables or materialized views.
- Run [SQL commands](../sql/overview) supported in RisingWave.
- Run [SQL commands](/sql/commands/overview) supported in RisingWave.

### Run RisingWave

Expand Down Expand Up @@ -96,7 +96,7 @@ rw.execute("""
)""")
```

For supported sources and the SQL syntax, see [this topic](https://docs.risingwave.com/docs/current/data-ingestion/).
For supported sources and the SQL syntax, see [this topic](https://docs.risingwave.com/ingestion/overview).


### Query from RisingWave
Expand Down
2 changes: 1 addition & 1 deletion sql/commands/sql-alter-materialized-view.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "The `ALTER MATERIALIZED VIEW` command modifies the metadata of a m
<Note>
INFO

To modify the SQL definition of a materialized view, please refer to [Alter a streaming job](/docs/current/alter-streaming/).
To modify the SQL definition of a materialized view, please refer to [Alter a streaming job](/operate/alter-streaming).
</Note>

## Syntax
Expand Down
2 changes: 1 addition & 1 deletion sql/commands/sql-alter-sink.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: The `ALTER SINK` command modifies the metadata of a sink.
<Note>
INFO

To modify the SQL definition of a sink, please refer to [Alter a streaming job](/docs/current/alter-streaming/).
To modify the SQL definition of a sink, please refer to [Alter a streaming job](/operate/alter-streaming).
</Note>

## Syntax
Expand Down
4 changes: 2 additions & 2 deletions sql/commands/sql-create-aggregate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def finish(state):
$$;
```

For more details, see [Use UDFs in Python](/docs/current/udf-python-embedded/).
For more details, see [Use UDFs in Python](/sql/udfs/embedded-python-udfs).

### JavaScript

Expand Down Expand Up @@ -108,7 +108,7 @@ create aggregate weighted_avg(value int, weight int) returns float language java
$$;
```

For more details, see [Use UDFs in JavaScript](/docs/current/udf-javascript/).
For more details, see [Use UDFs in JavaScript](/sql/udfs/use-udfs-in-javascript).

### Using UDAFs

Expand Down
12 changes: 6 additions & 6 deletions sql/commands/sql-create-function.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ CREATE FUNCTION function_name ( argument_type [, ...] )

### Examples

Use `CREATE FUNCTION` to declare a UDF defined by Python. For more details, see [Use UDFs in Python](/docs/current/udf-python/).
Use `CREATE FUNCTION` to declare a UDF defined by Python. For more details, see [Use UDFs in Python](/sql/udfs/use-udfs-in-python).

```sql
CREATE FUNCTION gcd(int, int) RETURNS int
LANGUAGE python AS gcd USING LINK 'http://localhost:8815'; -- If you are running RisingWave using Docker, replace the address with 'http://host.docker.internal:8815'.
```

Use `CREATE FUNCTION` to declare a UDF defined by Java. For more details, see [Use UDFs in Java](/docs/current/udf-java/).
Use `CREATE FUNCTION` to declare a UDF defined by Java. For more details, see [Use UDFs in Java](/sql/udfs/use-udfs-in-java).

```sql
CREATE FUNCTION gcd(int, int) RETURNS int
Expand All @@ -66,7 +66,7 @@ def gcd(a, b):
$$;
```

For more details, see [Embedded Python UDFs](/docs/current/udf-python-embedded/).
For more details, see [Embedded Python UDFs](/sql/udfs/embedded-python-udfs).

```sql Embedded UDFs
# Embedded JavaScript UDF
Expand All @@ -80,7 +80,7 @@ create function gcd(a int, b int) returns int language javascript as $$
$$;
```

For more details, see [Use UDFs in JavaScript](/docs/current/udf-javascript/).
For more details, see [Use UDFs in JavaScript](/sql/udfs/use-udfs-in-javascript).

```sql Embedded UDFs
# Embedded Rust UDF
Expand All @@ -96,13 +96,13 @@ create function gcd(int, int) returns int language rust as $$
$$;
```

For more details, see [Use UDFs in Rust](/docs/current/udf-rust/).
For more details, see [Use UDFs in Rust](/sql/udfs/use-udfs-in-rust).

## SQL UDFs

SQL UDFs in RisingWave are designed to expand directly into expressions at the frontend, resulting in minimal performance difference compared to manually calling multiple functions.

The `CREATE FUNCTION` command is used to define SQL UDFs. You can read our guide on [SQL UDFs](/docs/current/ql-udfs/) for more details.
The `CREATE FUNCTION` command is used to define SQL UDFs. You can read our guide on [SQL UDFs](/sql/udfs/sql-udfs) for more details.

```sql Syntax of SQL UDFs
CREATE FUNCTION function_name ( argument_type [, ...] )
Expand Down
4 changes: 0 additions & 4 deletions sql/commands/sql-create-mv.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@ Names and unquoted identifiers are case-insensitive. Therefore, you must double-
The `ORDER BY` clause in the `CREATE MATERIALIZED VIEW` statement is allowed but not considered as part of the definition of the materialized view. It's only used in the initial creation of the materialized view and not during refreshes.
</Note>

## Examples

Refer to this [tutorial](/docs/current/server-performance-anomaly-detection/) for examples of creating materialized views based on external sources or existing materialized views.

## See also

<CardGroup>
Expand Down
4 changes: 2 additions & 2 deletions sql/commands/sql-create-source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "A source is a resource that RisingWave can read data from. You can

For the full list of the sources we support, see [Supported sources](/ingestion/supported-sources-and-formats#supported-sources).

If you choose to persist the data from the source in RisingWave, use the [CREATE TABLE](/sql/commands/sql-create-table) command with connector settings. Or if you need to create the primary key (which is required by some formats like FORMAT UPSERT/DEBEZIUM), you have to use `CREATE TABLE` too. For more details about the differences between sources and tables, see [here](/docs/current/data-ingestion/#table-with-connectors).
If you choose to persist the data from the source in RisingWave, use the [CREATE TABLE](/sql/commands/sql-create-table) command with connector settings. Or if you need to create the primary key (which is required by some formats like FORMAT UPSERT/DEBEZIUM), you have to use `CREATE TABLE` too. For more details about the differences between sources and tables, see [here](/ingestion/overview#table-with-connectors).

Regardless of whether the data is persisted in RisingWave, you can create materialized views to perform analysis or data transformations.

Expand Down Expand Up @@ -175,7 +175,7 @@ Shared sources do not support `ALTER SOURCE`. Use non-shared sources if you requ
title="Overview of data ingestion"
icon="database"
iconType="solid"
href="/docs/current/data-ingestion/"
href="/ingestion/overview"
/>
<Card
title="DROP SOURCE"
Expand Down
4 changes: 2 additions & 2 deletions sql/commands/sql-create-table.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Rows can be added using the [INSERT](/sql/commands/sql-insert) command. When cre
<Note>


If you choose not to persist the data from the source in RisingWave, use [CREATE SOURCE](/sql/commands/sql-create-source) instead. For more details about the differences between sources and tables, see [here](/docs/current/data-ingestion/#table-with-connectors).
If you choose not to persist the data from the source in RisingWave, use [CREATE SOURCE](/sql/commands/sql-create-source) instead. For more details about the differences between sources and tables, see [here](/ingestion/overview#table-with-connectors).
</Note>

## Syntax
Expand Down Expand Up @@ -77,7 +77,7 @@ CREATE TABLE [ IF NOT EXISTS ] table_name (
| APPEND ONLY | When this option is specified, the table will be created as an append-only table. An append-only table cannot have primary keys. UPDATE and DELETE statements are not valid for append-only tables. Note that append-only tables is in the [public preview stage](/changelog/product-lifecycle#features-in-the-public-preview-stage). |
| ON CONFLICT | Specify the alternative action when the newly inserted record brings a violation of PRIMARY KEY constraint on the table. See [PK conflict behavior](#pk-conflict-behavior) below for more information. |
| **INCLUDE** clause | Extract fields not included in the payload as separate columns. For more details on its usage, see [INCLUDE clause](/ingestion/ingest-additional-fields-with-include-clause). |
| **WITH** clause | Specify the connector settings here if trying to store all the source data. See the [Data ingestion](/docs/current/data-ingestion/) page for the full list of supported source as well as links to specific connector pages detailing the syntax for each source. |
| **WITH** clause | Specify the connector settings here if trying to store all the source data. See the [Data ingestion](/ingestion/overview) page for the full list of supported source as well as links to specific connector pages detailing the syntax for each source. |
| **FORMAT** and **ENCODE** options | Specify the data format and the encoding format of the source data. To learn about the supported data formats, see [Data formats](/ingestion/supported-sources-and-formats#supported-formats). |

<Note>
Expand Down
Loading

0 comments on commit b502494

Please sign in to comment.