GreptimeDB

https://docs.greptime.com/
Admin
GreptimeDB is an open-source unified observability database designed for metrics, logs, and events,...
Tokens:718,512
Snippets:9,673
Trust Score:8.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start GreptimeDB with command line options

Source: https://docs.greptime.com/0.14/user-guide/deployments/configuration

Example of starting GreptimeDB in standalone mode with a custom HTTP address.

```bash
greptime standalone start --http-addr 127.0.0.1:4000  
```

--------------------------------

### Install GreptimeDB Go SDK

Source: https://docs.greptime.com/0.14/user-guide/ingest-data/for-iot/grpc-sdks/go

Use the go get command to install the required client library.

```bash
go get -u github.com/GreptimeTeam/greptimedb-ingester-go@v0.6.1
```

--------------------------------

### Create Example Tables and Data

Source: https://docs.greptime.com/0.14/user-guide/query-data/cte

Setup script to create grpc_latencies and app_logs tables and populate them with sample data.

```sql
CREATE TABLE grpc_latencies (  
    ts TIMESTAMP TIME INDEX,  
    host VARCHAR(255),  
    latency FLOAT,  
    PRIMARY KEY(host),  
);  
  
INSERT INTO grpc_latencies VALUES   
('2023-10-01 10:00:00', 'host1', 120),  
('2023-10-01 10:00:00', 'host2', 150),  
('2023-10-01 10:00:05', 'host1', 130);  
  
CREATE TABLE app_logs (  
    ts TIMESTAMP TIME INDEX,  
    host VARCHAR(255),  
    log TEXT,  
    log_level VARCHAR(50),  
    PRIMARY KEY(host, log_level),  
);  
  
INSERT INTO app_logs VALUES   
('2023-10-01 10:00:00', 'host1', 'Error on service', 'ERROR'),  
('2023-10-01 10:00:00', 'host2', 'All services OK', 'INFO'),  
('2023-10-01 10:00:05', 'host1', 'Error connecting to DB', 'ERROR');
```

--------------------------------

### Install and Run GreptimeDB Binary

Source: https://docs.greptime.com/SKILL.md

Downloads the GreptimeDB binary using the installation script and starts the standalone server.

```shell
curl -fsSL \
  https://raw.githubusercontent.com/greptimeteam/greptimedb/main/scripts/install.sh \
  | sh -s v1.1.2

./greptime standalone start \
  --http-addr 0.0.0.0:4000 \
  --rpc-bind-addr 0.0.0.0:4001 \
  --mysql-addr 0.0.0.0:4002 \
  --postgres-addr 0.0.0.0:4003
```

--------------------------------

### Table Creation for DELETE Example

Source: https://docs.greptime.com/0.14/reference/sql/delete

Setup a table with a primary key and time index to demonstrate row deletion.

```sql
CREATE TABLE monitor ( host STRING, ts TIMESTAMP, cpu DOUBLE DEFAULT 0, memory DOUBLE, TIME INDEX (ts), PRIMARY KEY(host)) ;
```

--------------------------------

### Create Database Examples

Source: https://docs.greptime.com/reference/sql/create

Various examples demonstrating database creation with different options and configurations.

```sql
CREATE DATABASE test;  
```

```sql
Query OK, 1 row affected (0.05 sec)  
```

```sql
CREATE DATABASE IF NOT EXISTS test;  
```

```sql
CREATE DATABASE test WITH (ttl='7d');  
```

```sql
CREATE DATABASE test WITH (  
  ttl='30d',  
  'memtable.type'='partition_tree',  
  'append_mode'='true'  
);  
```

```sql
CREATE DATABASE test WITH (  
  'skip_wal'='true',  
  'merge_mode'='last_non_null'  
);  
```

```sql
CREATE DATABASE test WITH ('sst_format'='flat');  
```

--------------------------------

### REPLACE INTO Examples

Source: https://docs.greptime.com/reference/sql/replace

Examples demonstrating single and multiple record insertion into a system_metrics table.

```sql
REPLACE INTO system_metrics (host, idc, cpu_util, memory_util, disk_util, ts)  
VALUES  
    ("host1", "idc_b", 50.0, 66.7, 40.6, 1667446797462);  
```

```sql
REPLACE INTO system_metrics (host, idc, cpu_util, memory_util, disk_util, ts)  
VALUES  
    ("host1", "idc_a", 11.8, 10.3, 10.3, 1667446797460),  
    ("host2", "idc_a", 80.1, 70.3, 90.0, 1667446797461),  
    ("host1", "idc_c", 50.1, 66.8, 40.8, 1667446797463);  
```

--------------------------------

### BUILD_INFO output example

Source: https://docs.greptime.com/0.14/reference/sql/information-schema/build-info

Example output format returned when querying the BUILD_INFO table.

```text
+------------+------------------------------------------+------------------+-----------+-------------+  
| git_branch | git_commit                               | git_commit_short | git_clean | pkg_version |  
+------------+------------------------------------------+------------------+-----------+-------------+  
|            | c595a56ac89bef78b19a76aa60d8c6bcac7354a5 | c595a56a         | true      | 0.9.0       |  
+------------+------------------------------------------+------------------+-----------+-------------+  
```

--------------------------------

### Map_Keys Syntax and Examples

Source: https://docs.greptime.com/0.14/reference/sql/functions/df-functions

Syntax and examples for retrieving all keys from a map as a list.

```sql
map_keys(map)
```

```sql
SELECT map_keys(MAP {'a': 1, 'b': NULL, 'c': 3});  
----  
[a, b, c]  
  
SELECT map_keys(map([100, 5], [42, 43]));  
----  
[100, 5]
```

--------------------------------

### ADMIN Usage Examples

Source: https://docs.greptime.com/0.14/reference/sql/admin

Examples of flushing a table and scheduling a compaction task.

```sql
-- Flush the table test --  
admin flush_table("test");  
  
-- Schedule a compaction for table test --  
admin compact_table("test");
```

--------------------------------

### Start Flownode with Configuration

Source: https://docs.greptime.com/0.15/reference/command-lines/flownode

Starts a flownode instance using a specified TOML configuration file.

```bash
greptime flownode start -c config/flownode.example.toml
```

--------------------------------

### Start Datanode with Configuration

Source: https://docs.greptime.com/0.15/reference/command-lines/datanode

Starts a datanode instance using a specified TOML configuration file.

```bash
greptime datanode start -c config/datanode.example.toml  
```

--------------------------------

### regexp_like usage examples

Source: https://docs.greptime.com/llms-full.txt

Examples demonstrating basic pattern matching and case-insensitive matching with flags.

```sql
select regexp_like('Köln', '[a-zA-Z]ö[a-zA-Z]{2}');
+--------------------------------------------------------+
| regexp_like(Utf8("Köln"),Utf8("[a-zA-Z]ö[a-zA-Z]{2}")) |
+--------------------------------------------------------+
| true                                                   |
+--------------------------------------------------------+
SELECT regexp_like('aBc', '(b|d)', 'i');
+--------------------------------------------------+
| regexp_like(Utf8("aBc"),Utf8("(b|d)"),Utf8("i")) |
+--------------------------------------------------+
| true                                             |
+--------------------------------------------------+
```

--------------------------------

### to_unixtime Examples

Source: https://docs.greptime.com/0.14/reference/sql/functions/df-functions

Examples showing basic string parsing and custom format string parsing.

```sql
> select to_unixtime('2020-09-08T12:00:00+00:00');  
+------------------------------------------------+  
| to_unixtime(Utf8("2020-09-08T12:00:00+00:00")) |  
+------------------------------------------------+  
| 1599566400                                     |  
+------------------------------------------------+  
> select to_unixtime('01-14-2023 01:01:30+05:30', '%q', '%d-%m-%Y %H/%M/%S', '%+', '%m-%d-%Y %H:%M:%S%#z');  
+-----------------------------------------------------------------------------------------------------------------------------+  
| to_unixtime(Utf8("01-14-2023 01:01:30+05:30"),Utf8("%q"),Utf8("%d-%m-%Y %H/%M/%S"),Utf8("%+"),Utf8("%m-%d-%Y %H:%M:%S%#z")) |  
+-----------------------------------------------------------------------------------------------------------------------------+  
| 1673638290                                                                                                                  |  
+-----------------------------------------------------------------------------------------------------------------------------+  
```

--------------------------------

### Start GreptimeDB standalone on Linux and macOS

Source: https://docs.greptime.com/0.14/getting-started/installation/greptimedb-standalone

Execute the binary to start the database in standalone mode.

```bash
./greptime standalone start  
```

--------------------------------

### Install GreptimeDB Standalone

Source: https://docs.greptime.com/0.14/user-guide/deployments/deploy-on-kubernetes/deploy-greptimedb-standalone

Performs a basic installation of GreptimeDB Standalone using default configuration.

```bash
helm upgrade --install greptimedb-standalone greptime/greptimedb-standalone -n default  
```

```text
Release "greptimedb-standalone" does not exist. Installing it now.  
NAME: greptimedb-standalone  
LAST DEPLOYED: Mon May 26 08:06:54 2025  
NAMESPACE: default  
STATUS: deployed  
REVISION: 1  
TEST SUITE: None  
NOTES:  
***********************************************************************  
 Welcome to use greptimedb-standalone  
 Chart version: 0.1.53  
 GreptimeDB Standalone version: 0.14.3  
***********************************************************************  
  
Installed components:  
* greptimedb-standalone  
  
The greptimedb-standalone is starting, use `kubectl get statefulset greptimedb-standalone -n default` to check its status.  
```

--------------------------------

### Create Database Examples

Source: https://docs.greptime.com/0.14/reference/sql/create

Examples demonstrating database creation, handling existing databases, and setting TTL options.

```sql
CREATE DATABASE test;  
```

```sql
Query OK, 1 row affected (0.05 sec)  
```

```sql
CREATE DATABASE IF NOT EXISTS test;  
```

```sql
CREATE DATABASE test with(ttl='7d');  
```

--------------------------------

### Setup Table and Data

Source: https://docs.greptime.com/reference/sql/range

Create a sample table and insert data for range query demonstrations.

```sql
DROP TABLE IF EXISTS host_val;  
CREATE TABLE host_val (  
    ts TIMESTAMP TIME INDEX,  
    host STRING,  
    val DOUBLE,  
    PRIMARY KEY (host)  
);  
  
INSERT INTO host_val VALUES  
    ('2023-01-01 23:00:00', 'host1', 0),  
    ('2023-01-02 01:00:00', 'host1', 1),  
    ('2023-01-01 23:00:00', 'host2', 2),  
    ('2023-01-02 01:00:00', 'host2', 3);
```

--------------------------------

### Expected Helm Install Output

Source: https://docs.greptime.com/0.14/user-guide/deployments/deploy-on-kubernetes/getting-started

Example output confirming the successful deployment of the GreptimeDB Operator.

```text
NAME: greptimedb-operator  
LAST DEPLOYED: Tue Oct 29 18:40:10 2024  
NAMESPACE: greptimedb-admin  
STATUS: deployed  
REVISION: 1  
TEST SUITE: None  
NOTES:  
***********************************************************************  
 Welcome to use greptimedb-operator  
 Chart version: 0.2.9  
 GreptimeDB Operator version: 0.1.3-alpha.1  
***********************************************************************  
  
Installed components:  
* greptimedb-operator  
  
The greptimedb-operator is starting, use `kubectl get deployments greptimedb-operator -n greptimedb-admin` to check its status.  
```

--------------------------------

### Expected Helm Installation Output

Source: https://docs.greptime.com/0.14/user-guide/deployments/deploy-on-kubernetes/getting-started

Example output confirming the successful deployment of the GreptimeDB cluster components.

```text
Release "mycluster" does not exist. Installing it now.
NAME: mycluster
LAST DEPLOYED: Mon Oct 28 17:19:47 2024
NAMESPACE: default
STATUS: deployed
REVISION: 1
NOTES:
***********************************************************************
 Welcome to use greptimedb-cluster
 Chart version: 0.2.25
 GreptimeDB Cluster version: 0.9.5
***********************************************************************

Installed components:
* greptimedb-frontend
* greptimedb-datanode
* greptimedb-meta

The greptimedb-cluster is starting, use `kubectl get pods -n default` to check its status.
```

--------------------------------

### Start Frontend Service with Configuration

Source: https://docs.greptime.com/0.15/reference/command-lines/frontend

Initializes the frontend service using a specified TOML configuration file.

```bash
greptime frontend start -c config/frontend.example.toml
```

--------------------------------

### View standalone help options

Source: https://docs.greptime.com/0.15/reference/command-lines/standalone

Displays all available command-line options for the standalone start command.

```bash
greptime standalone start --help  
```

--------------------------------

### Configure Metasrv Selector via CLI

Source: https://docs.greptime.com/0.14/contributor-guide/metasrv/selector

Examples of setting the selector type when starting the Metasrv service using cargo run.

```bash
cargo run -- metasrv start --selector round_robin
```

```bash
cargo run -- metasrv start --selector RoundRobin
```

--------------------------------

### Map and Make_Map Examples

Source: https://docs.greptime.com/0.14/reference/sql/functions/df-functions

Examples demonstrating map creation with various data types and the make_map function.

```sql
-- Using map function  
SELECT MAP('type', 'test');  
----  
{type: test}  
  
SELECT MAP(['POST', 'HEAD', 'PATCH'], [41, 33, null]);  
----  
{POST: 41, HEAD: 33, PATCH: NULL}  
  
SELECT MAP([[1,2], [3,4]], ['a', 'b']);  
----  
{[1, 2]: a, [3, 4]: b}  
  
SELECT MAP { 'a': 1, 'b': 2 };  
----  
{a: 1, b: 2}  
  
-- Using make_map function  
SELECT MAKE_MAP(['POST', 'HEAD'], [41, 33]);  
----  
{POST: 41, HEAD: 33}  
  
SELECT MAKE_MAP(['key1', 'key2'], ['value1', null]);  
----  
{key1: value1, key2: }
```

--------------------------------

### Install gtctl via Shell Script

Source: https://docs.greptime.com/0.14/reference/gtctl

Download and install the gtctl binary using the provided installation scripts.

```bash
curl -fsSL https://raw.githubusercontent.com/greptimeteam/gtctl/develop/hack/install.sh | sh  
```

```bash
curl -fsSL https://downloads.greptime.cn/releases/scripts/gtctl/install.sh | sh -s -- -s aws  
```

--------------------------------

### Start GreptimeDB with static user provider

Source: https://docs.greptime.com/0.14/user-guide/deployments/authentication/static

Use the --user-provider flag to point to the configuration file containing user credentials.

```bash
./greptime standalone start --user-provider=static_user_provider:file:<path_to_file>  
```

--------------------------------

### range(start, stop, step)

Source: https://docs.greptime.com/0.14/reference/sql/functions/df-functions

Returns an Arrow array between start and stop with a specified step. The range includes the start value but excludes the stop value.

```APIDOC
## range(start, stop, step)

### Description
Returns an Arrow array between start and stop with step. The range start..end contains all values with start <= x < end.

### Arguments
- **start** (Int/Timestamp/Date) - Required - Start of the range.
- **end** (Int/Timestamp/Date) - Required - End of the range (not included).
- **step** (Int/Interval) - Required - Increase by step (cannot be 0).

### Example
```sql
SELECT range(2, 10, 3);
-- Result: [2, 5, 8]
```
```

--------------------------------

### Start GreptimeDB with a configuration file

Source: https://docs.greptime.com/0.14/user-guide/deployments/configuration

Commands to launch different GreptimeDB components using a specified configuration file.

```bash
greptime [standalone | frontend | datanode | metasrv]  start -c config/standalone.example.toml  
```

```bash
greptime standalone start -c standalone.example.toml  
```

--------------------------------

### Range Function Examples

Source: https://docs.greptime.com/0.14/user-guide/query-data/promql

Examples of supported range functions.

```promql
idelta(metric[5m])
```

```promql
count_over_time(metric[5m])
```

```promql
stddev_over_time(metric[5m])
```

```promql
stdvar_over_time(metric[5m])
```

```promql
changes(metric[5m])
```

```promql
delta(metric[5m])
```

```promql
rate(metric[5m])
```

```promql
deriv(metric[5m])
```

```promql
increase(metric[5m])
```

```promql
irate(metric[5m])
```

```promql
reset(metric[5m])
```

--------------------------------

### Instant Function Examples

Source: https://docs.greptime.com/0.14/user-guide/query-data/promql

Examples of supported instant functions.

```promql
abs(metric)
```

```promql
ceil(metric)
```

```promql
exp(metric)
```

```promql
ln(metric)
```

```promql
log2(metric)
```

```promql
log10(metric)
```

```promql
sqrt(metric)
```

```promql
acos(metric)
```

```promql
asin(metric)
```

```promql
atan(metric)
```

```promql
sin(metric)
```

```promql
cos(metric)
```

```promql
tan(metric)
```

```promql
acosh(metric)
```

```promql
asinh(metric)
```

```promql
atanh(metric)
```

```promql
sinh(metric)
```

```promql
cosh(metric)
```

```promql
scalar(metric)
```

```promql
tanh(metric)
```

```promql
timestamp()
```

```promql
sort(http_requests_total)
```

```promql
sort_desc(http_requests_total)
```

```promql
histogram_quantile(phi, metric)
```

--------------------------------

### Start frontend component

Source: https://docs.greptime.com/0.14/reference/command-lines

Initializes the frontend component using a configuration file or by specifying the metasrv address via command line arguments.

```bash
greptime frontend start -c config/frontend.example.toml
```

```bash
greptime frontend start --metasrv-addrs=0.0.0.0:3002
```

--------------------------------

### Install GreptimeAI

Source: https://docs.greptime.com/llms-full.txt

Installs the necessary Python package for Langchain integration.

```python
pip install greptimeai
```

--------------------------------

### SQL avg Function Example

Source: https://docs.greptime.com/reference/sql/functions/df-functions

Example of using the avg function.

```sql
> SELECT avg(column_name) FROM table_name;  
+---------------------------+  
| avg(column_name)           |  
+---------------------------+  
| 42.75                      |  
+---------------------------+
```

--------------------------------

### Create a Flow Example

Source: https://docs.greptime.com/0.14/user-guide/flow-computation/manage-flow

A practical example of creating a flow that aggregates temperature data into 10-second windows.

```sql
CREATE FLOW IF NOT EXISTS my_flow  
SINK TO my_sink_table  
EXPIRE AFTER '1 hour'::INTERVAL  
COMMENT 'My first flow in GreptimeDB'  
AS  
SELECT  
    max(temperature) as max_temp,  
    date_bin('10 seconds'::INTERVAL, ts) as time_window,  
FROM temp_sensor_data  
GROUP BY time_window;
```

--------------------------------

### Create and query partitioned table

Source: https://docs.greptime.com/0.14/reference/sql/information-schema/partitions

Example showing the creation of a table with range partitioning and how to query its partition metadata.

```sql
CREATE TABLE public.test_p (  
  a INT PRIMARY KEY,  
  b STRING,  
  ts TIMESTAMP TIME INDEX,  
)  
PARTITION ON COLUMNS (a) (  
  a < 10,  
  a >= 10 AND a < 20,  
  a >= 20  
);  
  
--- Query the partitions of the table --  
SELECT * FROM PARTITIONS WHERE table_schema='public' AND table_name='test_p'\G  
```

--------------------------------

### date_part usage examples

Source: https://docs.greptime.com/reference/sql/functions/df-functions

Examples demonstrating how to extract parts of a date.

```sql
> SELECT date_part('year', '2024-05-01T00:00:00');  
+-----------------------------------------------------+  
| date_part(Utf8("year"),Utf8("2024-05-01T00:00:00")) |  
+-----------------------------------------------------+  
| 2024                                                |  
+-----------------------------------------------------+  
> SELECT extract(day FROM timestamp '2024-05-01T00:00:00');  
+----------------------------------------------------+  
| date_part(Utf8("DAY"),Utf8("2024-05-01T00:00:00")) |  
+----------------------------------------------------+  
| 1                                                  |  
+----------------------------------------------------+  
```

--------------------------------

### Label and Other Function Examples

Source: https://docs.greptime.com/0.15/user-guide/query-data/promql

Examples of label manipulation and sorting functions.

```promql
label_join(up{job="api-server",src1="a",src2="b",src3="c"}, "foo", ",", "src1", "src2", "src3")
```

```promql
label_replace(up{job="api-server",service="a:c"}, "foo", "$1", "service", "(.*):.*")
```

```promql
sort_by_label(metric, "foo", "bar")
```

```promql
sort_by_label_desc(metric, "foo", "bar")
```

--------------------------------

### Setup Table for Range Queries

Source: https://docs.greptime.com/reference/sql/range

Create and populate a sample table to demonstrate range expression functionality.

```sql
DROP TABLE IF EXISTS host_val;  
CREATE TABLE host_val (  
    ts TIMESTAMP TIME INDEX,  
    host STRING,  
    val DOUBLE,  
    PRIMARY KEY (host)  
);  
  
INSERT INTO host_val VALUES  
    ('2023-01-01 08:00:00', 'host1', 1.1),  
    ('2023-01-01 08:00:05', 'host1', 2.2),  
    ('2023-01-01 08:00:00', 'host2', 3.3),  
    ('2023-01-01 08:00:05', 'host2', 4.4);
```

--------------------------------

### array_append Example

Source: https://docs.greptime.com/0.14/reference/sql/functions/df-functions

Example demonstrating appending an integer to an existing array.

```sql
> select array_append([1, 2, 3], 4);  
+--------------------------------------+  
| array_append(List([1,2,3]),Int64(4)) |  
+--------------------------------------+  
| [1, 2, 3, 4]                         |  
+--------------------------------------+  
```

--------------------------------

### Set environment variables at startup

Source: https://docs.greptime.com/enterprise/deployments-administration/env-affinity-region-placement

Example of setting the corresponding environment variables for the process at startup.

```bash
REGION=us-east  
AZ=az-a  
```

--------------------------------

### Selector Examples

Source: https://docs.greptime.com/0.14/user-guide/query-data/promql

Examples of label matching and range selectors in PromQL.

```promql
{__name__!="request_count}"
```

--------------------------------

### List Metasrv Help Options

Source: https://docs.greptime.com/reference/command-lines/metasrv

Displays all available command-line options for the metasrv start command.

```bash
greptime metasrv start --help
```

--------------------------------

### PromQL Query Example

Source: https://docs.greptime.com/0.14/user-guide/migrate-to-greptimedb/migrate-from-influxdb

An example of a PromQL query for time-series aggregation.

```promql
avg_over_time(monitor[1h])  
```

--------------------------------

### Create and Populate Table for Range Queries

Source: https://docs.greptime.com/reference/sql/range

Sets up a sample table with a time index and inserts data for demonstration.

```sql
DROP TABLE IF EXISTS host_val;  
CREATE TABLE host_val (  
    ts TIMESTAMP TIME INDEX,  
    host STRING,  
    val DOUBLE,  
    addon DOUBLE,  
    PRIMARY KEY (host)  
);  
  
INSERT INTO host_val VALUES  
    ('1970-01-01 00:00:00', 'host1', 0, 3),  
    ('1970-01-01 00:00:01', 'host1', 1, 2),  
    ('1970-01-01 00:00:02', 'host1', 2, 1);
```

--------------------------------

### Prometheus Metric Example

Source: https://docs.greptime.com/0.14/user-guide/ingest-data/for-observability/prometheus

An example of a raw Prometheus metric format.

```text
prometheus_remote_storage_samples_total{instance="localhost:9090", job="prometheus",  
remote_name="648f0c", url="http://localhost:4000/v1/prometheus/write"} 500  

```

--------------------------------

### Install GORM Library and Driver

Source: https://docs.greptime.com/0.14/reference/sql-tools

Use these commands to install the GORM library and the MySQL driver for Go.

```bash
go get -u gorm.io/gorm  
```

```bash
go get -u gorm.io/driver/mysql  
```

--------------------------------

### Start metasrv component

Source: https://docs.greptime.com/0.14/reference/command-lines

Initializes the metasrv component using a configuration file.

```bash
greptime metasrv start -c config/metasrv.example.toml
```

--------------------------------

### Verify Installation

Source: https://docs.greptime.com/0.14/user-guide/deployments/deploy-on-kubernetes/greptimedb-operator-management

Verifies the status of the Helm release or checks for installed CRDs.

```bash
helm list -n greptimedb-admin  
```

```bash
kubectl get crd | grep greptime  
```

--------------------------------

### Install GreptimeDB Operator

Source: https://docs.greptime.com/0.14/user-guide/deployments/deploy-on-kubernetes/configure-frontend-groups

Installs or upgrades the GreptimeDB Operator in the specified namespace.

```bash
helm upgrade \
  --install \
  --create-namespace \
  greptimedb-operator greptime/greptimedb-operator \
  -n greptimedb-admin  
```

--------------------------------

### Install gtctl via Homebrew

Source: https://docs.greptime.com/0.14/reference/gtctl

Use Homebrew to install gtctl on macOS.

```bash
brew tap greptimeteam/greptime  
brew install gtctl  
```

--------------------------------

### Digest function example

Source: https://docs.greptime.com/0.15/reference/sql/functions/df-functions

Example usage of the digest function with the sha256 algorithm.

```sql
> select digest('foo', 'sha256');  
+------------------------------------------+  
| digest(Utf8("foo"), Utf8("sha256"))      |  
+------------------------------------------+  
| <binary_hash_result>                     |  
+------------------------------------------+  
```

--------------------------------

### SQL JOIN Examples

Source: https://docs.greptime.com/0.14/reference/sql/join

Demonstrates basic JOIN, LEFT JOIN, and RIGHT JOIN syntax for combining system_metrics and idc_info tables.

```sql
-- Select all rows from the system_metrics table and idc_info table where the idc_id matches  
SELECT a.*  
FROM system_metrics a  
JOIN idc_info b  
ON a.idc = b.idc_id;  
  
-- Select all rows from the idc_info table and system_metrics table where the idc_id matches, and include null values for idc_info without any matching system_metrics  
SELECT a.*  
FROM idc_info a  
LEFT JOIN system_metrics b  
ON a.idc_id = b.idc;  
  
-- Select all rows from the system_metrics table and idc_info table where the idc_id matches, and include null values for idc_info without any matching system_metrics  
SELECT b.*  
FROM system_metrics a  
RIGHT JOIN idc_info b  
ON a.idc = b.idc_id;  
```

--------------------------------

### Map_Values Syntax and Examples

Source: https://docs.greptime.com/0.14/reference/sql/functions/df-functions

Syntax and examples for retrieving all values from a map as a list.

```sql
map_values(map)
```

```sql
SELECT map_values(MAP {'a': 1, 'b': NULL, 'c': 3});  
----  
[1, , 3]  
  
SELECT map_values(map([100, 5], [42, 43]));  
----  
[42, 43]
```

--------------------------------

### COPY DATABASE Examples

Source: https://docs.greptime.com/0.14/reference/sql/copy

Practical examples demonstrating how to export and import database data using the COPY DATABASE command.

```sql
-- Export all tables' data to /tmp/export/  
COPY DATABASE public TO '/tmp/export/' WITH (FORMAT='parquet');  
  
-- Export all tables' data within time range 2022-04-11 08:00:00~2022-04-11 09:00:00 to /tmp/export/  
COPY DATABASE public TO '/tmp/export/' WITH (FORMAT='parquet', START_TIME='2022-04-11 08:00:00', END_TIME='2022-04-11 09:00:00');  
  
-- Import files under /tmp/export/ directory to database named public.  
COPY DATABASE public FROM '/tmp/export/' WITH (FORMAT='parquet');
```

--------------------------------

### Start GreptimeDB

Source: https://docs.greptime.com/user-guide/deployments-administration/run-on-android

Launches the GreptimeDB standalone process using the specified configuration file.

```bash
./greptime --log-dir=$(pwd)/logs standalone start -c ./config.toml
```

--------------------------------

### from_unixtime Usage Example

Source: https://docs.greptime.com/0.14/reference/sql/functions/df-functions

Example of converting a Unix timestamp to a specific timezone.

```sql
> select from_unixtime(1599572549, 'America/New_York');  
+-----------------------------------------------------------+  
| from_unixtime(Int64(1599572549),Utf8("America/New_York")) |  
+-----------------------------------------------------------+  
| 2020-09-08T09:42:29-04:00                                 |  
+-----------------------------------------------------------+
```

--------------------------------

### regexp_match usage examples

Source: https://docs.greptime.com/0.14/reference/sql/functions/df-functions

Examples demonstrating regex matching with and without flags.

```sql
> select regexp_match('Köln', '[a-zA-Z]ö[a-zA-Z]{2}');  
            +---------------------------------------------------------+  
            | regexp_match(Utf8("Köln"),Utf8("[a-zA-Z]ö[a-zA-Z]{2}")) |  
            +---------------------------------------------------------+  
            | [Köln]                                                  |  
            +---------------------------------------------------------+  
            SELECT regexp_match('aBc', '(b|d)', 'i');  
            +---------------------------------------------------+  
            | regexp_match(Utf8("aBc"),Utf8("(b|d)"),Utf8("i")) |  
            +---------------------------------------------------+  
            | [B]                                               |  
            +---------------------------------------------------+
```

--------------------------------

### Create and Populate Table

Source: https://docs.greptime.com/llms-full.txt

Sets up the host_val table with a time index and sample data for range query examples.

```sql
DROP TABLE IF EXISTS host_val;
CREATE TABLE host_val (
    ts TIMESTAMP TIME INDEX,
    host STRING,
    val DOUBLE,
    addon DOUBLE,
    PRIMARY KEY (host)
);

INSERT INTO host_val VALUES
    ('1970-01-01 00:00:00', 'host1', 0, 3),
    ('1970-01-01 00:00:01', 'host1', 1, 2),
    ('1970-01-01 00:00:02', 'host1', 2, 1);
```

--------------------------------

### List Greptime CLI help

Source: https://docs.greptime.com/0.14/reference/command-lines

Displays all available commands and global options for the greptime binary.

```bash
$ greptime help  
Usage: greptime [OPTIONS] <COMMAND>  
  
Commands:  
  datanode    Start datanode service  
  flownode    Start flownode service  
  frontend    Start frontend service  
  metasrv     Start metasrv service  
  standalone  Run greptimedb as a standalone service  
  cli         Execute the cli tools for greptimedb  
  help        Print this message or the help of the given subcommand(s)  
  
  
Options:  
      --log-dir <LOG_DIR>  
      --log-level <LOG_LEVEL>  
  -h, --help                   Print help  
  -V, --version                Print version  
```

--------------------------------

### Example Data Table

Source: https://docs.greptime.com/0.14/reference/sql/group_by

Sample system_metrics table used for demonstration.

```text
+-------+-------+----------+-------------+-----------+---------------------+  
| host  | idc   | cpu_util | memory_util | disk_util | ts                  |  
+-------+-------+----------+-------------+-----------+---------------------+  
| host1 | idc_a |     11.8 |        10.3 |      10.3 | 2022-11-03 03:39:57 |  
| host1 | idc_b |       50 |        66.7 |      40.6 | 2022-11-03 03:39:57 |  
| host1 | idc_c |     50.1 |        66.8 |      40.8 | 2022-11-03 03:39:57 |  
| host1 | idc_e |     NULL |        66.7 |      40.6 | 2022-11-03 03:39:57 |  
| host2 | idc_a |     80.1 |        70.3 |        90 | 2022-11-03 03:39:57 |  
+-------+-------+----------+-------------+-----------+---------------------+  
```

--------------------------------

### Helm Installation Output

Source: https://docs.greptime.com/user-guide/deployments-administration/deploy-on-kubernetes/deploy-greptimedb-cluster

Expected output after successfully running the Helm install command.

```text
Release "mycluster" does not exist. Installing it now.  
NAME: mycluster  
LAST DEPLOYED: Sun Apr 26 21:00:40 2026  
NAMESPACE: default  
STATUS: deployed  
REVISION: 1  
TEST SUITE: None  
NOTES:  
***********************************************************************  
 Welcome to use greptimedb-cluster  
 Chart version: 0.8.3  
 GreptimeDB Cluster version: 1.0.1  
***********************************************************************  
  
Installed components:  
* greptimedb-meta  
* greptimedb-datanode  
* greptimedb-frontend  
* greptimedb-flownode  
  
The greptimedb-cluster is starting, use `kubectl get pods -n default` to check its status.  
```

--------------------------------

### Install Kafka via Helm

Source: https://docs.greptime.com/user-guide/deployments-administration/deploy-on-kubernetes/deploy-kafka

Command to install the Kafka cluster into the kafka namespace.

```bash
helm upgrade --install kafka \
  --create-namespace \
  oci://registry-1.docker.io/bitnamicharts/kafka \
  --version 31.0.0 \
  -n kafka --values kafka-values.yaml
```

--------------------------------

### Create and Populate Table

Source: https://docs.greptime.com/llms-full.txt

Setup script to create the host_val table and insert sample data for testing FILL operations.

```sql
DROP TABLE IF EXISTS host_val;
CREATE TABLE host_val (
    ts TIMESTAMP TIME INDEX,
    host STRING,
    val DOUBLE,
    PRIMARY KEY (host)
);

INSERT INTO host_val VALUES
    ('1970-01-01 00:00:00', 'host1', 0),
    ('1970-01-01 00:00:15', 'host1', 6),
    ('1970-01-01 00:00:00', 'host2', 6),
    ('1970-01-01 00:00:15', 'host2', 12);
```

--------------------------------

### Verify CRD Installation

Source: https://docs.greptime.com/0.14/user-guide/deployments/deploy-on-kubernetes/getting-started

Lists installed Custom Resource Definitions related to GreptimeDB.

```bash
kubectl get crds | grep greptime  
```

--------------------------------

### Write system metrics with Go

Source: https://docs.greptime.com/llms-full.txt

Executes a Go-based starter to collect and send system metrics to GreptimeDB via OTLP/http.

```shell
go run github.com/GreptimeCloudStarters/quick-start-go@latest -endpoint=https://<host>/v1/otlp/v1/metrics -db=<dbname> -username=<username> -password=<password>
```

--------------------------------

### Start metasrv with configuration file

Source: https://docs.greptime.com/0.15/reference/command-lines/metasrv

Launches the metasrv service using a specific TOML configuration file.

```bash
greptime metasrv start -c config/metasrv.example.toml  
```

--------------------------------

### generate_series(start, stop, step)

Source: https://docs.greptime.com/0.15/reference/sql/functions/df-functions

Generates a series of values from start to stop, inclusive.

```APIDOC
## generate_series(start, stop, step)

### Description
Similar to the range function, but it includes the upper bound.

### Arguments
- **start** (Int/Timestamp/Date) - Required - Start of the series.
- **stop** (Int/Timestamp/Date) - Required - End of the series (included).
- **step** (Int) - Optional - Increase by step (cannot be 0).

### Example
```sql
SELECT generate_series(1, 3);
-- Result: [1, 2, 3]
```
```

--------------------------------

### Initialize GreptimeDB Go Client

Source: https://docs.greptime.com/llms-full.txt

Configure the client with host, database, port, and authentication credentials to establish a gRPC connection.

```go
cfg := greptime.NewConfig("<host>").
    WithDatabase("<dbname>").
    WithPort(5001).
    WithInsecure(false).
    WithAuth("<username>", "<password>")

cli, err := greptime.NewClient(cfg)
if err != nil {
    panic("failed to init client")
}
```
Tokens:
Raw