mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-10-14 07:52:34 +00:00
208 lines
26 KiB
HTML
208 lines
26 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A columnar database for metrics, logs, and traces on object storage. Apache-2.0 licensed core."><title>greptime - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="greptime" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../static.files/storage-41dd4d93.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-417ebf0a.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Crate greptime</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../greptime/index.html">greptime</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#introduction" title="Introduction">Introduction</a></li><li><a href="#one-query-across-signals" title="One Query Across Signals">One Query Across Signals</a></li><li><a href="#why-you-might-use-it" title="Why You Might Use It">Why You Might Use It</a></li><li><a href="#whats-supported" title="What’s Supported">What’s Supported</a></li><li><a href="#benchmarks" title="Benchmarks">Benchmarks</a></li><li><a href="#compatibility-and-migration" title="Compatibility and Migration">Compatibility and Migration</a></li><li><a href="#limitations-and-edition-boundary" title="Limitations and Edition Boundary">Limitations and Edition Boundary</a></li><li><a href="#architecture" title="Architecture">Architecture</a></li><li><a href="#try-greptimedb" title="Try GreptimeDB">Try GreptimeDB</a></li><li><a href="#getting-started" title="Getting Started">Getting Started</a></li><li><a href="#build-from-source" title="Build From Source">Build From Source</a></li><li><a href="#tools--extensions" title="Tools & Extensions">Tools & Extensions</a></li><li><a href="#project-status" title="Project Status">Project Status</a></li><li><a href="#community" title="Community">Community</a></li><li><a href="#license" title="License">License</a></li><li><a href="#commercial-support" title="Commercial Support">Commercial Support</a></li><li><a href="#contributing" title="Contributing">Contributing</a></li><li><a href="#acknowledgement" title="Acknowledgement">Acknowledgement</a></li></ul><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#statics" title="Statics">Statics</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1>Crate <span>greptime</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/greptime/greptime.rs.html#15-213">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p align="center">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: light)" srcset="https://cdn.jsdelivr.net/gh/GreptimeTeam/greptimedb@main/docs/logo-text-padding.png">
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://cdn.jsdelivr.net/gh/GreptimeTeam/greptimedb@main/docs/logo-text-padding-dark.png">
|
||
<img alt="GreptimeDB Logo" src="https://cdn.jsdelivr.net/gh/GreptimeTeam/greptimedb@main/docs/logo-text-padding.png" width="400px">
|
||
</picture>
|
||
</p>
|
||
<h2 align="center">Metrics, logs, and traces.<br/>
|
||
One engine, on your infrastructure.</h2>
|
||
<blockquote>
|
||
<p>A columnar database for metrics, logs, and traces on object storage.
|
||
Apache-2.0 licensed core.</p>
|
||
</blockquote>
|
||
<div align="center">
|
||
<p><a href="https://docs.greptime.com/user-guide/overview/">User Guide</a> ·
|
||
<a href="https://greptimedb.rs/">API Docs</a> ·
|
||
<a href="https://github.com/GreptimeTeam/greptimedb/issues/7685">Roadmap 2026</a> ·
|
||
<a href="https://greptime.com/slack">Slack</a></p>
|
||
<p><a href="https://github.com/GreptimeTeam/greptimedb/releases/latest"><img src="https://img.shields.io/github/v/release/GreptimeTeam/greptimedb?filter=!*-*&sort=semver&label=stable&color=brightgreen" alt="Stable"/></a>
|
||
<a href="https://github.com/GreptimeTeam/greptimedb/releases"><img src="https://img.shields.io/github/v/release/GreptimeTeam/greptimedb?include_prereleases&filter=!*-*-*&sort=semver&label=canary&color=blueviolet" alt="Canary"/></a>
|
||
<a href="https://github.com/GreptimeTeam/greptimedb/releases"><img src="https://img.shields.io/github/v/release/GreptimeTeam/greptimedb?include_prereleases&filter=*-nightly-*&label=nightly&color=orange" alt="Nightly"/></a>
|
||
<a href="https://hub.docker.com/r/greptime/greptimedb/"><img src="https://img.shields.io/docker/pulls/greptime/greptimedb.svg" alt="Docker Pulls"/></a>
|
||
<a href="https://github.com/GreptimeTeam/greptimedb/blob/main/LICENSE"><img src="https://img.shields.io/github/license/GreptimeTeam/greptimedb" alt="License"/></a></p>
|
||
<p><sub><b>stable</b> for production · <b>canary</b> includes pre-releases · <b>nightly</b> is a weekly snapshot of <code>main</code></sub></p>
|
||
</div>
|
||
<h3 id="introduction"><a class="doc-anchor" href="#introduction">§</a>Introduction</h3>
|
||
<p><strong>GreptimeDB</strong> is an open-source observability database. Metrics, logs, and traces run on one columnar engine over object storage and share one <a href="https://docs.greptime.com/user-guide/concepts/data-model/">table model</a>: tags, timestamp, and fields. When signals carry common identifiers such as service, host, or trace ID, you can correlate them in SQL without moving data between databases.</p>
|
||
<p>Ingest through OpenTelemetry, Prometheus Remote Write, Loki Push, or Elasticsearch Bulk. Use SQL across observability data and PromQL for metrics. Migrate ingestion one signal at a time without rebuilding your collectors.</p>
|
||
<h3 id="one-query-across-signals"><a class="doc-anchor" href="#one-query-across-signals">§</a>One Query Across Signals</h3>
|
||
<p>OpenTelemetry ingestion writes spans to <code>opentelemetry_traces</code> and log records to
|
||
<code>opentelemetry_logs</code>. Both tables carry <code>trace_id</code>, so correlating them is a join:</p>
|
||
<div class="example-wrap"><pre class="language-sql"><code>-- The slowest failed spans in the last hour,
|
||
-- with the log lines emitted inside those same traces.
|
||
SELECT
|
||
t.service_name,
|
||
t.span_name,
|
||
t.duration_nano / 1000000 AS duration_ms,
|
||
l.timestamp AS log_time,
|
||
l.severity_text,
|
||
l.body
|
||
FROM opentelemetry_traces t
|
||
JOIN opentelemetry_logs l ON l.trace_id = t.trace_id
|
||
WHERE t.timestamp > now() - INTERVAL '1' HOUR
|
||
AND t.span_status_code = 'STATUS_CODE_ERROR'
|
||
ORDER BY t.duration_nano DESC
|
||
LIMIT 20;</code></pre></div>
|
||
<p>Metrics join the same way, on any tag the tables share, such as <code>service</code>,
|
||
<code>host</code>, or <code>pod</code>.</p>
|
||
<h3 id="why-you-might-use-it"><a class="doc-anchor" href="#why-you-might-use-it">§</a>Why You Might Use It</h3>
|
||
<ul>
|
||
<li>You run Prometheus plus Loki or Elasticsearch and want one backend instead of three</li>
|
||
<li>You have outgrown Prometheus on cardinality or retention and don’t want the Thanos/Mimir operational surface</li>
|
||
<li>You are hitting Loki’s query performance limits as log volume grows</li>
|
||
<li>You need long retention on object storage without a separate analytics stack</li>
|
||
<li>You want to query telemetry with SQL, not only a domain query language</li>
|
||
<li>You are storing GenAI or agent telemetry (<a href="https://opentelemetry.io/docs/specs/semconv/gen-ai/">OTel GenAI conventions</a>) alongside infrastructure signals</li>
|
||
</ul>
|
||
<p>Learn more in <a href="https://docs.greptime.com/user-guide/concepts/why-greptimedb">Why GreptimeDB</a>.</p>
|
||
<h3 id="whats-supported"><a class="doc-anchor" href="#whats-supported">§</a>What’s Supported</h3><div><table><thead><tr><th></th><th></th></tr></thead><tbody>
|
||
<tr><td><strong>Ingest</strong></td><td><a href="https://docs.greptime.com/user-guide/ingest-data/for-observability/opentelemetry/">OpenTelemetry (OTLP)</a>, <a href="https://docs.greptime.com/user-guide/ingest-data/for-observability/prometheus/">Prometheus Remote Write</a>, <a href="https://docs.greptime.com/user-guide/ingest-data/for-observability/loki">Loki Push</a>, <a href="https://docs.greptime.com/user-guide/ingest-data/for-observability/elasticsearch">Elasticsearch Bulk</a>, <a href="https://docs.greptime.com/user-guide/protocols/influxdb-line-protocol">InfluxDB line protocol</a>, <a href="https://docs.greptime.com/user-guide/protocols/grpc/">gRPC</a></td></tr>
|
||
<tr><td><strong>Query</strong></td><td><a href="https://docs.greptime.com/user-guide/query-data/overview/">SQL</a>, <a href="https://docs.greptime.com/user-guide/query-data/promql/">PromQL</a>, <a href="https://docs.greptime.com/user-guide/query-data/jaeger/">Jaeger-compatible trace queries</a>, MySQL and PostgreSQL wire protocols</td></tr>
|
||
<tr><td><strong>Storage</strong></td><td>S3, GCS, Azure Blob and S3-compatible endpoints as <a href="https://docs.greptime.com/user-guide/deployments-administration/configuration/#storage-options">primary storage</a>, with memory and local-disk caches</td></tr>
|
||
<tr><td><strong>Built in</strong></td><td>Retention policies, downsampling, <a href="https://docs.greptime.com/user-guide/flow-computation/overview">continuous aggregation</a>, explicit table partitioning, and <a href="https://docs.greptime.com/user-guide/manage-data/data-index">inverted / skipping / fulltext indexes</a></td></tr>
|
||
</tbody></table>
|
||
</div>
|
||
<p>Compute and storage are disaggregated: object storage holds the data, while memory and local-disk caches keep recent and frequently queried data close to compute.</p>
|
||
<p align="center">
|
||
<a href="https://github.com/GreptimeTeam/greptimedb/raw/main/docs/overview.png" target="_blank" rel="noopener">
|
||
<img alt="GreptimeDB Overview" src="docs/overview.png" width="900px">
|
||
</a>
|
||
</p>
|
||
<h3 id="benchmarks"><a class="doc-anchor" href="#benchmarks">§</a>Benchmarks</h3>
|
||
<ul>
|
||
<li><a href="https://rca-bench.greptime.com/">Agent RCA Bench</a>: LLM agents doing root cause analysis
|
||
over GreptimeDB versus Prometheus + Loki + Tempo. 40% fewer wrong diagnoses, 48% fewer
|
||
input tokens, 45% lower cost
|
||
(<a href="https://greptime.com/blogs/2026-09-08-agent-rca-bench-interface-semantic-layer">write-up</a>)</li>
|
||
<li><a href="https://greptime.com/blogs/2025-03-18-jsonbench-greptimedb-performance">GreptimeDB tops JSONBench’s billion-record cold run test</a></li>
|
||
<li><a href="https://github.com/GreptimeTeam/greptimedb/tree/main/docs/benchmarks/tsbs">TSBS Benchmark</a></li>
|
||
<li><a href="https://docs.greptime.com/user-guide/concepts/features-that-you-concern#how-is-greptimedbs-performance-compared-to-other-solutions">More benchmark reports</a></li>
|
||
</ul>
|
||
<h3 id="compatibility-and-migration"><a class="doc-anchor" href="#compatibility-and-migration">§</a>Compatibility and Migration</h3>
|
||
<p>Compatibility is per protocol, and query-side coverage is narrower than ingestion.</p>
|
||
<div><table><thead><tr><th></th><th>Compatible</th><th>Not compatible</th></tr></thead><tbody>
|
||
<tr><td><strong>Prometheus</strong></td><td>Remote Write ingestion; PromQL queries</td><td>Gaps are listed in <a href="https://docs.greptime.com/user-guide/query-data/promql/">PromQL compatibility</a></td></tr>
|
||
<tr><td><strong>Loki</strong></td><td>Push ingestion; dual-write through Grafana Alloy makes the <a href="https://greptime.com/blogs/2026-07-23-from-loki-to-greptimedb-dual-write-migration">cutover gradual</a></td><td>LogQL and the rest of the Loki query API</td></tr>
|
||
<tr><td><strong>Elasticsearch</strong></td><td><code>_bulk</code> ingestion in the open-source core; <a href="https://docs.greptime.com/enterprise/elasticsearch-compatible/query/">QueryDSL</a> partially, in Enterprise</td><td>Most other Elasticsearch APIs</td></tr>
|
||
</tbody></table>
|
||
</div><h3 id="limitations-and-edition-boundary"><a class="doc-anchor" href="#limitations-and-edition-boundary">§</a>Limitations and Edition Boundary</h3>
|
||
<p>Cluster deployment, object storage, the Flow engine, and every ingestion protocol listed above are in the Apache-2.0 build. Repartitioning, region migration, and index creation are manual operations there.</p>
|
||
<p>Read replicas, workload isolation, and automated repartitioning are <strong>GreptimeDB Enterprise</strong> features, along with enterprise security and governance. The <a href="https://docs.greptime.com/enterprise/overview/">Enterprise overview</a> has the current list, and <a href="https://www.greptime.com/pricing#differences">pricing</a> has the edition comparison.</p>
|
||
<h3 id="architecture"><a class="doc-anchor" href="#architecture">§</a>Architecture</h3>
|
||
<p>GreptimeDB can run in two modes:</p>
|
||
<ul>
|
||
<li><strong>Standalone</strong> — single binary for development and small deployments.</li>
|
||
<li><strong>Distributed</strong> — four components, each independently scalable:
|
||
<ul>
|
||
<li><strong>Frontend</strong> — protocol entry (OTel, Prometheus, MySQL/PostgreSQL, gRPC, ingestion APIs for Elasticsearch/InfluxDB/Loki) and the distributed query engine. Stateless, scales horizontally.</li>
|
||
<li><strong>Datanode</strong> — region engine with WAL, memtable, SST, cache, compaction, and indexes. Persists data to object storage. Elastic.</li>
|
||
<li><strong>Metasrv</strong> — metadata, routing, repartitioning, and security. Backed by a pluggable KV layer (etcd or RDS).</li>
|
||
<li><strong>Flownode</strong> (optional) — continuous flow computation (streaming and materialized views).</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p>For deeper coverage, see the <a href="https://docs.greptime.com/contributor-guide/overview/#architecture">architecture doc</a> or <a href="https://deepwiki.com/GreptimeTeam/greptimedb/1-overview">DeepWiki</a>.</p>
|
||
<a href="https://github.com/GreptimeTeam/greptimedb/raw/main/docs/architecture.png" target="_blank" rel="noopener">
|
||
<img alt="GreptimeDB System Overview" src="https://cdn.jsdelivr.net/gh/GreptimeTeam/greptimedb@main/docs/architecture.png">
|
||
</a>
|
||
<h3 id="try-greptimedb"><a class="doc-anchor" href="#try-greptimedb">§</a>Try GreptimeDB</h3>
|
||
<p><strong>For AI agents</strong> — paste this prompt into your agent:</p>
|
||
<div class="example-wrap"><pre class="language-text"><code>Read https://docs.greptime.com/SKILL.md and follow the instructions
|
||
to deploy, configure, ingest, and query GreptimeDB.</code></pre></div><div class="example-wrap"><pre class="language-shell"><code>docker run -p 127.0.0.1:4000-4003:4000-4003 \
|
||
-v "$(pwd)/greptimedb_data:/greptimedb_data" \
|
||
--name greptime --rm \
|
||
greptime/greptimedb:latest standalone start \
|
||
--http-addr 0.0.0.0:4000 \
|
||
--grpc-bind-addr 0.0.0.0:4001 \
|
||
--mysql-addr 0.0.0.0:4002 \
|
||
--postgres-addr 0.0.0.0:4003</code></pre></div>
|
||
<p>Dashboard: <a href="http://localhost:4000/dashboard">http://localhost:4000/dashboard</a></p>
|
||
<p>Read more in the <a href="https://docs.greptime.com/getting-started/installation/overview">full Install Guide</a>.</p>
|
||
<p><strong>Troubleshooting:</strong></p>
|
||
<ul>
|
||
<li>Cannot connect to the database? Ensure that ports <code>4000</code>, <code>4001</code>, <code>4002</code>, and <code>4003</code> are not blocked by a firewall or used by other services.</li>
|
||
<li>Failed to start? Check the container logs with <code>docker logs greptime</code> for further details.</li>
|
||
</ul>
|
||
<h3 id="getting-started"><a class="doc-anchor" href="#getting-started">§</a>Getting Started</h3>
|
||
<ul>
|
||
<li><a href="https://docs.greptime.com/getting-started/quick-start">Quickstart</a></li>
|
||
<li><a href="https://docs.greptime.com/user-guide/overview">User Guide</a></li>
|
||
<li><a href="https://github.com/GreptimeTeam/demo-scene">Demo Scenes</a></li>
|
||
<li><a href="https://docs.greptime.com/faq-and-others/faq">FAQ</a></li>
|
||
</ul>
|
||
<h3 id="build-from-source"><a class="doc-anchor" href="#build-from-source">§</a>Build From Source</h3>
|
||
<p><strong>Prerequisites:</strong></p>
|
||
<ul>
|
||
<li><a href="https://www.rust-lang.org/tools/install">Rust toolchain</a> — stable, pinned by <a href="https://github.com/GreptimeTeam/greptimedb/blob/main/rust-toolchain.toml"><code>rust-toolchain.toml</code></a></li>
|
||
<li><a href="https://grpc.io/docs/protoc-installation/">Protobuf compiler</a> (>= 3.15)</li>
|
||
<li>C/C++ building essentials: <code>gcc</code> / <code>g++</code> / <code>autoconf</code> and the glibc dev package (<code>libc6-dev</code> on Ubuntu, <code>glibc-devel</code> on Fedora)</li>
|
||
<li>Python toolchain (optional, only for some test scripts)</li>
|
||
</ul>
|
||
<p><strong>Build and run:</strong></p>
|
||
<div class="example-wrap"><pre class="language-bash"><code>make # build greptime binary
|
||
cargo run -- standalone start # start in standalone mode</code></pre></div>
|
||
<p><strong>Common dev commands:</strong></p>
|
||
<div class="example-wrap"><pre class="language-bash"><code>make fmt # format Rust code
|
||
make clippy # lint (fails on warnings)
|
||
make test # unit + integration tests (uses cargo-nextest)
|
||
make sqlness-test # SQL regression tests</code></pre></div>
|
||
<p>See the <a href="CONTRIBUTING.md">Contribution Guidelines</a> for the full developer workflow.</p>
|
||
<h3 id="tools--extensions"><a class="doc-anchor" href="#tools--extensions">§</a>Tools & Extensions</h3>
|
||
<ul>
|
||
<li><strong>Kubernetes</strong>: <a href="https://github.com/GreptimeTeam/greptimedb-operator">GreptimeDB Operator</a></li>
|
||
<li><strong>Helm Charts</strong>: <a href="https://github.com/GreptimeTeam/helm-charts">Greptime Helm Charts</a></li>
|
||
<li><strong>Dashboard</strong>: <a href="https://github.com/GreptimeTeam/dashboard">Web UI</a></li>
|
||
<li><strong>gRPC Ingester</strong>: <a href="https://github.com/GreptimeTeam/greptimedb-ingester-go">Go</a>, <a href="https://github.com/GreptimeTeam/greptimedb-ingester-java">Java</a>, <a href="https://github.com/GreptimeTeam/greptimedb-ingester-cpp">C++</a>, <a href="https://github.com/GreptimeTeam/greptimedb-ingester-erl">Erlang</a>, <a href="https://github.com/GreptimeTeam/greptimedb-ingester-rust">Rust</a>, <a href="https://github.com/GreptimeTeam/greptimedb-ingester-dotnet">.NET</a>, <a href="https://github.com/GreptimeTeam/greptimedb-ingester-ts">TypeScript</a></li>
|
||
<li><strong>Grafana Data Source</strong>: <a href="https://github.com/GreptimeTeam/greptimedb-grafana-datasource">GreptimeDB Grafana data source plugin</a></li>
|
||
<li><strong>Grafana Dashboard</strong>: <a href="https://github.com/GreptimeTeam/greptimedb/blob/main/grafana/README.md">Official Dashboard for monitoring</a></li>
|
||
</ul>
|
||
<h3 id="project-status"><a class="doc-anchor" href="#project-status">§</a>Project Status</h3>
|
||
<p>GreptimeDB is generally available, with stable APIs and regular releases. It runs in production at scale — <a href="https://greptime.com/blogs/2025-07-22-user-case-obcloud-log-management-greptimedb">OceanBase Cloud</a> operates 80+ GreptimeDB clusters managing 300 TB of logs, cutting log storage cost by 60%+ after migrating from Grafana Loki. See more in <a href="https://greptime.com/blogs/?category=Use%20Case">case studies</a>.</p>
|
||
<p>Release lines and support windows are in the <a href="https://docs.greptime.com/nightly/reference/about-greptimedb-version">version reference</a>. For where the project is going, read the <a href="https://greptime.com/blogs/2025-11-05-greptimedb-v1-highlights">v1.0 highlights</a> and the <a href="https://greptime.com/blogs/2026-02-11-greptimedb-roadmap-2026">2026 roadmap</a>.</p>
|
||
<h3 id="community"><a class="doc-anchor" href="#community">§</a>Community</h3>
|
||
<p>We invite you to engage and contribute!</p>
|
||
<ul>
|
||
<li><a href="https://greptime.com/slack">Slack</a></li>
|
||
<li><a href="https://github.com/GreptimeTeam/greptimedb/discussions">Discussions</a></li>
|
||
<li><a href="https://greptime.com/">Official Website</a></li>
|
||
<li><a href="https://greptime.com/blogs/">Blog</a></li>
|
||
<li><a href="https://www.linkedin.com/company/greptime/">LinkedIn</a></li>
|
||
<li><a href="https://X.com/greptime">X (Twitter)</a></li>
|
||
<li><a href="https://www.youtube.com/@greptime">YouTube</a></li>
|
||
</ul>
|
||
<p>If GreptimeDB is useful to you, please star the repo.</p>
|
||
<img alt="Known Users" src="https://greptime.com/logo/img/users.png"/>
|
||
<h3 id="license"><a class="doc-anchor" href="#license">§</a>License</h3>
|
||
<p>GreptimeDB is an open-core project. Its core is licensed under the
|
||
<a href="https://apache.org/licenses/LICENSE-2.0.txt">Apache License 2.0</a>.</p>
|
||
<p>A small set of peripheral, enterprise-only features are gated behind the
|
||
<code>enterprise</code> Cargo feature (not built by default) and are governed by the
|
||
separate <a href="LICENSE-ENTERPRISE">GreptimeDB Enterprise License</a>. Source files under
|
||
that license carry an explicit Enterprise License header.</p>
|
||
<h3 id="commercial-support"><a class="doc-anchor" href="#commercial-support">§</a>Commercial Support</h3>
|
||
<p>Scaling observability on your infrastructure?
|
||
<a href="https://docs.greptime.com/enterprise/overview/">GreptimeDB Enterprise</a> adds the operational,
|
||
security, and support layer for production deployments.
|
||
<a href="https://greptime.com/contactus">Contact us</a> for details.</p>
|
||
<h3 id="contributing"><a class="doc-anchor" href="#contributing">§</a>Contributing</h3>
|
||
<ul>
|
||
<li>Read our <a href="CONTRIBUTING.md">Contribution Guidelines</a>.</li>
|
||
<li>Explore <a href="https://docs.greptime.com/contributor-guide/overview.html">Internal Concepts</a> and <a href="https://deepwiki.com/GreptimeTeam/greptimedb">DeepWiki</a>.</li>
|
||
<li>Pick up a <a href="https://github.com/GreptimeTeam/greptimedb/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">good first issue</a> and join the #contributors <a href="https://greptime.com/slack">Slack</a> channel.</li>
|
||
</ul>
|
||
<p><a href="https://github.com/GreptimeTeam/greptimedb/actions/workflows/integration.yml"><img src="https://github.com/GreptimeTeam/greptimedb/actions/workflows/integration.yml/badge.svg" alt="Integration CI" /></a>
|
||
<a href="https://codecov.io/gh/GreptimeTeam/greptimedb"><img src="https://codecov.io/gh/GreptimeTeam/greptimedb/branch/main/graph/badge.svg?token=FITFDI3J3C" alt="Codecov" /></a></p>
|
||
<h3 id="acknowledgement"><a class="doc-anchor" href="#acknowledgement">§</a>Acknowledgement</h3>
|
||
<p>Special thanks to all contributors! See <a href="AUTHOR.md">AUTHOR.md</a>.</p>
|
||
<ul>
|
||
<li>Uses <a href="https://arrow.apache.org/">Apache Arrow™</a> (memory model)</li>
|
||
<li><a href="https://parquet.apache.org/">Apache Parquet™</a> (file storage)</li>
|
||
<li><a href="https://datafusion.apache.org/">Apache DataFusion™</a> (query engine)</li>
|
||
<li><a href="https://opendal.apache.org/">Apache OpenDAL™</a> (data access abstraction)</li>
|
||
</ul>
|
||
<hr />
|
||
<p><em>All trademarks, logos, and brand names referenced in this README and in the Overview diagram are the property of their respective owners. Their use is for identification purposes only and does not imply endorsement or affiliation.</em></p>
|
||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Command.html" title="struct greptime::Command">Command</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.SubCommand.html" title="enum greptime::SubCommand">SubCommand</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.ALLOC.html" title="static greptime::ALLOC">ALLOC</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.main.html" title="fn greptime::main">main</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.main_body.html" title="fn greptime::main_body">main_<wbr>body</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.maybe_daemonize.html" title="fn greptime::maybe_daemonize">maybe_<wbr>daemonize</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>If <code>--daemon</code> was passed for <code>standalone start</code>, fork into the background
|
||
before any Tokio runtime is built. On non-Unix platforms the <code>--daemon</code>
|
||
flag does not exist, so this is a no-op.</dd><dt><a class="fn" href="fn.setup_human_panic.html" title="fn greptime::setup_human_panic">setup_<wbr>human_<wbr>panic</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.start.html" title="fn greptime::start">start</a><span title="Restricted Visibility"> 🔒</span> </dt></dl></section></div></main></body></html> |