diff --git a/cloud/develop-overview.mdx b/cloud/develop-overview.mdx index 4b3f52b7..6a101be5 100644 --- a/cloud/develop-overview.mdx +++ b/cloud/develop-overview.mdx @@ -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 /> 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. - Connect to and ingest data from external sources such as databases and message brokers. See supported data sources. + Connect to and ingest data from external sources such as databases and message brokers. See supported data sources. Stream processed data out of RisingWave to message brokers and databases. See supported data destinations. @@ -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.

-Overview +Overview

-Commands +Commands

-Query syntax +Query syntax

-Data types +Data types

-Functions and operators +Functions and operators

@@ -122,10 +122,10 @@ Continue to learn about RisingWave. Architecture

-RisingWave vs. Apache Flink +RisingWave vs. Apache Flink

-Release notes +Release notes

diff --git a/cloud/monitor-materialized-views.mdx b/cloud/monitor-materialized-views.mdx index 23638bb8..c42e1e70 100644 --- a/cloud/monitor-materialized-views.mdx +++ b/cloud/monitor-materialized-views.mdx @@ -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. - - - 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. - - - + 4. You can click **< > SQL** to see the query defined in the materialized view (i.e. the `AS` clause). - - - diff --git a/cloud/update-database-version.mdx b/cloud/update-database-version.mdx index 5199a3b2..e13aa4cf 100644 --- a/cloud/update-database-version.mdx +++ b/cloud/update-database-version.mdx @@ -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 diff --git a/integrations/sources/hivemq.mdx b/integrations/sources/hivemq.mdx index 4a377f06..ace0ba6e 100644 --- a/integrations/sources/hivemq.mdx +++ b/integrations/sources/hivemq.mdx @@ -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) diff --git a/python-sdk/intro.mdx b/python-sdk/intro.mdx index 34fbd798..836c4178 100644 --- a/python-sdk/intro.mdx +++ b/python-sdk/intro.mdx @@ -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 @@ -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 diff --git a/sql/commands/sql-alter-materialized-view.mdx b/sql/commands/sql-alter-materialized-view.mdx index 70a297c6..484490e9 100644 --- a/sql/commands/sql-alter-materialized-view.mdx +++ b/sql/commands/sql-alter-materialized-view.mdx @@ -6,7 +6,7 @@ description: "The `ALTER MATERIALIZED VIEW` command modifies the metadata of a m 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). ## Syntax diff --git a/sql/commands/sql-alter-sink.mdx b/sql/commands/sql-alter-sink.mdx index f128eb82..f042e92a 100644 --- a/sql/commands/sql-alter-sink.mdx +++ b/sql/commands/sql-alter-sink.mdx @@ -6,7 +6,7 @@ description: The `ALTER SINK` command modifies the metadata of a sink. 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). ## Syntax diff --git a/sql/commands/sql-create-aggregate.mdx b/sql/commands/sql-create-aggregate.mdx index 65dd9f5b..ee6847d5 100644 --- a/sql/commands/sql-create-aggregate.mdx +++ b/sql/commands/sql-create-aggregate.mdx @@ -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 @@ -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 diff --git a/sql/commands/sql-create-function.mdx b/sql/commands/sql-create-function.mdx index b3b670ab..2e8fc472 100644 --- a/sql/commands/sql-create-function.mdx +++ b/sql/commands/sql-create-function.mdx @@ -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 @@ -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 @@ -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 @@ -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 [, ...] ) diff --git a/sql/commands/sql-create-mv.mdx b/sql/commands/sql-create-mv.mdx index a2b4b0d4..dfe18dfa 100644 --- a/sql/commands/sql-create-mv.mdx +++ b/sql/commands/sql-create-mv.mdx @@ -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. -## 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 diff --git a/sql/commands/sql-create-source.mdx b/sql/commands/sql-create-source.mdx index ec1ff3ef..e033b403 100644 --- a/sql/commands/sql-create-source.mdx +++ b/sql/commands/sql-create-source.mdx @@ -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. @@ -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" /> -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). ## Syntax @@ -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). | diff --git a/sql/commands/sql-select.mdx b/sql/commands/sql-select.mdx index fc84423c..faadd56f 100644 --- a/sql/commands/sql-select.mdx +++ b/sql/commands/sql-select.mdx @@ -32,14 +32,14 @@ Where `from_item` can be: | Parameter or clause | Description | | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **WITH** clause | Provides a way to write supplemental statements for a larger query. For more information, see [WITH clause](/sql/query-syntax/with-clause). | -| **DISTINCT** clause | This clause eliminates duplicate rows from the result. SELECT DISTINCT eliminates duplicate rows based on **all selected columns**. SELECT DISTINCT ON allows you to specify expressions or columns and returns only the first row for each unique combination. It requires the use of the ORDER BY clause to determine the first row, and the DISTINCT ON expression must match the leftmost ORDER BY expression. The ORDER BY clause will normally contain additional expressions that determine the desired precedence of rows within each DISTINCT ON group. In this case, this expression can be an alternative with group [topN](/docs/current/sql-pattern-topn/) when "N=1". See [examples of this clause](#distinct-clause) below to know more about it. | +| **DISTINCT** clause | This clause eliminates duplicate rows from the result. SELECT DISTINCT eliminates duplicate rows based on **all selected columns**. SELECT DISTINCT ON allows you to specify expressions or columns and returns only the first row for each unique combination. It requires the use of the ORDER BY clause to determine the first row, and the DISTINCT ON expression must match the leftmost ORDER BY expression. The ORDER BY clause will normally contain additional expressions that determine the desired precedence of rows within each DISTINCT ON group. In this case, this expression can be an alternative with group [topN](/processing/sql/top-n-by-group) when "N=1". See [examples of this clause](#distinct-clause) below to know more about it. | | **EXCEPT** clause | Exclude one or more columns from the result set. By specifying _except\_column_, the query will return all columns in the result set except those specified. | | _expression_ | A column or an expression. | -| **VALUES** clause | This clause generates one or more rows of data as a table expression. For details, see [VALUES clause](/docs/current/sql/query-syntax/query-syntax-values-clause/). | +| **VALUES** clause | This clause generates one or more rows of data as a table expression. For details, see [VALUES clause](/sql/query-syntax/values-clause). | | _alias_ | A temporary alternative name for a table or materialized view in a query. | | _table\_name_ | A table or materialized view. | | _grouping\_expression_ | Values can be:Input column namesInput column expressions without subqueries or correlated columns | -| **ORDER BY** clause | By default, sorting is in ascending (ASC) order, with NULL values treated as the largest. For more information, see [ORDER BY clause](/docs/current/query-syntax-order-by-clause/). | +| **ORDER BY** clause | By default, sorting is in ascending (ASC) order, with NULL values treated as the largest. For more information, see [ORDER BY clause](/sql/query-syntax/order-by-clause). | | _sort\_expression_ | Values can be:Output column namesOutput column ordinal numbersHidden select expressions | | _count\_number_ | The number of results you want to get. | | **OFFSET** clause | The OFFSET clause can only be used with the LIMIT and ORDER BY clauses. | @@ -48,11 +48,11 @@ Where `from_item` can be: | _join\_condition_ | Conditions for the ON clause that must be met before the two from\_items can be joined. | | _window\_type_ | The type of the time window function. Possible values are HOP and TUMBLE. | | _interval\_expression_ | The interval expression, in the format of INTERVAL '\'. For example: INTERVAL '2 MINUTES'. The standard SQL format, which places time units outside of quotation marks (for example, INTERVAL '2' MINUTE), is also supported. | -| **FROM** clause | Specifies the source of the data on which the query should operate. For more information, see [FROM clause](/docs/current/query-syntax-from-clause/). | -| **GROUP BY** clause | Groups rows in a table with identical data, thus eliminating redundancy in the output and aggregates that apply to these groups. For more information, see [GROUP BY clause](/docs/current/query-syntax-group-by-clause/). | -| **HAVING** clause | Eliminates group rows that do not satisfy a given condition. For more information, see [HAVING clause](/docs/current/query-syntax-having-clause/). | -| **LIMIT** clause | When the ORDER BY clause is not present, the LIMIT clause cannot be used as part of a materialized view. For more information, see [LIMIT clause](/docs/current/query-syntax-limit-clause/). | -| **WHERE** clause | Specifies any conditions or filters to apply to your data. For more information, see [WHERE clause](/docs/current/query-syntax-where-clause/). | +| **FROM** clause | Specifies the source of the data on which the query should operate. For more information, see [FROM clause](/sql/query-syntax/from-clause). | +| **GROUP BY** clause | Groups rows in a table with identical data, thus eliminating redundancy in the output and aggregates that apply to these groups. For more information, see [GROUP BY clause](/sql/query-syntax/group-by-clause). | +| **HAVING** clause | Eliminates group rows that do not satisfy a given condition. For more information, see [HAVING clause](/sql/query-syntax/having-clause). | +| **LIMIT** clause | When the ORDER BY clause is not present, the LIMIT clause cannot be used as part of a materialized view. For more information, see [LIMIT clause](/sql/query-syntax/limit-clause). | +| **WHERE** clause | Specifies any conditions or filters to apply to your data. For more information, see [WHERE clause](/sql/query-syntax/where-clause). | ## Examples diff --git a/sql/commands/sql-show-columns.mdx b/sql/commands/sql-show-columns.mdx index 7a230897..4658a8fb 100644 --- a/sql/commands/sql-show-columns.mdx +++ b/sql/commands/sql-show-columns.mdx @@ -15,7 +15,7 @@ SHOW COLUMNS FROM relation_name [ LIKE_expression ]; | Parameter or clause | Description | | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | _relation\_name_ | The name of the table, source, sink, view, or materialized view from which the columns will be listed. | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Examples diff --git a/sql/commands/sql-show-connections.mdx b/sql/commands/sql-show-connections.mdx index 5cdebe6f..4d5ab353 100644 --- a/sql/commands/sql-show-connections.mdx +++ b/sql/commands/sql-show-connections.mdx @@ -13,7 +13,7 @@ SHOW CONNECTIONS [ LIKE_expression ]; | Parameter or clause | Description | | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Example diff --git a/sql/commands/sql-show-databases.mdx b/sql/commands/sql-show-databases.mdx index e2cf5efc..f746d3ca 100644 --- a/sql/commands/sql-show-databases.mdx +++ b/sql/commands/sql-show-databases.mdx @@ -13,7 +13,7 @@ SHOW DATABASES [ LIKE_expression ]; | Parameter or clause | Description | | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Example diff --git a/sql/commands/sql-show-functions.mdx b/sql/commands/sql-show-functions.mdx index 51bae471..1b524447 100644 --- a/sql/commands/sql-show-functions.mdx +++ b/sql/commands/sql-show-functions.mdx @@ -13,7 +13,7 @@ SHOW FUNCTIONS [ LIKE_expression ]; | Parameter or clause | Description | | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Example diff --git a/sql/commands/sql-show-indexes.mdx b/sql/commands/sql-show-indexes.mdx index b66ae5ce..6dee1f0a 100644 --- a/sql/commands/sql-show-indexes.mdx +++ b/sql/commands/sql-show-indexes.mdx @@ -14,7 +14,7 @@ SHOW INDEXES FROM table_name [ LIKE_expression ]; | Parameter | Description | | :--------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | _table\_name_ | The table from which indexes will be displayed. | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Example[](#example "Direct link to Example") diff --git a/sql/commands/sql-show-internal-tables.mdx b/sql/commands/sql-show-internal-tables.mdx index b3df10d8..da7455a8 100644 --- a/sql/commands/sql-show-internal-tables.mdx +++ b/sql/commands/sql-show-internal-tables.mdx @@ -16,7 +16,7 @@ SHOW INTERNAL TABLES [ FROM schema_name ] [ LIKE_expression ]; | Parameter | Description | | :--------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | _schema\_name_ | The schema in which tables will be listed. If not given, tables from the default schema, public, will be listed. | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Example diff --git a/sql/commands/sql-show-jobs.mdx b/sql/commands/sql-show-jobs.mdx index 6780f96c..d10ca7a4 100644 --- a/sql/commands/sql-show-jobs.mdx +++ b/sql/commands/sql-show-jobs.mdx @@ -15,7 +15,7 @@ SHOW JOBS [ LIKE_expression ]; | Parameter | Description | | :--------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Example ```sql diff --git a/sql/commands/sql-show-mv.mdx b/sql/commands/sql-show-mv.mdx index 165b701e..3ed5c957 100644 --- a/sql/commands/sql-show-mv.mdx +++ b/sql/commands/sql-show-mv.mdx @@ -14,7 +14,7 @@ SHOW MATERIALIZED VIEWS [ FROM schema_name ] [ LIKE_expression ]; | Parameter | Description | | :--------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | _schema\_name_ | The schema in which the materialized views will be listed. If not given, materialized views from the default schema, public, will be listed | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Example diff --git a/sql/commands/sql-show-schemas.mdx b/sql/commands/sql-show-schemas.mdx index 8ca5182d..d3750da3 100644 --- a/sql/commands/sql-show-schemas.mdx +++ b/sql/commands/sql-show-schemas.mdx @@ -14,7 +14,7 @@ SHOW SCHEMAS [ LIKE_expression ]; | Parameter or clause | Description | | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Example diff --git a/sql/commands/sql-show-sinks.mdx b/sql/commands/sql-show-sinks.mdx index 747b1db0..a4aa0bc9 100644 --- a/sql/commands/sql-show-sinks.mdx +++ b/sql/commands/sql-show-sinks.mdx @@ -14,7 +14,7 @@ SHOW SINKS [ FROM schema_name ] [ LIKE_expression ]; | Clause | Description | | :------------------ | :-------------------------- | | schema\_name |The schema of the sinks to be listed.| -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Example diff --git a/sql/commands/sql-show-sources.mdx b/sql/commands/sql-show-sources.mdx index f425a44f..bbcf4fff 100644 --- a/sql/commands/sql-show-sources.mdx +++ b/sql/commands/sql-show-sources.mdx @@ -14,7 +14,7 @@ SHOW SOURCES [ FROM schema_name ] [ LIKE_expression ]; | Parameter or clause | Description | | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | _schema\_name_ | The schema of the sources to be listed. The default schema is public. | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Examples diff --git a/sql/commands/sql-show-tables.mdx b/sql/commands/sql-show-tables.mdx index 43e8c561..dafcfda1 100644 --- a/sql/commands/sql-show-tables.mdx +++ b/sql/commands/sql-show-tables.mdx @@ -14,7 +14,7 @@ SHOW TABLES [ FROM schema_name ] [ LIKE_expression ]; | Parameter or clause | Description | | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | _schema\_name_ | The schema in which tables will be listed. If not given, tables from the default schema, public, will be listed. | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Example diff --git a/sql/commands/sql-show-views.mdx b/sql/commands/sql-show-views.mdx index 77a7035b..d23c60c9 100644 --- a/sql/commands/sql-show-views.mdx +++ b/sql/commands/sql-show-views.mdx @@ -14,7 +14,7 @@ SHOW VIEWS [ FROM schema_name ] [ LIKE_expression ]; | Parameter or clause | Description | | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | _schema\_name_ | The schema from which existing views will be listed. If not given, views from the default schema, "public", will be listed. | -| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/docs/current/sql-function-string/#like-pattern-matching-expressions). | +| LIKE\_expression | Filters the output based on names by applying pattern matching. See details in [LIKE pattern matching expressions](/sql/functions/string#like-pattern-matching-expressions). | ## Example diff --git a/sql/data-types/array-type.mdx b/sql/data-types/array-type.mdx index 94eebcaa..cff8789b 100644 --- a/sql/data-types/array-type.mdx +++ b/sql/data-types/array-type.mdx @@ -145,4 +145,4 @@ SELECT unnest(array[1,2,3,4]); ## Array functions and operators -For the full list of array functions and operators, see [Array functions and operators](/docs/current/sql-function-array/). +For the full list of array functions and operators, see [Array functions and operators](/sql/functions/array). diff --git a/sql/data-types/jsonb.mdx b/sql/data-types/jsonb.mdx index 74b5892c..bcf66feb 100644 --- a/sql/data-types/jsonb.mdx +++ b/sql/data-types/jsonb.mdx @@ -74,7 +74,7 @@ VALUES To retrieve data from a `JSONB` column, use the `->` or `->>` operators to access the JSON object's properties. The `->` operator returns a `jsonb` value, while the `->>` operator returns a varchar value. -For details about the JSON operators, see [JSON operators](/docs/current/sql-function-json/#json-operators). +For details about the JSON operators, see [JSON operators](/sql/functions/json#json-operators). `JSONB` data types can be cast to other data types such as bool, smallint, int, bigint, decimal, real, and double precision. Casting is performed using the `::data-type` cast notation, such as `::int` for casting to an integer data type. @@ -106,4 +106,4 @@ The output shows that the `brand_bad` column contains additional double quotes. ## JSONB functions and operators -For the full list of JSONB functions and operators, see [JSON functions and operators](/docs/current/sql-function-json/). +For the full list of JSONB functions and operators, see [JSON functions and operators](/sql/functions/json). diff --git a/sql/data-types/map-type.mdx b/sql/data-types/map-type.mdx index 9cec42cb..2adce2e8 100644 --- a/sql/data-types/map-type.mdx +++ b/sql/data-types/map-type.mdx @@ -63,4 +63,4 @@ SELECT map_insert(MAP {'key1': 1, 'key2': 2, 'key3': 3}, 'key2', 4); ## Map functions and operators -For the full list of map functions and operators, see [Map functions and operators](/docs/current/sql-function-map/). +For the full list of map functions and operators, see [Map functions and operators](/sql/functions/map). diff --git a/sql/data-types/overview.mdx b/sql/data-types/overview.mdx index 535f6a6b..862b4fc0 100644 --- a/sql/data-types/overview.mdx +++ b/sql/data-types/overview.mdx @@ -32,5 +32,5 @@ Scientific notation (e.g., 1e6, 1.25e5, and 1e-4) is supported in SELECT and INS ## Casting -For details about data type casting, see [Casting](/docs/current/data-type-casting/). +For details about data type casting, see [Casting](/sql/data-types/casting). diff --git a/sql/functions/datetime.mdx b/sql/functions/datetime.mdx index 4f7f021e..e10dfe8d 100644 --- a/sql/functions/datetime.mdx +++ b/sql/functions/datetime.mdx @@ -186,7 +186,7 @@ make_timestamp(2024, 1, 31, 1, 45, 30.2) → 2024-01-31 01:45:30.200 ### `now` -Returns the current date and time. For streaming queries, `now()` can only be used with WHERE, HAVING, and ON clauses. For more information, see [Temporal filters](/docs/current/sql-pattern-temporal-filters/). This constraint does not apply to batch queries. +Returns the current date and time. For streaming queries, `now()` can only be used with WHERE, HAVING, and ON clauses. For more information, see [Temporal filters](/processing/sql/temporal-filters). This constraint does not apply to batch queries. ```bash now() → timestamptz diff --git a/sql/functions/overview.mdx b/sql/functions/overview.mdx index 567b2a3a..e767070c 100644 --- a/sql/functions/overview.mdx +++ b/sql/functions/overview.mdx @@ -6,20 +6,20 @@ mode: wide --- - Operators for logical operations. - Functions and operators for comparing values. - Functions and operators for mathematical operations. - Functions and operators for string manipulation. - Functions and operators for binary string operations. - Functions and operators for date and time operations. - Functions for cryptographic operations. - Functions and operators for JSON data. - Functions and operators for array operations. - Functions and operators for map data structures. - Expressions for conditional logic, such as CASE statements. - Functions that compute a single result from a set of input values. - Functions that operate on a set of rows related to the current row. - Functions that return a set of rows, such as generate_series(). - Functions for system administration tasks in RisingWave and PostgreSQL. - Functions to retrieve system information about database, schema, user, role, session, etc. + Operators for logical operations. + Functions and operators for comparing values. + Functions and operators for mathematical operations. + Functions and operators for string manipulation. + Functions and operators for binary string operations. + Functions and operators for date and time operations. + Functions for cryptographic operations. + Functions and operators for JSON data. + Functions and operators for array operations. + Functions and operators for map data structures. + Expressions for conditional logic, such as CASE statements. + Functions that compute a single result from a set of input values. + Functions that operate on a set of rows related to the current row. + Functions that return a set of rows, such as generate_series(). + Functions for system administration tasks in RisingWave and PostgreSQL. + Functions to retrieve system information about database, schema, user, role, session, etc. diff --git a/sql/functions/set-returning.mdx b/sql/functions/set-returning.mdx index a9439ab6..82047afd 100644 --- a/sql/functions/set-returning.mdx +++ b/sql/functions/set-returning.mdx @@ -177,7 +177,7 @@ The result looks like this: ## \_pg\_expandarray() -The `_pg_expandarray` function takes an array as input and expands it into a set of rows, providing values and their corresponding indices within the array. Ensure that [information\_schema](/docs/current/information-schema/) is in the search path to access the `_pg_expandarray` function. +The `_pg_expandarray` function takes an array as input and expands it into a set of rows, providing values and their corresponding indices within the array. Ensure that [information\_schema](/sql/system-catalogs/information-schema) is in the search path to access the `_pg_expandarray` function. Example: diff --git a/sql/functions/window-functions.mdx b/sql/functions/window-functions.mdx index 81df1ad2..c517e224 100644 --- a/sql/functions/window-functions.mdx +++ b/sql/functions/window-functions.mdx @@ -20,7 +20,7 @@ row_number() → integer ``` -We recommend using `row_number()` only for top-N pattern queries. For details about this pattern, see [Top-N by group](/docs/current/sql-pattern-topn/). +We recommend using `row_number()` only for top-N pattern queries. For details about this pattern, see [Top-N by group](/processing/sql/top-n-by-group). ### `rank()` diff --git a/sql/overview.mdx b/sql/overview.mdx index 60f65f36..22b4a62b 100644 --- a/sql/overview.mdx +++ b/sql/overview.mdx @@ -4,25 +4,25 @@ mod: wide sidebarTitle: Overview --- - + 84 items - + 13 items - + 8 items - + 16 items - + Naming restrictions - + 3 items - + RisingWave supported commands diff --git a/sql/query-syntax/overview.mdx b/sql/query-syntax/overview.mdx index 2900c2c3..4faae76d 100644 --- a/sql/query-syntax/overview.mdx +++ b/sql/query-syntax/overview.mdx @@ -6,17 +6,17 @@ description: Syntax and usage of common query clauses. - Introduction of various types of literals. - Specify the value returned by a particular column. - Create a generated column when creating a table or source. - Specify the source of the data on which the query should operate. - Specify any conditions or filters to apply to your data. - Group rows in a table with identical data - Eliminate group rows that do not satisfy a given condition. - Sort the result set of a query in ascending or descending order. - Restrict the number of rows fetched. - Generate one or more rows of data as a table expression - The results of two queries can be combined using the set operations UNION and INTERSECT. - Write supplemental statements for a larger query. - Used with set functions in the FROM clause of a query. + Introduction of various types of literals. + Specify the value returned by a particular column. + Create a generated column when creating a table or source. + Specify the source of the data on which the query should operate. + Specify any conditions or filters to apply to your data. + Group rows in a table with identical data + Eliminate group rows that do not satisfy a given condition. + Sort the result set of a query in ascending or descending order. + Restrict the number of rows fetched. + Generate one or more rows of data as a table expression + The results of two queries can be combined using the set operations UNION and INTERSECT. + Write supplemental statements for a larger query. + Used with set functions in the FROM clause of a query. diff --git a/sql/query-syntax/value-exp.mdx b/sql/query-syntax/value-exp.mdx index 0254b550..d2be4b0a 100644 --- a/sql/query-syntax/value-exp.mdx +++ b/sql/query-syntax/value-exp.mdx @@ -28,7 +28,7 @@ The `DISTINCT` keyword, which is only available in the second form, cannot be us AGGREGATE:function_name ``` -where the `AGGREGATE:` prefix converts a [builtin array function](/docs/current/sql-function-array/) (e.g. `array_sum`) or an [user-defined function](/sql/udfs/user-defined-functions), to an aggregate function. The function being converted must accept exactly one argument of an [array type](/sql/data-types/array-type). After the conversion, a function like `foo ( array of T ) -> U` becomes an aggregate function like `AGGREGATE:foo ( T ) -> U`. +where the `AGGREGATE:` prefix converts a [builtin array function](/sql/functions/array) (e.g. `array_sum`) or an [user-defined function](/sql/udfs/user-defined-functions), to an aggregate function. The function being converted must accept exactly one argument of an [array type](/sql/data-types/array-type). After the conversion, a function like `foo ( array of T ) -> U` becomes an aggregate function like `AGGREGATE:foo ( T ) -> U`. ## Window function calls @@ -57,7 +57,7 @@ For ranking window functions like `row_number`, `rank` and `dense_rank`, `ORDER When operating in the [Emit on window close](/processing/emit-on-window-close) mode for a streaming query, `ORDER BY` clause is required for all window functions. Please ensure that you specify exactly one column in the `ORDER BY` clause. This column, generally a timestamp column, must have a watermark defined for it. It's important to note that when using the timestamp column from this streaming query in another streaming query, the watermark information associated with the column is not retained. -`window_function_name` is one of the window functions listed on [Window functions](/docs/current/sql-function-window-functions/). +`window_function_name` is one of the window functions listed on [Window functions](/sql/functions/window-functions). `frame_clause` can be one of: diff --git a/sql/query-syntax/with-ordinality-clause.mdx b/sql/query-syntax/with-ordinality-clause.mdx index d8182ed0..23bc1558 100644 --- a/sql/query-syntax/with-ordinality-clause.mdx +++ b/sql/query-syntax/with-ordinality-clause.mdx @@ -5,7 +5,7 @@ description: "The `WITH ORDINALITY` clause can be used with set functions in the 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`. -See [Set-returning functions](/docs/current/sql-function-set-returning/) for a list of supported set functions. +See [Set-returning functions](/sql/functions/set-returning) for a list of supported set functions. Here is a simple example of how the `WITH ORDINALITY` clause works. diff --git a/sql/system-catalogs/overview.mdx b/sql/system-catalogs/overview.mdx index c6399ae8..7524bbf9 100644 --- a/sql/system-catalogs/overview.mdx +++ b/sql/system-catalogs/overview.mdx @@ -6,7 +6,7 @@ mode: wide --- - A set of views containing information about objects defined in the current database. - System catalogs and views of PostgreSQL supported by RisingWave. - System tables and views providing metadata about relations and cluster job status in RisingWave. + A set of views containing information about objects defined in the current database. + System catalogs and views of PostgreSQL supported by RisingWave. + System tables and views providing metadata about relations and cluster job status in RisingWave. diff --git a/sql/system-catalogs/pg-catalog.mdx b/sql/system-catalogs/pg-catalog.mdx index 61b03b55..33436d57 100644 --- a/sql/system-catalogs/pg-catalog.mdx +++ b/sql/system-catalogs/pg-catalog.mdx @@ -3,7 +3,7 @@ title: "PostgreSQL catalogs" description: "RisingWave supports these system catalogs and views of PostgreSQL." --- -For information about RisingWave and PostgreSQL system functions, see [System administration functions](/sql/functions/sys-admin) and [System information functions](/docs/current/sql-function-sys-info/). +For information about RisingWave and PostgreSQL system functions, see [System administration functions](/sql/functions/sys-admin) and [System information functions](/sql/functions/sys-info). RisingWave does not fully support all PostgreSQL system catalog columns. diff --git a/sql/udfs/embedded-python-udfs.mdx b/sql/udfs/embedded-python-udfs.mdx index f9718f36..89e8f793 100644 --- a/sql/udfs/embedded-python-udfs.mdx +++ b/sql/udfs/embedded-python-udfs.mdx @@ -4,7 +4,7 @@ description: "You can define embedded Python UDFs, which will be executed in an sidebarTitle: Python --- -Currently, embedded Python UDFs only support pure computational logic and do not support accessing external networks or file systems. If you need to access external services or resources, you can use [Python UDFs as external functions](/docs/current/udf-python/). +Currently, embedded Python UDFs only support pure computational logic and do not support accessing external networks or file systems. If you need to access external services or resources, you can use [Python UDFs as external functions](/sql/udfs/use-udfs-in-python). ## Define your functions You can create Python UDFs using the `CREATE FUNCTION` command. Refer to the syntax below: @@ -29,7 +29,7 @@ $$; The Python code must contain a function that has the same name as declared in the `CREATE FUNCTION` statement. The function's parameters and return type must match those declared in the `CREATE FUNCTION` statement, otherwise, an error may occur when the function is called. -See the correspondence between SQL types and Python types in the [Data type mapping](/docs/current/udf-python-embedded/#data-type-mapping). +See the correspondence between SQL types and Python types in the [Data type mapping](/sql/udfs/embedded-python-udfs#data-type-mapping). Due to the nature of Python, the correctness of the source code cannot be verified when creating a function. It is recommended to make sure your implementation is correct through batch query before using UDFs in materialized views. If an error occurs when executing UDF in materialized views, all output results will be NULL. diff --git a/sql/udfs/use-udfs-in-java.mdx b/sql/udfs/use-udfs-in-java.mdx index 30dbcdd5..e8c3d0bc 100644 --- a/sql/udfs/use-udfs-in-java.mdx +++ b/sql/udfs/use-udfs-in-java.mdx @@ -77,7 +77,7 @@ A user-defined scalar function maps zero, one, or multiple scalar values to a ne In order to define a scalar function, you have to create a new class that implements the `ScalarFunction`interface in `com.risingwave.functions` and implement exactly one evaluation method named `eval(...)`. This method must be declared public and non-static. -Any data type listed in [Data type mapping](/docs/current/udf-java/#data-type-mapping) can be used as a parameter or return type of an evaluation method. +Any data type listed in [Data type mapping](/sql/udfs/use-udfs-in-java#data-type-mapping) can be used as a parameter or return type of an evaluation method. Here's an example of a scalar function that calculates the greatest common divisor (GCD) of two integers: @@ -110,7 +110,7 @@ A user-defined table function maps zero, one, or multiple scalar values to one o In order to define a table function, you have to create a new class that implements the `TableFunction`interface in `com.risingwave.functions` and implement exactly one evaluation method named `eval(...)`. This method must be declared public and non-static. -The return type must be an `Iterator` of any data type listed in [Data type mapping](/docs/current/udf-java/#data-type-mapping). +The return type must be an `Iterator` of any data type listed in [Data type mapping](/sql/udfs/use-udfs-in-java#data-type-mapping). Similar to scalar functions, input and output data types are automatically extracted using reflection. This includes the generic argument T of the return value for determining an output data type. diff --git a/sql/udfs/use-udfs-in-javascript.mdx b/sql/udfs/use-udfs-in-javascript.mdx index 8ab0f6d2..b8e3e956 100644 --- a/sql/udfs/use-udfs-in-javascript.mdx +++ b/sql/udfs/use-udfs-in-javascript.mdx @@ -33,7 +33,7 @@ CREATE FUNCTION gcd(a int, b int) RETURNS int LANGUAGE javascript AS $$ $$; ``` -See the correspondence between SQL types and JavaScript types in the [Data type mapping](/docs/current/udf-javascript/#data-type-mapping). You need to ensure that the type of the return value is either `null` or consistent with the type in the `RETURNS` clause. +See the correspondence between SQL types and JavaScript types in the [Data type mapping](/sql/udfs/use-udfs-in-javascript#data-type-mapping). You need to ensure that the type of the return value is either `null` or consistent with the type in the `RETURNS` clause. If the function you defined returns a table, you need to use the `yield` statement to return the data of each row. For example: diff --git a/sql/udfs/use-udfs-in-rust.mdx b/sql/udfs/use-udfs-in-rust.mdx index e3e6b461..b856d0be 100644 --- a/sql/udfs/use-udfs-in-rust.mdx +++ b/sql/udfs/use-udfs-in-rust.mdx @@ -30,7 +30,7 @@ CREATE FUNCTION gcd(int, int) RETURNS int LANGUAGE rust AS $$ $$; ``` -The Rust code must start with a `fn` function, and the function's name, parameters, and return type must match those declared in the `CREATE FUNCTION` statement. Refer to the [Data type mapping](/docs/current/udf-rust/#data-type-mapping) for details on the correspondence between SQL types and Rust types. +The Rust code must start with a `fn` function, and the function's name, parameters, and return type must match those declared in the `CREATE FUNCTION` statement. Refer to the [Data type mapping](/sql/udfs/use-udfs-in-rust#data-type-mapping) for details on the correspondence between SQL types and Rust types. For table functions, your function must return an `impl Iterator` type, where `T` is the type of the returned elements. For example, to generate a sequence from 0 to n-1: @@ -61,7 +61,7 @@ $$; First, define a structure using `struct` and annotate it with `#[derive(StructType)]`. Its fields must match the struct type declared in the `CREATE FUNCTION` statement. Then, define the function and annotate it with the `#[function("...")]` macro. The string in the macro represents the SQL signature of the function, with the tail return type being `struct StructName`. For the specific syntax, see [arrow-udf](https://docs.rs/arrow-udf/0.2.1/arrow%5Fudf/attr.function.html). -Currently, in `CREATE FUNCTION` statement, Rust code can only use libraries from the standard library, `chrono`, `rust_decimal`, `serde_json`, and does not support other third-party libraries. If you wish to use other libraries, you may consider [compiling WebAssembly modules manually](/docs/current/udf-rust/#alternative-manually-build-your-functions-into-a-webassembly-module). +Currently, in `CREATE FUNCTION` statement, Rust code can only use libraries from the standard library, `chrono`, `rust_decimal`, `serde_json`, and does not support other third-party libraries. If you wish to use other libraries, you may consider [compiling WebAssembly modules manually](/sql/udfs/use-udfs-in-rust#alternative-manually-build-your-functions-into-a-webassembly-module). ## Use your functions in RisingWave @@ -127,7 +127,7 @@ fn series(n: i32) -> impl Iterator { You can find more usages in these [functions](https://docs.rs/arrow%5Fudf/0.2.1/arrow%5Fudf/attr.function.html) and more examples in these [tests](https://github.com/risingwavelabs/arrow-udf/blob/main/arrow-udf/tests/tests.rs). -See the correspondence between SQL types and Rust types in the [Data type mapping](/docs/current/udf-rust/#data-type-mapping). +See the correspondence between SQL types and Rust types in the [Data type mapping](/sql/udfs/use-udfs-in-rust#data-type-mapping). ### 3\. Build the project diff --git a/sql/udfs/user-defined-functions.mdx b/sql/udfs/user-defined-functions.mdx index 1af3f52d..a3a5ceff 100644 --- a/sql/udfs/user-defined-functions.mdx +++ b/sql/udfs/user-defined-functions.mdx @@ -26,8 +26,8 @@ You can create all types of UDFs mentioned above using the [CREATE FUNCTION](/sq RisingWave supports creating external UDFs with the following programming languages: - - + + ### Embedded UDFs @@ -35,9 +35,9 @@ RisingWave supports creating external UDFs with the following programming langua RisingWave supports creating embedded UDFs with the following programming languages: - - - + + + ### SQL UDFs @@ -45,7 +45,7 @@ RisingWave supports creating embedded UDFs with the following programming langua For details about how to create a SQL UDF and its use cases, see: - + ## Other ways to categorize UDFs @@ -57,7 +57,7 @@ The other two dimensions are: * The input and output of functions. For this dimension, since common SQL functions include scalar functions, table functions, aggregate functions, and window functions, UDFS can be classified as user-defined scalar functions (abbreviated as UDFs), user-defined table functions (UDTFs), user-defined aggregate functions (UDAFs), and user-defined window functions (UDWFs). RisingWave supports UDFs, UDTFs and UDAFs, covering most practical needs. You can find their guides in our documentation too. -For example, for UDAFs, you can use the [CREATE AGGREGATE](/sql/commands/sql-create-aggregate) command to create functions. Meanwhile, we also offer dedicated sections for creating UDAFs in [Embedded Python UDFs](/docs/current/udf-python-embedded/#define-your-aggregate-functions) and [Embedded JavaScript UDFs](/docs/current/udf-javascript/#define-your-aggregate-functions). +For example, for UDAFs, you can use the [CREATE AGGREGATE](/sql/commands/sql-create-aggregate) command to create functions. Meanwhile, we also offer dedicated sections for creating UDAFs in [Embedded Python UDFs](/sql/udfs/embedded-python-udfs#define-your-aggregate-functions) and [Embedded JavaScript UDFs](/sql/udfs/use-udfs-in-javascript#define-your-aggregate-functions). * The language used to write functions. RisingWave currently supports using SQL, Python, Java, JavaScript, and Rust to write UDFs. diff --git a/troubleshoot/node-failure.mdx b/troubleshoot/node-failure.mdx index 9328382e..d3fd91bd 100644 --- a/troubleshoot/node-failure.mdx +++ b/troubleshoot/node-failure.mdx @@ -7,7 +7,7 @@ description: "When it comes to crafting downtime-sensitive applications, users o 2. Is it feasible to deploy multiple replicas of the nodes to eliminate single points of failure? 3. How can we mitigate the impact of downtime? -In this topic, we will provide answers to these questions. However, before you continue reading, we suggest that you first explore our [fault tolerance mechanism](/docs/current/fault-tolerance/) to gain a better understanding. +In this topic, we will provide answers to these questions. However, before you continue reading, we suggest that you first explore our [fault tolerance mechanism](/reference/fault-tolerance) to gain a better understanding. --- diff --git a/troubleshoot/overview.mdx b/troubleshoot/overview.mdx index 3bb46447..e6e22b7a 100644 --- a/troubleshoot/overview.mdx +++ b/troubleshoot/overview.mdx @@ -41,7 +41,7 @@ We recommend that you deploy a dedicated logging system, such as [Grafana Loki]( ## Leverage system catalogs -System catalogs provide comprehensive information about the definitions and metadata of objects in RisingWave. For a detailed list of system catalogs available, see [System catalogs](/docs/current/pg-catalogs/). +System catalogs provide comprehensive information about the definitions and metadata of objects in RisingWave. For a detailed list of system catalogs available, see [System catalogs](/sql/system-catalogs/overview). ## Support resources diff --git a/troubleshoot/troubleshoot-high-latency.mdx b/troubleshoot/troubleshoot-high-latency.mdx index 937f3cc5..53f69f82 100644 --- a/troubleshoot/troubleshoot-high-latency.mdx +++ b/troubleshoot/troubleshoot-high-latency.mdx @@ -51,7 +51,7 @@ For example, the following figure shows a materialized view with extremely high -To solve the issue, consider rewriting the SQL query to reduce join amplification, such as using better equal conditions on the problematic join to reduce the number of matched rows. See [Maintain wide table with table sinks](/docs/current/multiple-table-sink/) for details. +To solve the issue, consider rewriting the SQL query to reduce join amplification, such as using better equal conditions on the problematic join to reduce the number of matched rows. See [Maintain wide table with table sinks](/processing/maintain-wide-table-with-table-sinks) for details. At the same time, a log of `high_join_amplification` with the problematic join keys will be printed, such as