The next-generation hybrid timeseries/analytics processing database in the cloud

   

 

What is GreptimeDB

GreptimeDB is an open-source time-series database with special focus on scalability, analytical capabilities and efficiency. It's designed to work on infrastructure of cloud era, and benefits from its elasticity and commodity storage.

The core developers of GreptimeDB have been building time-series data platform for years. Based on their best-practices, GreptimeDB is born to give you:

• A standalone binary that scales to highly-available distributed cluster, with transparent experience from user's perspective
• Columnar data layout optimised for time-series, compacted, compressed, stored on various storage backends
• Flexible index options, tackling high cardinality issues down
• Distributed parallel query execution, leveraging elastic computing resource
• Native SQL, and Python scripting for advanced analytical scenarios
• Widely adopted database protocols and APIs
• Extensible table engine architecture for extensive workloads

Getting Started

Prerequisite

To compile GreptimeDB from source, you'll need the following:

• Rust
• Protobuf

Rust

The easiest way to install Rust is to use rustup, which will check our rust-toolchain file and install correct Rust version for you.

Protobuf

protoc is required for compiling .proto files. protobuf is available from major package manager on macos and linux distributions. You can find an installation instructions here.

Build the Docker Image

docker build --network host -f docker/Dockerfile -t greptimedb .

Usage

Start in standalone mode

// Start datanode and frontend with default options.
cargo run  -- --log-level=debug standalone start

OR

// Start with `http-addr` option.
cargo run  -- --log-level=debug standalone start --http-addr=0.0.0.0:9999

OR

// Start with `mysql-addr` option.
cargo run  -- --log-level=debug standalone start --mysql-addr=0.0.0.0:9999

OR
// Start datanode with `log-dir` and `log-level` options.
cargo run  -- --log-dir=logs --log-level=debug standalone start --mysql-addr=0.0.0.0:4102

Start with config file:

cargo run -- --log-dir=logs --log-level=debug standalone start -c ./config/standalone.example.toml

Start datanode by running docker container:

docker run -p 3000:3000 \
-p 3001:3001 \
-p 3306:3306 \
greptimedb

SQL Operations

1. Connecting DB by mysql client:

   # The standalone instance listen on port 4002 by default.
   mysql -h 127.0.0.1 -P 4002
   

2. Create a database;

CREATE DATABASE hello_greptime;

2. Create table:

   CREATE TABLE hello_greptime.monitor (
     host STRING,
     ts TIMESTAMP,
     cpu DOUBLE DEFAULT 0,
     memory DOUBLE,
     TIME INDEX (ts),
     PRIMARY KEY(host)) ENGINE=mito WITH(regions=1);
   

3. Insert data:

   INSERT INTO hello_greptime.monitor(host, cpu, memory, ts) VALUES ('host1', 66.6, 1024, 1660897955000);
   INSERT INTO hello_greptime.monitor(host, cpu, memory, ts) VALUES ('host2', 77.7, 2048, 1660897956000);
   INSERT INTO hello_greptime.monitor(host, cpu, memory, ts) VALUES ('host3', 88.8, 4096, 1660897957000);
   

4. Query data:

   mysql> SELECT * FROM hello_greptime.monitor;
   +-------+---------------------+------+--------+
   | host  | ts                  | cpu  | memory |
   +-------+---------------------+------+--------+
   | host1 | 2022-08-19 08:32:35 | 66.6 |   1024 |
   | host2 | 2022-08-19 08:32:36 | 77.7 |   2048 |
   | host3 | 2022-08-19 08:32:37 | 88.8 |   4096 |
   +-------+---------------------+------+--------+
   3 rows in set (0.01 sec)
   

   You can delete your data by removing /tmp/greptimedb.

Community

The core team will be thrilled if you participate in any way you like. When you are stuck, try asking for help by filing an issue with a detailed description of what you were trying to do and what went wrong. If you have any questions or if you would like to get involved in our community, please check out:

• GreptimeDB Community on Slack
• GreptimeDB GitHub Discussions
• Greptime official Website

In addition, you may:

• View our official Blog
• Connect us with Linkedin
• Follow us on Twitter

Documentation

• GreptimeDB User Guide
• GreptimeDB Developer Guide

License

GreptimeDB uses the Apache 2.0 license to strike a balance between open contributions and allowing you to use the software however you want.

Contributing

Please refer to contribution guidelines for more information.