diff --git a/README.md b/README.md index 6e941b2ce3..06fc5118ca 100644 --- a/README.md +++ b/README.md @@ -6,36 +6,90 @@

-[![codecov](https://codecov.io/gh/GrepTimeTeam/greptimedb/branch/main/graph/badge.svg?token=FITFDI3J3C)](https://codecov.io/gh/GrepTimeTeam/greptimedb) -[![GitHub Actions](https://github.com/GreptimeTeam/greptimedb/actions/workflows/develop.yml/badge.svg)](https://github.com/GreptimeTeam/greptimedb/actions/workflows/develop.yml) -[![License](https://img.shields.io/github/license/greptimeTeam/greptimedb)](https://github.com/greptimeTeam/greptimedb/blob/main/LICENSE) +

Cloud-scale, Fast and Efficient Time Series Database

+ +
+

+ GreptimeCloud | + User guide | + API Docs | + Roadmap 2024 +

+ + +Version + + +Releases + + +Docker Pulls + + +GitHub Actions + + +Codecov + + +License +
-[![Twitter](https://img.shields.io/badge/twitter-follow_us-1d9bf0.svg?style=for-the-badge)](https://twitter.com/greptime/) -[![LinkedIn](https://img.shields.io/badge/linkedin-connect_with_us-0a66c2.svg?style=for-the-badge)](https://www.linkedin.com/company/greptime/) -[![Slack](https://img.shields.io/badge/slack-GreptimeDB-0abd59?logo=slack&style=for-the-badge)](https://greptime.com/slack) + +Slack + + +Twitter + + +LinkedIn + +
-## What is GreptimeDB +## Introduction -GreptimeDB is an open-source time-series database focusing on efficiency, scalability, and analytical capabilities. -It's designed to work on infrastructure of the cloud era, and users benefit from its elasticity and commodity storage. +**GreptimeDB** is an open-source time-series database focusing on efficiency, scalability, and analytical capabilities. +Designed to work on infrastructure of the cloud era, GreptimeDB benefits users with its elasticity and commodity storage, offering a fast and cost-effective **alternative to InfluxDB** and a **long-term storage for Prometheus**. -Our core developers have been building time-series data platforms for years. Based on their best-practices, GreptimeDB is born to give you: +## Why GreptimeDB -* **Compatible with InfluxDB, Prometheus and more protocols**: Widely adopted database protocols and APIs, including MySQL, PostgreSQL, and Prometheus Remote Storage, etc. [Read more](https://docs.greptime.com/user-guide/clients/overview). -* **Easy horizontal scaling**: Seamless scalability from a standalone binary at edge to a robust, highly available distributed cluster in cloud, with a transparent experience for both developers and administrators. -* **Analyzing time-series data**: Native SQL and PromQL for queries, and Python scripting to facilitate complex analytical tasks. -* **Cloud-native distributed database**: Fully open-source distributed cluster architecture that harnesses the power of cloud-native elastic computing resources. -* **Performance and Cost-effective**: Flexible indexing capabilities and distributed, parallel-processing query engine, tackling high cardinality issues down. Optimized columnar layout for handling time-series data; compacted, compressed, and stored on various storage backends, particularly cloud object storage with 50x cost efficiency. +Our core developers have been building time-series data platforms for years. Based on our best-practices, GreptimeDB is born to give you: -## Quickstart with [GreptimePlay](https://greptime.com/playground) +* **Easy horizontal scaling** + + Seamless scalability from a standalone binary at edge to a robust, highly available distributed cluster in cloud, with a transparent experience for both developers and administrators. + +* **Analyzing time-series data** + + Query your time-series data with SQL and PromQL. Use Python scripts to facilitate complex analytical tasks. + +* **Cloud-native distributed database** + + Fully open-source distributed cluster architecture that harnesses the power of cloud-native elastic computing resources. + +* **Performance and Cost-effective** + + Flexible indexing capabilities and distributed, parallel-processing query engine, tackling high cardinality issues down. Optimized columnar layout for handling time-series data; compacted, compressed, and stored on various storage backends, particularly cloud object storage with 50x cost efficiency. + +* **Compatible with InfluxDB, Prometheus and more protocols** + + Widely adopted database protocols and APIs, including MySQL, PostgreSQL, and Prometheus Remote Storage, etc. [Read more](https://docs.greptime.com/user-guide/clients/overview). + +## Try GreptimeDB + +### 1. [GreptimePlay](https://greptime.com/playground) Try out the features of GreptimeDB right from your browser. -## Up & Running +### 2. [GreptimeCloud](https://console.greptime.cloud/) -The recommended way to install GreptimeDB is via Docker: +Start instantly with a free cluster. + +### 3. Docker Image + +To install GreptimeDB locally, the recommended way is via Docker: ```shell docker pull greptime/greptimedb @@ -44,32 +98,13 @@ docker pull greptime/greptimedb Start a GreptimeDB container with: ```shell -docker run -p 4000-4003:4000-4003 \ - -p 4242:4242 -v "$(pwd)/greptimedb:/tmp/greptimedb" \ - --name greptime --rm \ - greptime/greptimedb standalone start \ - --http-addr 0.0.0.0:4000 \ - --rpc-addr 0.0.0.0:4001 \ - --mysql-addr 0.0.0.0:4002 \ - --postgres-addr 0.0.0.0:4003 \ - --opentsdb-addr 0.0.0.0:4242 +docker run --rm --name greptime --net=host greptime/greptimedb standalone start ``` -Connect to the server and test: +Read more about [Installation](https://docs.greptime.com/getting-started/installation/overview) on docs. -```shell -curl -X POST -d 'sql=SELECT 42&format=csv' http://localhost:4000/v1/sql -``` +## Getting Started -You should get a reply as: - -``` -42 -``` - -Read more on docs: - -* [Installation](https://docs.greptime.com/getting-started/installation/overview) * [Quickstart](https://docs.greptime.com/getting-started/quick-start/overview) * [Write Data](https://docs.greptime.com/user-guide/clients/overview) * [Query Data](https://docs.greptime.com/user-guide/query-data/overview) @@ -95,11 +130,6 @@ Run a standalone server: cargo run -- standalone start ``` -## Documentation - -- [User guide](https://docs.greptime.com/user-guide/concepts/overview) -- [API docs](https://greptimedb.rs) - ## Extension ### Dashboard @@ -121,12 +151,9 @@ Our official Grafana dashboard is available at [grafana](grafana/README.md) dire ## Project Status -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. - -For future plans, check out [GreptimeDB roadmap](https://github.com/GreptimeTeam/greptimedb/issues/3412). +The current version has not yet reached General Availability version standards. +In line with our Greptime 2024 Roadmap, we plan to achieve a production-level +version with the update to v1.0 in August. [[Join Force]](https://github.com/GreptimeTeam/greptimedb/issues/3412) ## Community