# Streams management

The Kuiper stream command line tools allows you to manage the streams, such as create, describe, show and drop stream definitions.

# create a stream

The command is used for creating a stream. For more detailed information of stream definition, please refer to streams.

create stream $stream_name $stream_def | create stream -f $stream_def_file
1
  • Specify the stream definition in command line.

Sample:

# bin/kuiper create stream my_stream '(id bigint, name string, score float) WITH ( datasource = "topic/temperature", FORMAT = "json", KEY = "id");'
stream my_stream created
1
2

The command create a stream named my_stream.

  • Specify the stream definition in file. If the stream is complex, or the stream is already wrote in text files with well organized formats, you can just specify the stream definition through -f option.

Sample:

# bin/kuiper create stream -f /tmp/my_stream.txt
stream my_stream created
1
2

Below is the contents of my_stream.txt.

my_stream(id bigint, name string, score float)
    WITH ( datasource = "topic/temperature", FORMAT = "json", KEY = "id");
1
2

# show streams

The command is used for displaying all of streams defined in the server.

show streams
1

Sample:

# bin/kuiper show streams
my_stream
1
2

# describe a stream

The command is used for print the detailed definition of stream.

describe stream $stream_name
1

Sample:

# bin/kuiper describe stream my_stream
Fields
--------------------------------------------------------------------------------
id	bigint
name	string
score	float

FORMAT: json
KEY: id
DATASOURCE: topic/temperature
1
2
3
4
5
6
7
8
9
10

# drop a stream

The command is used for drop the stream definition.

drop stream $stream_name
1

Sample:

# bin/kuiper drop stream my_stream
stream my_stream dropped
1
2

# query against streams

The command is used for querying data from stream.

query
1

Sample:

# bin/kuiper query
kuiper > 
1
2

After typing query sub-command, it prompts kuiper >, then type SQLs (see Kuiper SQL reference for how to use Kuiper SQL) in the command prompt and press enter.

The results will be print in the console.

kuiper > SELECT * FROM my_stream WHERE id > 10;
[{"...":"..." ....}]
...
1
2
3
  • Press CTRL + C to stop the query;

  • If no SQL are type, you can type quit or exit to quit the kuiper prompt console.