influxdb3 create table

The influxdb3 create table command creates a new table in a specified database. Tables must include at least one tag column and can optionally include field columns with defined data types.

Usage

# Syntax
influxdb3 create table [OPTIONS] \
  --tags [<TAGS>...] \
  --database <DATABASE_NAME> \
  --token <AUTH_TOKEN> \
  <TABLE_NAME>

Arguments

• TABLE_NAME: The name of the table to create.

Options

Field data types

Use the following data types when defining field columns with --fields:

Provide each field as NAME:TYPE–for example, temp:float64. Separate multiple fields with commas: --fields temp:float64,hum:float64,co:int64.

Option environment variables

You can use the following environment variables to set options instead of passing them via CLI flags:

Examples

In the examples below, replace the following:

• DATABASE_NAME: The database name
• AUTH_TOKEN: The authentication token
• TABLE_NAME: A name for the new table

Create an empty table

influxdb3 create table \
  --tags tag1,tag2,tag3 \
  --database 
DATABASE_NAME
 \
  --token 
AUTH_TOKEN
 \
  
TABLE_NAME

Create a table with tag and field columns

influxdb3 create table \
  --tags room,sensor_id \
  --fields temp:float64,hum:float64,co:int64 \
  --database 
DATABASE_NAME
 \
  --token 
AUTH_TOKEN
 \
  
TABLE_NAME

Verification

Use the SHOW TABLES query to verify that the table was created successfully:

influxdb3 query \
  --database my_test_db \
  --token 
AUTH_TOKEN
 \
  "SHOW TABLES"

Example output:

+---------------+--------------------+----------------------------+------------+
| table_catalog | table_schema       | table_name                 | table_type |
+---------------+--------------------+----------------------------+------------+
| public        | iox                | my_sensor_table            | BASE TABLE |
| public        | system             | distinct_caches            | BASE TABLE |
| public        | system             | last_caches                | BASE TABLE |
| public        | system             | parquet_files              | BASE TABLE |
+---------------+--------------------+----------------------------+------------+

Relation to schema mode

InfluxDB 3 Core databases use one of two schema modes, set when you create the database:

• implicit (default): influxdb3 create table is optional. InfluxDB 3 Core creates tables and columns automatically from the line protocol you write.
• explicit (InfluxDB 3 Enterprise only) : influxdb3 create table is how you declare a table’s tag and field columns before writing to it. A write that names a table or column you haven’t declared is rejected. Add columns to a declared table later with the influxdb3 update table command.

In both modes, influxdb3 create table accepts the same options and defines the table the same way. The schema mode only changes what happens when a write references a table or column that create table hasn’t defined.