4.2 KiB
title | description | menu | weight | list_code_example | related | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Create a table | Use the [`influxctl table create` command](/influxdb3/clustered/reference/cli/influxctl/table/create/) to create a new table in a specified database your InfluxDB cluster. Provide the database name and a table name. |
|
201 | ```sh influxctl table create <DATABASE_NAME> <TABLE_NAME> ``` |
|
Use the influxctl table create
command
to create a table in a specified database in your
{{< product-name omit=" Clustered" >}} cluster.
With {{< product-name >}}, tables and measurements are synonymous. Typically, tables are created automatically on write using the measurement name specified in line protocol written to InfluxDB. However, to apply a custom partition template to a table, you must manually create the table before you write any data to it.
-
If you haven't already, download and install the
influxctl
CLI. -
Run the
influxctl table create
command and provide the following:- Optional: InfluxDB tags to use in the partition template
- Optional: InfluxDB tag buckets to use in the partition template
- Optional: A Rust strftime date and time string
that specifies the time format in the partition template and determines
the time interval to partition by (default is
%Y-%m-%d
) - The name of the database to create the table in
- The name of the table to create (see Table naming restrictions)
[!Note] {{< product-name >}} supports up to 7 total tags or tag buckets in the partition template.
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
influxctl table create \
--template-tag tag1 \
--template-tag tag2 \
--template-tag-bucket tag3,100 \
--template-tag-bucket tag4,300 \
--template-timeformat '%Y-%m-%d' \
DATABASE_NAME \
TABLE_NAME
{{% /code-placeholders %}}
Custom partitioning
{{< product-name >}} lets you define a custom partitioning strategy for each table. A partition is a logical grouping of data stored in Apache Parquet format in the InfluxDB 3 storage engine. By default, data is partitioned by day, but, depending on your schema and workload, customizing the partitioning strategy can improve query performance.
Use the --template-tag
, --template-tag-bucket
, and --template-timeformat
flags to define partition template parts used to generate partition keys for the table.
If no template flags are provided, the table uses the partition template of the
target database.
For more information, see Manage data partitioning.
[!Warning]
Partition templates can only be applied on create
You can only apply a partition template when creating a table. You can't update a partition template on an existing table.
Table naming restrictions
Table names in {{< product-name >}} must adhere to the following naming restrictions:
- Allowed characters: Alphanumeric characters (a-z, A-Z, 0-9), underscore (
_
), dash (-
) - Starting character: Should start with a letter or number and should not start with underscore (
_
) - Case sensitivity: Table names are case-sensitive
- Quoting: Use double quotes when names contain special characters or whitespace
[!Caution]
Underscore prefix reserved for system use
Names starting with an underscore (
_
) may be reserved for InfluxDB system use. While {{< product-name >}} might not explicitly reject these names, using them risks conflicts with current or future system features and may result in unexpected behavior or data loss.