InfluxDB 3

https://docs.influxdata.com/influxdb3/
Admin
InfluxDB 3 is a time-series database designed for operational maturity, making it easier to deploy,...
Tokens:2,716,346
Snippets:31,418
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start Example Application

Source: https://docs.influxdata.com/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/browser/index.md

Command to start the browser example application at http://localhost:3001/examples/index.html.

```bash
npm run browser
```

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

### Setup project directory

Source: https://docs.influxdata.com/influxdb3/cloud-dedicated/get-started/query?t=

Creates and enters a new directory for the query example.

```bash
mkdir -p influx3-query-example && cd influx3-query-example
```

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

### Example of starting a load capture

Source: https://docs.influxdata.com/influxdb3/enterprise/reference/cli/influxdb3/loadcap/start/index.md

A concrete example showing how to start a 5-minute capture of both write and query requests on a local InfluxDB 3 Enterprise instance.

```bash
influxdb3 loadcap start \
  --host http://localhost:8181 \
  --token AUTH_TOKEN \
  --type both \
  --duration 5m
```

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

### Start server with license email via environment variables

Source: https://docs.influxdata.com/influxdb3/enterprise/admin/license?t=Docker+compose

Example commands to set license email and type using environment variables before starting the server.

```bash
export INFLUXDB3_LICENSE_EMAIL=
EMAIL_ADDRESS

export INFLUXDB3_
LICENSE_TYPE
=
LICENSE_TYPE


influxdb3 serve \
--cluster-id CLUSTER_ID \
--node-id NODE_ID \
# ...
```

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

### Start a backup response

Source: https://docs.influxdata.com/influxdb3/enterprise/api/backup-and-restore/index.md

Example response body indicating the backup has started.

```json
{
  "backup_name": "nightly-backup",
  "status": "in_progress"
}
```

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

### Basic Docker setup

Source: https://docs.influxdata.com/influxdb3/explorer/install/index.md

Basic installation methods using either a direct docker run command or a docker-compose.yml file.

```bash
docker run --detach \
  --name influxdb3-explorer \
  --publish 127.0.0.1:8888:8080 \
  influxdata/influxdb3-ui:1.9.0
```

```yaml
# docker-compose.yml
version: '3.8'

services:
  explorer:
    image: influxdata/influxdb3-ui:1.9.0
    container_name: influxdb3-explorer
    ports:
      - "127.0.0.1:8888:8080"
    volumes:
      - ./config:/app-root/config:ro
    restart: unless-stopped
```

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

### Install and configure license on Linux/macOS

Source: https://docs.influxdata.com/influxdb3/enterprise/admin/license/index.md

Copy the license file, set permissions, update the configuration, and start the service.

```bash
sudo cp /path/to/commercial-license.jwt /etc/influxdb3/license.jwt
sudo chown influxdb3:influxdb3 /etc/influxdb3/license.jwt
sudo chmod 600 /etc/influxdb3/license.jwt
```

```text
license-file = "/etc/influxdb3/license.jwt"
```

```bash
sudo systemctl start influxdb3-enterprise
```

```bash
influxdb3 show license --host http://localhost:8181
```

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

### Start server with license email via CLI

Source: https://docs.influxdata.com/influxdb3/enterprise/admin/license?t=Docker+compose

Example command to provide license email and type using CLI flags.

```bash
influxdb3 serve \
--cluster-id CLUSTER_ID \
--node-id NODE_ID \
--license-type LICENSE_TYPE \
--license-email EMAIL_ADDRESS \
# ...
```

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

### Logarithm query example

Source: https://docs.influxdata.com/influxdb3/enterprise/reference/sql/functions/math/index.md

Example query demonstrating log calculations with different bases.

```sql
SELECT
  temp,
  log(2, temp) AS temp_log2,
  log(4, temp) AS temp_log4,
  log(temp) AS temp_log10
FROM home
LIMIT 3
```

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

### Base-10 logarithm query example

Source: https://docs.influxdata.com/influxdb3/enterprise/reference/sql/functions/math/index.md

Example query demonstrating the log10 function.

```sql
SELECT log10(temp) AS log10 FROM home LIMIT 3
```

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

### Minimal development setup with Docker Compose

Source: https://docs.influxdata.com/influxdb3/explorer/install

A basic docker-compose.yml configuration for running the Explorer in development mode.

```yaml
# docker-compose.yml
version: '3.8'

services:
  explorer:
    image: influxdata/influxdb3-ui:1.9.0
    container_name: influxdb3-explorer
    ports:
      - "127.0.0.1:8888:8080"
```

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

### Minimal development setup with Docker

Source: https://docs.influxdata.com/influxdb3/explorer/install

A simple command to run the Explorer container for development purposes using default settings.

```bash
docker run --rm \
  --name influxdb3-explorer \
  --publish 127.0.0.1:8888:8080 \
  influxdata/influxdb3-ui:1.9.0
```

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

### Start Docker Compose services

Source: https://docs.influxdata.com/influxdb3/explorer/install

Starts the services defined in the docker-compose.yml file in detached mode.

```bash
docker-compose up -d
```

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

### Start InfluxDB 3 with offline permission tokens

Source: https://docs.influxdata.com/influxdb3/enterprise/reference/config-options/index.md

Generate permission tokens offline and start the server using the --permission-tokens-file flag.

```bash
# Generate an admin token offline
influxdb3 create token \
  --name "example-token" \
  --permission "db:db1,db2:read,write" \
  --permission "db:db3:read" \
  --expiry 1d \
  --offline \
  --create-databases db1,db2 \
  --output-file ./path/to/tokens.json

# Start InfluxDB 3 Enterprise using the generated token
influxdb3 serve --permission-tokens-file ./path/to/tokens.json
```

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

### Run Explorer with SSL via Docker

Source: https://docs.influxdata.com/influxdb3/explorer/install/index.md

Start the Explorer container with SSL enabled by mounting the local SSL directory.

```bash
docker run --detach \
  --name influxdb3-explorer \
  --publish 127.0.0.1:8888:8443 \
  --volume $(pwd)/ssl:/etc/nginx/ssl:ro \
  influxdata/influxdb3-ui:1.9.0
```

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

### SQL range function examples

Source: https://docs.influxdata.com/influxdb3/enterprise/reference/sql/functions/array/index.md

Examples of using the range function with integers, dates, and timestamps.

```sql
SELECT range(1, 5, 1) AS range
```

```sql
SELECT
  range(
    DATE '2025-03-01',
    DATE '2025-08-01',
    INTERVAL '1 month'
  ) AS range
```

```sql
SELECT
  range(
    '2025-01-01T00:00:00Z'::timestamp,
    '2025-01-01T06:00:00Z'::timestamp,
    INTERVAL '2 hours'
  ) AS range
```

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

### Run Explorer container with Docker

Source: https://docs.influxdata.com/influxdb3/explorer/install

Start the Explorer container using the docker run command with a mounted volume for data persistence.

```bash
docker run --detach \
  --name influxdb3-explorer \
  --publish 127.0.0.1:8888:8080 \
  --volume $(pwd)/db:/db:rw \
  influxdata/influxdb3-ui:1.9.0
```

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

### Start InfluxDB 3 Enterprise with offline admin token

Source: https://docs.influxdata.com/influxdb3/enterprise/reference/config-options

Commands to generate an offline admin token and start the server using that file.

```bash
# Generate an admin token offline
influxdb3 create token \
  --admin \
  --name "example-admin-token" \
  --expiry 1d \
  --offline \
  --output-file 
./path/to/admin-token.json


# Start InfluxDB 3 Enterprise using the generated token
influxdb3 serve --admin-token-file 
./path/to/admin-token.json
```

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

### Run Explorer container

Source: https://docs.influxdata.com/influxdb3/explorer/install

Starts the InfluxDB 3 Explorer container and maps port 8888 on the host to 8080 in the container.

```bash
docker run --detach \
  --name influxdb3-explorer \
  --publish 127.0.0.1:8888:8080 \
  influxdata/influxdb3-ui:1.9.0
```

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

### Start InfluxDB 3 Explorer with Docker

Source: https://docs.influxdata.com/influxdb3/explorer/index.md

Use these commands to pull the official Docker image and run the container in admin mode.

```sh
# Pull the Docker image
docker pull influxdata/influxdb3-ui

# Run the Docker container
docker run --detach \
  --name influxdb3-explorer \
  --publish 8080:8080 \
  --publish 8443:8443 \
  influxdata/influxdb3-ui \
  --mode=admin

# Visit http://localhost:8080 in your browser to begin using InfluxDB 3 Explorer
```

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

### Run Explorer container with Docker Compose

Source: https://docs.influxdata.com/influxdb3/explorer/install

Start the Explorer container using a Docker Compose configuration file with a mounted volume for data persistence.

```yaml
version: '3.8'

services:
  explorer:
    image: influxdata/influxdb3-ui:1.9.0
    container_name: influxdb3-explorer
    ports:
      - "127.0.0.1:8888:8080"
    volumes:
      - ./db:/db:rw
    restart: unless-stopped
```

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

### Pull latest Explorer image

Source: https://docs.influxdata.com/influxdb3/explorer/install

Updates the local image to the latest version before starting the container.

```bash
docker pull influxdata/influxdb3-ui:1.9.0
```

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

### Run Explorer with SSL enabled

Source: https://docs.influxdata.com/influxdb3/explorer/install

Commands to start the InfluxDB 3 Explorer container with SSL support using Docker or Docker Compose.

```bash
docker run --detach \
  --name influxdb3-explorer \
  --publish 127.0.0.1:8888:8443 \
  --volume $(pwd)/ssl:/etc/nginx/ssl:ro \
  influxdata/influxdb3-ui:1.9.0
```

```yaml
version: '3.8'

services:
  explorer:
    image: influxdata/influxdb3-ui:1.9.0
    container_name: influxdb3-explorer
    ports:
      - "127.0.0.1:8888:8443"
    volumes:
      - ./ssl:/etc/nginx/ssl:ro
    restart: unless-stopped
```

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

### tz query example from Getting Started data

Source: https://docs.influxdata.com/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date

An example of applying the tz function to a column named time from the home table.

```sql
SELECT tz(time, 'Australia/Sydney') AS time_tz, time FROM home ORDER BY time LIMIT 3;
```

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

### Complete example write script

Source: https://docs.influxdata.com/influxdb3/clustered/reference/client-libraries/v2/go/index.md

A full example script demonstrating how to initialize the client, create a point, write it to the database, and close the client.

```go
package main

import (
      "context"
      "fmt"
      "time"

      "github.com/influxdata/influxdb-client-go/v2"
)

func main() {
    bucket := "DATABASE_NAME"
    org := "ignored"
    token := "DATABASE_TOKEN"
    // Store the URL of your InfluxDB instance
    url := "https://cluster-host.com"
    // Create new client with default option for server url authenticate by token
    client := influxdb2.NewClient(url, token)
    // User blocking write client for writes to desired bucket
    writeAPI := client.WriteAPIBlocking(org, bucket)
    // Create point using full params constructor
    p := influxdb2.NewPoint("stat",
        map[string]string{"unit": "temperature"},
        map[string]interface{}{"avg": 24.5, "max": 45},
        time.Now())
    // Write point immediately
    writeAPI.WritePoint(context.Background(), p)
    // Ensures background processes finishes
    client.Close()
}
```

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

### Initialize a client example

Source: https://docs.influxdata.com/influxdb3/core/reference/client-libraries/flight/python-flightsql-dbapi

Example of instantiating a FlightSQLClient with host, token, metadata, and feature configuration.

```python
from flightsql import FlightSQLClient

# Instantiate a FlightSQLClient configured for a database
client = FlightSQLClient(host='localhost:8181',
                        token='
DATABASE_TOKEN
',
                        metadata={'database': '
DATABASE_NAME
'},
                        features={'metadata-reflection': 'true'})
```

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

### array_prepend example

Source: https://docs.influxdata.com/influxdb3/cloud-dedicated/reference/sql/functions/array/index.md

Example usage of array_prepend to add 1 to the start of an array.

```sql
SELECT array_prepend(1, [2, 3, 4]) AS array_prepend
```

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

### Complete write example

Source: https://docs.influxdata.com/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write/index.md

A full example demonstrating the instantiation, configuration, point creation, and flushing process in a single script.

```javascript
'use strict'
/** @module write
 * Writes a data point to InfluxDB using the JavaScript client library with Node.js.
**/

import {InfluxDB, Point} from '@influxdata/influxdb-client'

/**
 * Instantiate the InfluxDB client
 * with a configuration object.
 **/
const influxDB = new InfluxDB({url: process.env.INFLUX_URL,
                              token: process.env.INFLUX_TOKEN})

/**
 * Create a write client from the getWriteApi method.
 * Provide your org and database.
 **/
const writeApi = influxDB.getWriteApi(process.env.INFLUX_ORG,
                                      process.env.INFLUX_DATABASE)

/**
 * Apply default tags to all points.
 **/
writeApi.useDefaultTags({region: 'west'})

/**
 * Create a point and write it to the buffer.
 **/
const point1 = new Point('temperature')
  .tag('sensor_id', 'TLM01')
  .floatField('value', 24.0)
console.log(` ${point1}`)

writeApi.writePoint(point1)

/**
 * Flush pending writes and close writeApi.
 **/
writeApi.close().then(() => {
  console.log('WRITE FINISHED')
})
```

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

### starts_with query example

Source: https://docs.influxdata.com/influxdb3/cloud-dedicated/reference/sql/functions/string

Example testing if the room column starts with the substring 'Kit'.

```sql
SELECT DISTINCT
  room,
  starts_with(room::STRING, 'Kit') AS starts_with
FROM home
```

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

### instr query example

Source: https://docs.influxdata.com/influxdb3/cloud-dedicated/reference/sql/functions/string

Example usage of instr to find the starting position of a substring.

```sql
SELECT
  string,
  instr(string, 'neighbor') AS instr
FROM
  (values ('good neighbor'),
          ('bad neighbor'),
          ('next-door neighbor'),
          ('friend')
  ) data(string)
```

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

### Complete example write script

Source: https://docs.influxdata.com/influxdb3/cloud-dedicated/reference/client-libraries/v2/go/index.md

A full example demonstrating the initialization, writing, and closing process for the InfluxDB Go client.

```go
package main

import (
      "context"
      "fmt"
      "time"

      "github.com/influxdata/influxdb-client-go/v2"
)

func main() {
    bucket := "DATABASE_NAME"
    org := "ignored"
    token := "DATABASE_TOKEN"
    // Store the URL of your InfluxDB instance
    url := "https://cluster-id.a.influxdb.io"
    // Create new client with default option for server url authenticate by token
    client := influxdb2.NewClient(url, token)
    // User blocking write client for writes to desired bucket
    writeAPI := client.WriteAPIBlocking(org, bucket)
    // Create point using full params constructor
    p := influxdb2.NewPoint("stat",
        map[string]string{"unit": "temperature"},
        map[string]interface{}{"avg": 24.5, "max": 45},
        time.Now())
    // Write point immediately
    writeAPI.WritePoint(context.Background(), p)
    // Ensures background processes finishes
    client.Close()
}
```

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

### array_position example with index offset

Source: https://docs.influxdata.com/influxdb3/cloud-dedicated/reference/sql/functions/array/index.md

Example usage of array_position with a starting index offset.

```sql
SELECT array_position([1, 2, 2, 3, 1, 4], 2, 3) AS array_position
```

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

### influxctl token get example

Source: https://docs.influxdata.com/influxdb3/cloud-dedicated/reference/cli/influxctl/token/get/index.md

Example command to retrieve information for a specific token ID.

```sh
influxctl token get TOKEN_ID
```
Tokens:
Raw