huangzhengshun / greptimedb Goto Github PK

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

Our core developers 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, providing a transparent experience for cluster users
• Optimized columnar layout for handling time-series data; 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

To compile GreptimeDB from source, you'll need:

• C/C++ Toolchain: provides basic tools for compiling and linking. This is available as build-essential on ubuntu and similar name on other platforms.
• 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. Note that protoc version needs to be >= 3.15 because we have used the optional keyword. You can check it with protoc --version.

A docker image with necessary dependencies is provided:

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

Start GreptimeDB from source code, in standalone mode:

cargo run -- standalone start

Or if you built from docker:

docker run -p 4002:4002 -v "$(pwd):/tmp/greptimedb" greptime/greptimedb standalone start

For more startup options, greptimedb's distributed mode and information about Kubernetes deployment, check our docs.

1. Connect to GreptimeDB via standard MySQL client:

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

2. Create table:

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

3. Insert some data:

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

4. Query the data:

   SELECT * FROM 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 always cleanup test database by removing /tmp/greptimedb.

• Pre-built Binaries: downloadable pre-built binaries for Linux and MacOS
• Docker Images: pre-built Docker images
• gtctl: the command-line tool for Kubernetes deployment

• GreptimeDB User Guide
• GreptimeDB Developer Guide

• GreptimeDB Java Client

This project is in its early stage and under heavy development. We move fast and break things. Benchmark on development branch may not represent its potential performance. We release pre-built binaries constantly for functional evaluation. Do not use it in production at the moment.

Our core team is thrilled too see you participate in any ways you like. When you are stuck, try to ask for help by filling 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

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

Please refer to contribution guidelines for more information.

• GreptimeDB uses Apache Arrow as the memory model and Apache Parquet as the persistent file format.
• GreptimeDB's query engine is powered by Apache Arrow DataFusion.
• OpenDAL from Datafuse Labs gives GreptimeDB a very general and elegant data access abstraction layer.
• GreptimeDB’s meta service is based on etcd.
• GreptimeDB uses RustPython for experimental embedded python scripting.