Quickstart with Docker

    Installation

    TIP

    If you have already installed docker, you can skip this step.

    See , and install it for your operating system. Please carefully check that you have met all prerequisites.

    Confirm that the Docker daemon is running:

    TIP

    On Linux, Docker needs root privileges. You can also run Docker as a non-root user, see Post-installation steps for LinuxQuickstart with Docker - 图2 (opens new window).

    TIP

    If you have already installed docker compose, you can skip this step.

    See , and install it for your operating system. Please carefully check that you met all prerequisites.

    Start a local standalone HStream-Server in Docker

    WARING

    Do NOT use this configuration in your production environment!

    Create a directory for storing db datas

    1. mkdir /data/store

    If you are a non-root user, that you can not create directory under the root.

    You can create it anywhere as you can.

    1. mkdir $HOME/data/store
    3. # make sure that you have set the environment variable DATA_DIR
    4. export DATA_DIR=$HOME/data/store

    Create a docker-compose.yaml file for docker compose, you can downloadQuickstart with Docker - 图4 (opens new window) or paste the following contents:

    1. ## docker-compose.yaml
    3. version: "3.5"
    5. services:
    6.   hserver:
    7.     image: hstreamdb/hstream:v0.6.1
    8.     depends_on:
    9.       - zookeeper
    10.       - hstore
    11.     ports:
    12.       - "127.0.0.1:6570:6570"
    13.     expose:
    14.       - 6570
    15.     networks:
    16.       - hstream-quickstart
    17.     volumes:
    18.       - ${DATA_DIR:-/data/store}:/data/store
    19.     command: &start_hserver
    20.       - bash
    21.       - "-c"
    22.       - |
    23.         set -e
    24.         /usr/local/script/wait-for-storage.sh hstore 6440 zookeeper 2181 600 \
    25.         /usr/local/bin/hstream-server \
    26.         --host 0.0.0.0 --port 6570 \
    27.         --internal-port 6571 \
    28.         --address $$(hostname -I | awk '{print $$1}') \
    29.         --server-id 100 \
    30.         --zkuri zookeeper:2181 \
    31.         --store-config /data/store/logdevice.conf \
    32.         --store-admin-host hstore --store-admin-port 6440 \
    33.         --replicate-factor 3 \
    35.   hstream-http-server:
    36.     image: hstreamdb/hstream:v0.6.1
    37.     depends_on:
    38.       - hserver
    39.     ports:
    40.       - "127.0.0.1:6580:6580"
    41.     expose:
    42.       - 6580
    43.     networks:
    44.       - hstream-quickstart
    45.       - bash
    46.       - "-c"
    47.       - |
    48.         set -e
    49.         /usr/local/bin/hstream-http-server \
    50.           -gRPCServerHost hserver \
    51.           -httpServerPort 6580 \
    52.           -gRPCServerPort 6570
    54.   hstore:
    55.     image: hstreamdb/hstream:v0.6.1
    57.       - hstream-quickstart
    58.     volumes:
    59.       - ${DATA_DIR:-/data/store}:/data/store
    60.     command:
    61.       - bash
    62.       - "-c"
    63.       - |
    64.         set -ex
    65.         /usr/local/bin/ld-dev-cluster --root /data/store \
    66.         --use-tcp --tcp-host $$(hostname -I | awk '{print $$1}') \
    67.         --user-admin-port 6440 \
    68.         --no-interactive
    70.   zookeeper:
    71.     image: zookeeper
    72.     expose:
    73.       - 2181
    74.     networks:
    75.       - hstream-quickstart
    77. networks:
    78.   hstream-quickstart:
    79.     name: hstream-quickstart

    then run:

    1. docker-compose -f quick-start.yaml up

    If you see some thing like this, then you have a running hstream:

    1. hserver_1    | [INFO][2021-11-22T09:15:18+0000][app/server.hs:137:3][thread#67]************************
    2. hserver_1    | [INFO][2021-11-22T09:15:18+0000][app/server.hs:145:3][thread#67]Server started on port 6570
    3. hserver_1    | [INFO][2021-11-22T09:15:18+0000][app/server.hs:146:3][thread#67]*************************

    TIP

    You can also run in background.

    And if you want to show logs of server, run:

    1. docker-compose -f quick-start.yaml logs -f hserver

    Start HStreamDB’s interactive SQL CLI

    1. docker run -it --rm --name some-hstream-cli --network host hstreamdb/hstream hstream-client --port 6570 --client-id 1

    If everything works fine, you will enter an interactive CLI and see help information like

    1.       __  _________________  _________    __  ___
    2.      / / / / ___/_  __/ __ \/ ____/   |  /  |/  /
    3.     / /_/ /\__ \ / / / /_/ / __/ / /| | / /|_/ /
    4.    / __  /___/ // / / _, _/ /___/ ___ |/ /  / /
    5.   /_/ /_//____//_/ /_/ |_/_____/_/  |_/_/  /_/
    7. Command
    8.   :h                           To show these help info
    9.   :q                           To exit command line interface
    10.   :help [sql_operation]        To show full usage of sql statement
    12. SQL STATEMENTS:
    13.   To create a simplest stream:
    14.     CREATE STREAM stream_name;
    16.   To create a query select all fields from a stream:
    17.     SELECT * FROM stream_name EMIT CHANGES;
    19.   To insert values to a stream:
    20.     INSERT INTO stream_name (field1, field2) VALUES (1, 2);
    22. >

    Create a stream

    What we are going to do first is create a stream by CREATE STREAM statement.

    1. CREATE STREAM demo;

    Run a continuous query over the stream

    Now we can run a continuous query over the stream we just created by SELECT query.

    1. SELECT * FROM demo WHERE humidity > 70 EMIT CHANGES;

    It seems that nothing happened. But do not worry because there is no data in the stream now. Next, we will fill the stream with some data so the query can produce output we want.

    Start another CLI session, this CLI will be used for inserting data into the stream.

    1. docker exec -it some-hstream-cli hstream-client --port 6570 --client-id 2

    Insert data into the stream

    Run each of the given INSERT statement in the new CLI session and keep an eye on the CLI session created in (2).

    If everything works fine, the continuous query will output matching records in real time:

    1. {"temperature":31,"humidity":76}
    2. {"temperature":27,"humidity":82}

    Start a 3-node local HStream-Server Cluster in Docker

    WARING

    Do NOT use this configuration in your production environment!

    If you did not follow quick start and have not yet got a running local HStream-Server, read this section instead.

    You can manually start the other 2 servers and pass the same zkuri as the running server to create a hserver cluster. Note that every server needs the following options to be unique to work properly:

    • server-id : the id has to be an integer. This is the identifier of every server.
    • port : the port number that client connects to.
    • internal-port : the internal channel for server communication.

    For example, run the following commands to start a cluster with 3 nodes, only if you followed quick start and did not change the :

    1. docker run -it --rm --name some-hstream-server-1 -v $DATA_DIR:/data/store --network hstream-quickstart hstreamdb/hstream hstream-server --store-config /data/store/logdevice.conf --zkuri 127.0.0.1:2181 --port 6580 --internal-port 6581 --server-id 101
    1. docker run -it --rm --name some-hstream-server-2 -v $DATA_DIR:/data/store --network hstream-quickstart hstreamdb/hstream hstream-server --store-config /data/store/logdevice.conf --zkuri 127.0.0.1:2181 --port 6590 --internal-port 6591 --server-id 102

    Download quick-start.yamlQuickstart with Docker - 图6 (opens new window) and copy the exact following contents under services section:

    1.   hserver0:
    2.     image: hstreamdb/hstream
    3.     depends_on:
    4.       - zookeeper
    5.       - hstore
    6.     ports:
    7.       - "127.0.0.1:6580:6580"
    8.     expose:
    9.       - 6580
    10.     networks:
    11.       - hstream-quickstart
    12.     volumes:
    13.       - ${DATA_DIR:-/data/store}:/data/store
    14.     command:
    15.       - bash
    16.       - "-c"
    17.       - |
    18.         set -e
    19.         /usr/local/script/wait-for-storage.sh hstore 6440 zookeeper 2181 600 \
    20.         /usr/local/bin/hstream-server \
    21.         --host 0.0.0.0 --port 6590 \
    22.         --internal-port 6591 \
    23.         --address $$(hostname -I | awk '{print $$1}') \
    24.         --server-id 101 \
    25.         --zkuri zookeeper:2181 \
    26.         --store-config /data/store/logdevice.conf \
    27.         --store-admin-host hstore --store-admin-port 6440 \
    28.         --replicate-factor 3 \
    30.   hserver1:
    31.     image: hstreamdb/hstream
    32.     depends_on:
    33.       - zookeeper
    34.       - hstore
    35.     ports:
    36.       - "127.0.0.1:6590:6590"
    37.     expose:
    38.       - 6590
    39.     networks:
    40.       - hstream-quickstart
    41.     volumes:
    42.       - ${DATA_DIR:-/data/store}:/data/store
    43.     command:
    44.       - bash
    45.       - "-c"
    46.       - |
    47.         set -e
    48.         /usr/local/script/wait-for-storage.sh hstore 6440 zookeeper 2181 600 \
    49.         /usr/local/bin/hstream-server \
    50.         --host 0.0.0.0 --port 6590 \
    51.         --internal-port 6591 \
    52.         --address $$(hostname -I | awk '{print $$1}') \
    53.         --server-id 102 \
    54.         --zkuri zookeeper:2181 \
    55.         --store-config /data/store/logdevice.conf \
    56.         --store-admin-host hstore --store-admin-port 6440 \
    57.         --replicate-factor 3 \

    You can easily get a cluster with:

    1. docker-compose -f quick-start.yaml up -d

    Use HStreamDB’s interactive SQL CLI