docs-v2/content/influxdb3/clustered/reference/cli/influxctl/table/create.md

4.3 KiB

title description menu weight related
influxctl table create The `influxctl table create` command creates a new table in the specified database.
influxdb3_clustered
parent
influxctl table
301
/influxdb3/clustered/admin/custom-partitions/define-custom-partitions/
/influxdb3/clustered/admin/custom-partitions/partition-templates/

The influxctl table create command creates a new table in the specified database in an {{< product-name omit=" Clustered" >}} cluster.

Custom partitioning

You can override the default partition template (the partition template of the target database) with the --template-tag, --template-tag-bucket, and --template-timeformat flags when you create the table. Provide a time format using Rust strftime, partition by specific tag, or partition tag values into a specified number of "buckets." Each of these can be used as part of the partition template. Be sure to follow partitioning best practices.

{{% note %}}

Always provide a time format when using custom partitioning

If defining a custom partition template for your table with any of the --template-* flags, always include the --template-timeformat flag with a time format to use in your partition template. Otherwise, InfluxDB omits time from the partition template and won't compact partitions. {{% /note %}}

Usage

influxctl table create [flags] <DATABASE_NAME> <TABLE_NAME>

Arguments

Argument Description
DATABASE_NAME Name of the target database
TABLE_NAME Table name

Flags

Flag Description
--template-tag Tag to add to partition template (can include multiple of this flag)
--template-tag-bucket Tag and number of buckets to partition tag values into separated by a comma--for example: tag1,100 (can include multiple of this flag)
--template-timeformat Timestamp format for partition template
-h --help Output command help

{{% caption %}} Also see influxctl global flags. {{% /caption %}}

Examples

In the following examples, replace:

  • {{% code-placeholder-key %}}DATABASE_NAME{{% /code-placeholder-key %}}: The name of the database to create the table in.
  • {{% code-placeholder-key %}}TABLE_NAME {{% /code-placeholder-key %}}: The name of table to create.

Create a table

{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}

influxctl table create DATABASE_NAME TABLE_NAME

{{% /code-placeholders %}}

Create a table with a custom partition template

The following example creates a new table and applies a partition template that partitions by two tags (room and sensor-type) and by day using the time format %Y-%m-%d:

{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}

influxctl table create \
  --template-tag room \
  --template-tag sensor-type \
  --template-tag-bucket customerID,1000 \
  --template-timeformat '%Y-%m-%d' \
  DATABASE_NAME \
  TABLE_NAME

{{% /code-placeholders %}}

For more information about custom partitioning, see Manage data partitioning.

{{% expand "View command updates" %}}

v2.7.0

  • Introduce the --template-tag-bucket flag to group tag values into buckets and partition by each tag bucket.

{{% /expand %}}