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 693f7b8 commit 0e5c509
Show file tree
Hide file tree
Showing 58 changed files with 99 additions and 100 deletions.
2 changes: 1 addition & 1 deletion cloud/connect-to-a-project.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To connect with any local clients, follow the steps below:
* Alternatively, you can create a new user, RisingWave Cloud offers `psql`, `Connection String`, `Parameters Only`, `Java`, `Node.js`, `Python`, and `Golang` as connection options.

<Note>
To connect via `psql`, you need to [Install psql](/docs/current/install-psql-without-postgresql/) in your environment. `psql` is a command-line interface for interacting with PostgreSQL databases, including RisingWave.
To connect via `psql`, you need to [Install psql](/deploy/install-psql-without-postgresql) in your environment. `psql` is a command-line interface for interacting with PostgreSQL databases, including RisingWave.
</Note>

3. You may need to set up a CA certificate to enable SSL connections. See the instructions displayed on the portal for more details.
Expand Down
2 changes: 1 addition & 1 deletion cloud/create-a-connection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ We aim to automate this process in the future to make it even easier.

Now, you can create a source or sink with the PrivateLink connection using SQL.

For details on how to use the VPC endpoint to create a source with the PrivateLink connection, see [Create source with PrivateLink connection](/docs/current/ingest-from-kafka/#create-source-with-privatelink-connection); for creating a sink, see [Create sink with PrivateLink connection](/integrations/destinations/apache-kafka#create-sink-with-privatelink-connection).
For details on how to use the VPC endpoint to create a source with the PrivateLink connection, see [Create source with PrivateLink connection](/integrations/sources/kafka#create-source-with-privatelink-connection); for creating a sink, see [Create sink with PrivateLink connection](/integrations/destinations/apache-kafka#create-sink-with-privatelink-connection).
8 changes: 4 additions & 4 deletions cloud/develop-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Select the version of the corresponding docs when using the RisingWave user docs
### Ecosystem

<CardGroup cols={3}>
<Card title="Integrations" icon="puzzle-piece" href="/docs/current/rw-integration-summary/" 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="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="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 Down Expand Up @@ -90,14 +90,14 @@ Select the version of the corresponding docs when using the RisingWave user docs
RisingWave offers support for popular PostgreSQL drivers, enabling seamless integration with your applications for interacting with it.

<p>
<a href="https://docs.risingwave.com/docs/current/java-client-libraries/" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Java</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
<a href="https://docs.risingwave.com/client-libraries/java" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Java</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
</p>

<p>
<a href="https://docs.risingwave.com/docs/current/nodejs-client-libraries/" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Node.js</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
<a href="https://docs.risingwave.com/client-libraries/nodejs" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Node.js</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
</p>
<p>
<a href="https://docs.risingwave.com/docs/current/python-client-libraries/" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Python</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
<a href="https://docs.risingwave.com/client-libraries/python" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Python</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
</p>
<p>
<a href="https://docs.risingwave.com/docs/current/go-client-libraries/" style={{ textDecoration: "underline", textDecorationColor: "#005eec" }}>Go</a> <Icon icon="arrow-up-right-from-square" iconType="solid" size={10} />
Expand Down
2 changes: 1 addition & 1 deletion demos/fast-twitter-events-processing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ CREATE SOURCE twitter (
) FORMAT PLAIN ENCODE JSON;
```

Note that the SQL statement uses the STRUCT data type. For details about the STRUCT data type, please see [Data types](/docs/current/sql-data-types/).
Note that the SQL statement uses the STRUCT data type. For details about the STRUCT data type, please see [Data types](/sql/data-types/overview).

## Step 3: Define a materialized view and analyze data

Expand Down
2 changes: 1 addition & 1 deletion deploy/migrate-to-sql-backend.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Make sure the SQL backend service is operational and you have the necessary cred

### Back up etcd data

The migration process from etcd to a SQL backend is performed offline, so we recommend taking a backup of your current etcd data to avoid any data loss before the migration. Refer to the [meta-backup](/docs/current/meta-backup/) for detailed instructions.
The migration process from etcd to a SQL backend is performed offline, so we recommend taking a backup of your current etcd data to avoid any data loss before the migration. Refer to the [meta-backup](/operate/meta-backup) for detailed instructions.

## Procedure

Expand Down
6 changes: 3 additions & 3 deletions deploy/node-specific-configurations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ recent_filter_rotate_interval_ms = 10000
When setting up configurations, please be extra careful with those items prefixed by `unsafe_`. Typically these configurations can cause system or data damage if wrongly configured. You may want to contact our technical support before changing the `unsafe_` prefixed configurations.

### System configurations
System configurations are used to **initialize** the [system parameters](/docs/current/view-configure-system-parameters/) at the first startup. Once the system has started, the system parameters are managed by Meta service and can be altered using the `ALTER SYSTEM SET` command.
System configurations are used to **initialize** the [system parameters](/operate/view-configure-system-parameters) at the first startup. Once the system has started, the system parameters are managed by Meta service and can be altered using the `ALTER SYSTEM SET` command.

Example for the system configuration section:

Expand All @@ -73,7 +73,7 @@ backup_storage_url = "minio://hummockadmin:[email protected]:9301/hummock00
backup_storage_directory = "hummock_001/backup"
```

For more information on system parameters, please refer to [View and configure system parameters](/docs/current/view-configure-system-parameters/).
For more information on system parameters, please refer to [View and configure system parameters](/operate/view-configure-system-parameters).

### Streaming configurations

Expand Down Expand Up @@ -158,4 +158,4 @@ Below is an example of the cache refill configuration for your reference.

#### Other storage configurations

Except for the above, RisingWave also provides some other storage configurations to help control the overall buffer and cache limits. Please see [Dedicated compute node](/docs/current/dedicated-compute-node/) for more.
Except for the above, RisingWave also provides some other storage configurations to help control the overall buffer and cache limits. Please see [Dedicated compute node](/operate/dedicated-compute-node) for more.
4 changes: 2 additions & 2 deletions deploy/risingwave-docker-compose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: This topic describes how to start RisingWave using Docker Compose o

In this option, RisingWave functions as an all-in-one service. All components of RisingWave, including the compute node, meta node, and compactor node, are put into a single process. They are executed in different threads, eliminating the need to start each component as a separate process.

However, please be aware that certain critical features, such as failover and resource management, are not implemented in this mode. Therefore, this option is not recommended for production deployments. For production deployments, please consider [RisingWave Cloud](/docs/current/risingwave-cloud/), [Kubernetes with Helm](/docs/current/risingwave-k8s-helm/), or [Kubernetes with Operator](/docs/current/risingwave-kubernetes/).
However, please be aware that certain critical features, such as failover and resource management, are not implemented in this mode. Therefore, this option is not recommended for production deployments. For production deployments, please consider [RisingWave Cloud](/deploy/risingwave-cloud), [Kubernetes with Helm](/deploy/risingwave-k8s-helm), or [Kubernetes with Operator](/deploy/risingwave-kubernetes).

This option uses a pre-defined Docker Compose configuration file to set up a RisingWave cluster.

Expand Down Expand Up @@ -167,7 +167,7 @@ Remember to replace the `docker-compose-with-storage_backend_name.yml` with the

## Connect to RisingWave

After RisingWave is up and running, you need to connect to it via the Postgres interactive terminal `psql` so that you can issue queries to RisingWave and see the query results. If you don't have `psql` installed, [install psql](/docs/current/install-psql-without-postgresql/) first.
After RisingWave is up and running, you need to connect to it via the Postgres interactive terminal `psql` so that you can issue queries to RisingWave and see the query results. If you don't have `psql` installed, [install psql](/deploy/install-psql-without-postgresql) first.

```bash
psql -h localhost -p 4566 -d dev -U root
Expand Down
6 changes: 3 additions & 3 deletions deploy/risingwave-k8s-helm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebarTitle: Kubernetes with Helm

* Ensure you have Helm 3.7 + installed in your environment. For details about how to install Helm, see the [Helm documentation](https://helm.sh/docs/intro/install/).
* Ensure you have [Kubernetes](https://kubernetes.io/) 1.24 or higher installed in your environment.
* Ensure you allocate enough resources for the deployment. For details, see [Hardware requirements](/docs/current/hardware-requirements/).
* Ensure you allocate enough resources for the deployment. For details, see [Hardware requirements](/deploy/hardware-requirements).

## Step 1: Start Kubernetes

Expand Down Expand Up @@ -112,7 +112,7 @@ psql -h localhost -p 4567 -d dev -U root

## Step 4: Monitor performance

You can monitor the RisingWave cluster using the monitoring stack. For details, see [Monitoring a RisingWave cluster](/docs/current/monitor-risingwave-cluster/).
You can monitor the RisingWave cluster using the monitoring stack. For details, see [Monitoring a RisingWave cluster](/operate/monitor-risingwave-cluster).

## Optional: Resize a node

Expand All @@ -134,4 +134,4 @@ compactorComponent:
memory: 64Mi

```
Please note that increasing the CPU resource will not automatically increase the parallelism of existing materialized views. When scaling up (adding more CPU cores) a compute node, you should perform the scaling by following the instructions in [Cluster scaling](/docs/current/k8s-cluster-scaling/).
Please note that increasing the CPU resource will not automatically increase the parallelism of existing materialized views. When scaling up (adding more CPU cores) a compute node, you should perform the scaling by following the instructions in [Cluster scaling](/deploy/k8s-cluster-scaling).
4 changes: 2 additions & 2 deletions deploy/risingwave-kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ The Operator is a deployment and management system for RisingWave. It runs on to

* **[Install kubectl](http://pwittrock.github.io/docs/tasks/tools/install-kubectl/)**
Ensure that the Kubernetes command-line tool [kubectl](https://kubernetes.io/docs/reference/kubectl/) is installed in your environment.
* **[Install psql](/docs/current/install-psql-without-postgresql/)**
* **[Install psql](/deploy/install-psql-without-postgresql)**
Ensure that the PostgreSQL interactive terminal [psql](https://www.postgresql.org/docs/current/app-psql.html) is installed in your environment.
* **[Install and run Docker](https://docs.docker.com/get-docker/)**
Ensure that [Docker](https://docs.docker.com/desktop/) is installed in your environment and running.
* Ensure you allocate enough resources for the deployment. For details, see [Hardware requirements](/docs/current/hardware-requirements/).
* Ensure you allocate enough resources for the deployment. For details, see [Hardware requirements](/deploy/hardware-requirements).

## Create a Kubernetes cluster

Expand Down
4 changes: 2 additions & 2 deletions faq/faq-using-risingwave.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ mode: wide
<Accordion title="Why the memory usage is so high?">
Don't worry, this is by design. RisingWave uses memory for in-memory cache of streaming queries, such as data structures like hash tables, etc., to optimize streaming computation performance. By default, RisingWave will utilize all available memory (unless specifically configured through `RW_TOTAL_MEMORY_BYTES`/`--total-memory-bytes`). This is why setting memory limits is required in Kubernetes/Docker deployments.

During the instance running, RisingWave will keep memory usage below this limit. If you encounter unexpected issues like OOM (Out-of-memory), please refer to [Troubleshoot out-of-memory](/docs/current/troubleshoot-oom/) for assistance.
During the instance running, RisingWave will keep memory usage below this limit. If you encounter unexpected issues like OOM (Out-of-memory), please refer to [Troubleshoot out-of-memory](/troubleshoot/troubleshoot-oom) for assistance.
</Accordion>
<Accordion title="Why is the memory for compute nodes not fully utilized?">
As part of its design, RisingWave allocates part of the total memory in the compute node as reserved memory. This reserved memory is specifically set aside for system usage, such as the stack and code segment of processes, allocation overhead, and network buffer.
Expand Down Expand Up @@ -48,7 +48,7 @@ By continuously improving the reserved memory feature, we strive to offer a more
The execution time for the `CREATE MATERIALIZED VIEW` statement can vary based on several factors. Here are two common reasons:

1. **Backfilling of historical data**: RisingWave ensures consistent snapshots across materialized views (MVs). So when a new MV is created, it backfills all historical data from the upstream MV or tables and calculate them, which takes some time. And the created DDL statement will only end when the backfill ends. You can run `SHOW JOBS;` in SQL to check the DDL progress. If you want the create statement to not wait for the process to finish and not block the session, you can execute `SET BACKGROUND_DDL=true;` before running the `CREATE MATERIALIZED VIEW` statement. See details in [SET BACKGROUND\_DDL](/sql/commands/sql-set-background-ddl). But please notice that the newly created MV is still invisible in the catalog until the end of backfill when `BACKGROUND_DDL=true`.
2. **High cluster latency**: If the cluster experiences high latency, it may take longer to apply changes to the streaming graph. If the `Progress` in the `SHOW JOBS;` result stays at 0.0%, high latency could be the cause. See details in [Troubleshoot high latency](/docs/current/troubleshoot-high-latency/)
2. **High cluster latency**: If the cluster experiences high latency, it may take longer to apply changes to the streaming graph. If the `Progress` in the `SHOW JOBS;` result stays at 0.0%, high latency could be the cause. See details in [Troubleshoot high latency](/troubleshoot/troubleshoot-high-latency)
</Accordion>
<Accordion title="What consists of the memory usage and disk usage?">
Memory usage is divided into the following components:
Expand Down
6 changes: 3 additions & 3 deletions faq/risingwave-flink-comparison.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ We periodically update this article to keep up with the rapidly evolving landsca

## Summary

| Apache Flink | RisingWave | |
| | Apache Flink | RisingWave |
| :------------------------------- | :-------------------------------------------------------------------- | :------------------------------------------------------------------------- |
| Version | 1.17 | Latest version |
| License | Apache License 2.0 | Apache License 2.0 |
Expand Down Expand Up @@ -82,7 +82,7 @@ RisingWave is a SQL streaming database that offers PostgreSQL-style SQL to its u

Apache Flink is a programming framework that does not support any language clients. To use Apache Flink, users must either write Java/Scala/Python programs or use Flink’s own SQL client.

RisingWave is compatible with the PostgreSQL wire protocol and can work with the majority of PostgreSQL's client libraries. This means that RisingWave can communicate in any programming language that is supported by the [PostgreSQL driver](https://wiki.postgresql.org/wiki/Client%5FLibraries), such as [Java](/docs/current/java-client-libraries/), [Python](/docs/current/python-client-libraries/), and [Node.js](/docs/current/nodejs-client-libraries/). Additionally, users can interact with RisingWave using `psql`, the official PostgreSQL terminal.
RisingWave is compatible with the PostgreSQL wire protocol and can work with the majority of PostgreSQL's client libraries. This means that RisingWave can communicate in any programming language that is supported by the [PostgreSQL driver](https://wiki.postgresql.org/wiki/Client%5FLibraries), such as [Java](/client-libraries/java), [Python](/client-libraries/python), and [Node.js](/client-libraries/nodejs). Additionally, users can interact with RisingWave using `psql`, the official PostgreSQL terminal.

## State management

Expand Down Expand Up @@ -127,7 +127,7 @@ RisingWave differs from Apache Flink in that it was specifically designed for th

RisingWave can function as both a stream processing system and a database system. As a database system, it is compatible with PostgreSQL clients, making it a natural fit for the PostgreSQL ecosystem. Users can program in different languages such as Python, Java, and Node.js using existing libraries. Additionally, users can easily find tools that work with RisingWave, such as DBeaver.

For a complete list of RisingWave integrations, see [Integrations](/docs/current/rw-integration-summary/).
For a complete list of RisingWave integrations, check what's listed under [Integrations](/integrations/overview).

## Learning curve

Expand Down
Loading

0 comments on commit 0e5c509

Please sign in to comment.