Quick Install

Installation Mode

RisingWave has the following installation modes:

• Single-node Playground Mode (Official Doc): If you just want to learn how to use RisingWave, then the single-node playground mode should meet basic needs. However, this mode does not support some complex features, such as Change Data Capture (CDC).

• Single-node Docker Compose Mode (Official Doc): Single-node Docker deployment mode is feature-rich, but if you plan to use it in a production environment, think twice. After all, if the physical machine crashes, it will directly lead to system unavailability or data loss.

• Kubernetes Cluster Deployment Mode (Official Doc): Kubernetes cluster deployment mode is the most recommended deployment mode for production environments.

RisingWave Cloud

Not everyone is willing to install systems locally. If you prefer not to install, that's fine, you can also use the free tier of RisingWave Cloud directly. This is the most convenient way to use RisingWave without installation, and it takes only 5 minutes to get a feature-rich cluster ready.

	Time	Feature Set	Production Use?
Single-node Playground	5 minutes	Limited features	No
Single-node Docker Compose	10-20 minutes	Feature-rich	Yes, but think twice
Kubernetes Cluster Deployment	May vary	Feature-rich	Yes (recommended)
RisingWave Cloud	5 minutes	Feature-rich	Yes (recommended)

Install Playground

Since the purpose of this tutorial is to let everyone understand and use RisingWave, we choose the single-node playground mode. The entire installation process takes only 5 minutes. Note that this mode operates purely in memory and will automatically stop after being idle for 30 minutes.

Download

Mac

brew tap risingwavelabs/risingwave
brew install risingwave
risingwave playground

Ubuntu

wget https://github.com/risingwavelabs/risingwave/releases/download/v1.3.0/risingwave-v1.3.0-x86_64-unknown-linux.tar.gz
tar xvf risingwave-v1.3.0-x86_64-unknown-linux.tar.gz
./risingwave playground

Docker

docker run -it --pull=always -p 4566:4566 -p 5691:5691 risingwavelabs/risingwave:latest playground

Start service

./risingwave playground

Now, RisingWave has started running.

Connect via psql

psql -h localhost -p 4566 -d dev -U root

psql is the official command-line client for PostgreSQL. The following command can be used for installation:

sudo apt update
sudo apt install postgresql-client

Verification

We create a table and a materialized view to see if RisingWave is running normally.

create table t(v1 int, v2 int);
insert into t values(1,10),(2,20),(3,30);
create materialized view mv as select sum(v1) from t;

Then we query the created materialized view:

select * from mv;

We should see:

 sum
-----
   6
(1 row)

Then we insert two rows of data:

insert into t values(4,40),(5,50);

Then query the materialized view:

select * from mv;

The result should have already been updated:

 sum
-----
  15
(1 row)

The above is the simplest program to verify whether RisingWave runs correctly. Users should always be able to see the latest results with consistency guarantees in the materialized view.