Welcome

This documentation explains how to manage and use RioDB.
RioDB supports its own SQL-like language to manage the system, and users, define data input streams, windows, queries, automated actions, and more.
A previous knowledge of SQL is helpful but not required.

How to use these documentation?

Many pages will cover three mini sections: Access Rule, Syntax, and Example.

Access Rule: Explains what ROLE is required to perform the documented task. These ROLES are explained in the USERS section.
Syntax: Explains the composition of a certain command.
Example: Show a basic example. Some of these commands will not work if necessary pre-requisites aren’t there. For example, you cannot reset password for user ‘bob’ if user ‘bob’ hasn’t been created. You cannot query data from a window or stream if they haven’t been created.

Format

The left-side panel contains the topic navigation tree.

The right-side panel contains the table-of-contents for the current page, pointing to each heading in the page.

Important notes will appear in a “note box”

Sample code will appear in a "code box"

Terminology

The following terms are used extensively throughout the documentation:

Stream: An unbounded sequence of messages of the same topic. For example, bids on a stock market, or user clickstream from a web server.

Message: Each record received from the stream.

Field: A field in the message record, like BID, STOCK_SYMBOL, DATE, SOURCE_SYSTEM.

Value: The value of a field in a message. It can be a numeric value or not.

Window: A bounded sequence of messages from the stream, based on a pre-determined range.

Query: Instructions to check if data conditions are met, and prepare an output.

Output: A result, or action being pushed outside of RioDB.

Plugin: A piece of software that is loaded during runtime to perform a certain task. There are INPUT plugins, PARSER plugins and OUTPUT plugins.