openGemini

https://docs.opengemini.org
Admin
openGemini is an open-source cloud-native distributed time series database designed for storing and...
Tokens:4,463
Snippets:82
Trust Score:6.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start openGemini Single-Node

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Launch the standalone ts-server binary.

```bash
> cd openGemini
> ./usr/bin/ts-server
```

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

### Install and set Go 1.18 with gvm

Source: https://docs.opengemini.org/dev-guide/get_started/install_go

Install a specific Go version and set it as the default environment using gvm.

```bash
gvm install go1.18
gvm use go1.18 --default
```

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

### Install gvm

Source: https://docs.opengemini.org/dev-guide/get_started/install_go

Use this command to install the Go Version Manager on Linux or MacOS.

```bash
curl -s -S -L https://raw.githubusercontent.com/moovweb/gvm/master/binscripts/gvm-installer | sh
```

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

### Run openGemini Server

Source: https://docs.opengemini.org/dev-guide/get_started/build_source_code

Start the standalone server, optionally with a configuration file or in the background.

```bash
./build/ts-server
```

```bash
./build/ts-server -config config/openGemini.singlenode.conf
```

```bash
nohup ./build/ts-server -config config/openGemini.singlenode.conf > server_extra.log 2>&1 &
```

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

### Verify Go installation

Source: https://docs.opengemini.org/dev-guide/get_started/install_go

Check the currently active Go version to ensure the installation was successful.

```bash
go version
# OUTPUT:
# go version go1.18 linux/amd64
```

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

### Start openGemini server with configuration file

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Required for versions v1.0.1 and earlier to specify the configuration file path during startup.

```bash
./ts-server -config /path/to/openGemini.singlenode.conf
```

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

### Run openGemini with Custom Configuration

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Start the server using a specific configuration file, optionally in the background.

```bash
> ./usr/bin/ts-server --config ./etc/openGemini.singlenode.conf

# run in the background
> nohup ./usr/bin/ts-server --config ./etc/openGemini.singlenode.conf > server_extra.log 2>&1 &
```

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

### Launch openGemini CLI

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Execute the ts-cli binary from its directory to start the command-line interface.

```bash
> ./ts-cli
```

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

### Configure openGemini Single-Node

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Example configuration file structure for modifying listening addresses.

```ini
[common]
  meta-join = ["127.0.0.1:8092"]
	...

[meta]
  bind-address = "127.0.0.1:8088"
  http-bind-address = "127.0.0.1:8091"
  rpc-bind-address = "127.0.0.1:8092"
  ...

[http]
  bind-address = "127.0.0.1:8086"
  flight-address = "127.0.0.1:8087"
  ...

[data]
  store-ingest-addr = "127.0.0.1:8400"
  store-select-addr = "127.0.0.1:8401"
  ...
```

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

### Run Compiled openGemini

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Execute the standalone version using the install script or direct binary execution.

```bash
> bash ./scripts/install.sh

# OR Move to the directory where ts-server is saved, and manual running
./ts-server
```

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

### Initiate interactive rebase

Source: https://docs.opengemini.org/dev-guide/contribute/merge_commits

Starts an interactive rebase for the last n commits.

```bash
git rebase -i HEAD~n
```

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

### Get openGemini Version

Source: https://docs.opengemini.org/dev-guide/contribute/report_issue

Run this command to identify the version of the openGemini component you are using.

```bash
ts-server version # or ts-sql version / ts-store version / ts-meta version e.t.
```

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

### Start openGemini server in background

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Launches the ts-server process in the background and redirects output to a log file.

```bash
nohup ./ts-server > server_extra.log 2>&1 &
```

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

### Database Operation Effects

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Example output showing the results of database creation and listing operations.

```text
> create database db0
Elapsed: 1.446074ms
> show databases
name: databases
+------+
| name |
+------+
| db0  |
+------+
1 columns, 1 rows in set

Elapsed: 2.178147ms
>>>
```

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

### Get Operating System Details

Source: https://docs.opengemini.org/dev-guide/contribute/report_issue

Run this command in your terminal to retrieve OS information for your issue report.

```bash
uname -srm
```

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

### Data Operation Effects

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Example output showing the results of inserting data, listing measurements, and querying a table.

```text
> use db0
Elapsed: 251ns
> insert cpu_load,host=server-01,region=west_cn value=75.3
Elapsed: 162.328339ms
> show measurements
name: measurements
+----------+
| name     |
+----------+
| cpu_load |
| mst      |
+----------+
1 columns, 2 rows in set

Elapsed: 13.374945ms
> select * from cpu_load
name: cpu_load
+---------------------+-------------+-----------+-------+
| time                | host        | region    | value |
+---------------------+-------------+-----------+-------+
| 1681483835745490423 | server-01   | west_cn   | 75.3  |
+---------------------+-------------+-----------+-------+
4 columns, 1 rows in set

Elapsed: 3.259995ms
```

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

### Build openGemini from Source

Source: https://docs.opengemini.org/dev-guide/get_started/build_source_code

Navigate to the project directory and execute the build script.

```bash
cd openGemini
```

```bash
python3 build.py --clean
```

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

### Configure Go Environment Variables

Source: https://docs.opengemini.org/dev-guide/get_started/build_source_code

Add these configurations to your ~/.profile file to set up the Go environment.

```bash
# Set GOPATH (requires custom directory)
export GOPATH=/path/to/dir
# Set up domestic proxy
export GOPROXY=https://goproxy.cn,direct
# Turn on go mod mode
export GO111MODULE=on
export GONOSUMDB=*
export GOSUMDB=off
```

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

### View CLI Help

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Display available command-line options and usage information.

```bash
> ./ts-cli -h
```

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

### Navigate to Source Directory

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Change directory to the project root.

```bash
> cd openGemini
```

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

### Connect using openGemini CLI

Source: https://docs.opengemini.org/dev-guide/get_started/build_source_code

Use the CLI tool to connect to the server, specifying host and port if necessary.

```bash
./ts-cli
```

```bash
./ts-cli -host 192.168.0.1 -port 8086
```

```bash
./ts-cli -h
```

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

### Verify Build Output

Source: https://docs.opengemini.org/dev-guide/get_started/build_source_code

List the contents of the build directory to confirm the binaries were created.

```bash
> ls build
> ts-cli ts-meta ts-monitor ts-server ts-sql ts-store
```

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

### Clone and configure remote repository

Source: https://docs.opengemini.org/dev-guide/contribute/resolve_conflicts

Initializes the local repository and sets the upstream source to the main openGemini repository.

```bash
# Copy the remote fork repository to the local
git clone https://github.com/$user_name/openGemini.git

# Set the upstream source of the local working directory (forked upstream repository)
git remote add upstream https://github.com/openGemini/openGemini.git

# Set the synchronization method, here
git remote set-url --push upstream no_push
```

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

### Download openGemini Binary

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Download the latest openGemini release package using wget.

```bash
> wget https://github.com/openGemini/openGemini/releases/download/v<version>/openGemini-<version>-linux-amd64.tar.gz
```

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

### Compile openGemini

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Build the project using the provided Python build script.

```bash
> python3 build.py --clean
```

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

### Extract openGemini Package

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Create a directory and extract the downloaded tarball.

```bash
> mkdir openGemini
> tar -zxvf openGemini-<version>-linux-amd64.tar.gz -C openGemini
```

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

### Clone openGemini Repository

Source: https://docs.opengemini.org/dev-guide/get_started/build_source_code

Use git to clone the source code from GitHub.

```bash
git clone https://github.com/openGemini/openGemini.git
```

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

### Connect to a Specific Host

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Use the --host and --port flags to connect to a database instance other than the default 127.0.0.1:8086.

```bash
> ./ts-cli --host 192.168.0.1 --port 8086
```

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

### Database Management Operations

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Commands for creating, listing, and selecting a database.

```sql
> create database db0
```

```sql
> show databases
```

```sql
> use db0
```

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

### Set Go Environment Variables

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Configure Go environment variables in the shell profile.

```bash
# Set GOPATH (Need to customize directory)
export GOPATH=/path/to/dir
# Set domestic proxy
export GOPROXY=https://goproxy.cn,direct
# Open go mod mode
export GO111MODULE=on
export GONOSUMDB=*
export GOSUMDB=off
```

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

### Data Manipulation and Querying

Source: https://docs.opengemini.org/guide/quick_start/get_started.html

Commands for inserting data, listing measurements, and querying stored data.

```sql
> insert cpu_load,host=server-01,region=west_cn value=75.3
```

```sql
> show measurements
```

```sql
> select * from cpu_load
```

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

### Resolve and push conflicts

Source: https://docs.opengemini.org/dev-guide/contribute/resolve_conflicts

Stages resolved files, continues the rebase process, and force pushes the changes to the remote branch.

```bash
git add .
git rebase --continue
git push -f origin yourbranch
```

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

### Rebase feature branch

Source: https://docs.opengemini.org/dev-guide/contribute/resolve_conflicts

Switches to the working branch and rebases it against the updated main branch.

```bash
git checkout your branch
git rebase main
```

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

### View local git log

Source: https://docs.opengemini.org/dev-guide/contribute/merge_commits

Displays the commit history on the current local branch.

```bash
git log
```

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

### Force push changes

Source: https://docs.opengemini.org/dev-guide/contribute/merge_commits

Pushes the squashed commits to the remote repository, overwriting the previous history.

```bash
git push -f origin yourbranch
```

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

### Synchronize local main branch

Source: https://docs.opengemini.org/dev-guide/contribute/resolve_conflicts

Updates the local main branch with the latest changes from the upstream repository.

```bash
git checkout main
git fetch upstream
git rebase upstream/main
```

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

### Linking Issues in Pull Requests

Source: https://docs.opengemini.org/dev-guide/contribute/contribute_code

Use these formats in the pull request body to link or automatically close issues. The 'Issue Number:' prefix is mandatory for the bot to process the request.

```text
Issue Number: close #123

```

```text
Issue Number: ref #456

```

```text
Issue Number: close #123, ref #456

```
Tokens:
Raw