9.0 KiB
title | description | menu | weight | list_code_example | related | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create a database | Use the [`influxctl database create` command](/influxdb3/clustered/reference/cli/influxctl/database/create/) to create a new InfluxDB database in your InfluxDB cluster. Provide a database name and an optional retention period. |
|
201 | <!--pytest.mark.skip--> ##### CLI ```sh influxctl database create \ --retention-period 30d \ --max-tables 500 \ --max-columns 250 \ DATABASE_NAME ``` |
|
Use the influxctl database create
command
to create a database in your {{< product-name omit=" Clustered" >}} cluster.
-
If you haven't already, download and install the
influxctl
CLI. -
Run the
influxctl database create
command and provide the following:- Optional: Database retention period (default is infinite)
- Optional: Database table (measurement) limit (default is 500)
- Optional: Database column limit (default is 250)
- 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
) - Database name (see Database naming restrictions)
{{% note %}} {{< product-name >}} supports up to 7 total tags or tag buckets in the partition template. {{% /note %}}
{{% code-placeholders "DATABASE_NAME|30d|500|200" %}}
influxctl database create \
--retention-period 30d \
--max-tables 500 \
--max-columns 250 \
--template-tag tag1 \
--template-tag tag2 \
--template-tag-bucket tag3,100 \
--template-tag-bucket tag4,300 \
--template-timeformat '%Y-%m-%d' \
DATABASE_NAME
{{% /code-placeholders %}}
- Retention period syntax
- Database naming restrictions
- InfluxQL DBRP naming convention
- Table and column limits
Retention period syntax
Use the --retention-period
flag to define a specific
retention period
for the database.
The retention period value is a time duration value made up of a numeric value
plus a duration unit.
For example, 30d
means 30 days.
A zero duration (0d
) retention period is infinite and data won't expire.
The retention period value cannot be negative or contain whitespace.
{{< flex >}} {{% flex-content "half" %}}
Valid durations units include
- m: minute
- h: hour
- d: day
- w: week
- mo: month
- y: year
{{% /flex-content %}} {{% flex-content "half" %}}
Example retention period values
0d
: infinite/none3d
: 3 days6w
: 6 weeks1mo
: 1 month (30 days)1y
: 1 year30d30d
: 60 days2.5d
: 60 hours
{{% /flex-content %}} {{< /flex >}}
Database naming restrictions
Database names must adhere to the following naming restrictions:
- Cannot contain whitespace, punctuation, or special characters.
Only alphanumeric, underscore (
_
), dash (-
), and forward-slash (/
) characters are permitted. - Should not start with an underscore (
_
). - Maximum length of 64 characters.
InfluxQL DBRP naming convention
In InfluxDB 1.x, data is stored in databases and retention policies. In {{% product-name %}}, databases and retention policies have been merged into databases, where databases have a retention period, but retention policies are no longer part of the data model. Because InfluxQL uses the 1.x data model, a database must be mapped to a v1 database and retention policy (DBRP) to be queryable with InfluxQL.
When naming a database that you want to query with InfluxQL, use the following naming convention to automatically map v1 DBRP combinations to an {{% product-name %}} database:
database_name/retention_policy_name
Database naming examples
v1 Database name | v1 Retention Policy name | New database name |
---|---|---|
db | rp | db/rp |
telegraf | autogen | telegraf/autogen |
webmetrics | 1w-downsampled | webmetrics/1w-downsampled |
Table and column limits
In {{< product-name >}}, table (measurement) and column limits can be
configured using the --max-tables
and --max-columns
flags.
Table limit
Default maximum number of tables: 500
Each measurement is represented by a table in a database. Your database's table limit can be raised beyond the default limit of 500. InfluxData has production examples of clusters with 20,000+ active tables across multiple databases.
Increasing your table limit affects your {{% product-name omit=" Clustered" %}} cluster in the following ways:
{{< expand-wrapper >}} {{% expand "May improve query performance View more info" %}}
Schemas with many measurements that contain focused sets of tags and fields can make it easier for the query engine to identify what partitions contain the queried data, resulting in better query performance.
{{% /expand %}} {{% expand "More PUTs into object storage View more info" %}}
By default, {{< product-name >}} partitions
data by measurement and time range and stores each partition as a Parquet
file in your cluster's object store. By increasing the number of measurements
(tables) you can store in your database, you also increase the potential for
more PUT
requests into your object store as InfluxDB creates more partitions.
Each PUT
request incurs a monetary cost and will increase the operating cost of
your cluster.
{{% /expand %}} {{% expand "More work for the compactor View more info" %}}
To optimize storage over time, your {{< product-name omit=" Clustered" >}} cluster contains a compactor that routinely compacts Parquet files in object storage. With more tables and partitions to compact, the compactor may need to be scaled (either vertically or horizontally) to keep up with demand, adding to the operating cost of your cluster.
{{% /expand %}} {{< /expand-wrapper >}}
Column limit
Default maximum number of columns: 250
Time, fields, and tags are each represented by a column in a table. Increasing your column limit affects your {{% product-name omit=" Clustered" %}} cluster in the following ways:
{{< expand-wrapper >}} {{% expand "May adversely affect query performance" %}}
At query time, the InfluxDB query engine identifies what table contains the queried data and then evaluates each row in the table to match the conditions of the query. The more columns that are in each row, the longer it takes to evaluate each row.
Through performance testing, InfluxData has identified 250 columns as the threshold beyond which query performance may be affected (depending on the shape of and data types in your schema).
{{% /expand %}} {{< /expand-wrapper >}}
Custom partitioning
{{< product-name >}} lets you define a custom partitioning strategy for each database. 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 database.
For more information, see Manage data partitioning.
{{% warn %}}
Partition templates can only be applied on create
You can only apply a partition template when creating a database. You can't update a partition template on an existing database. {{% /warn %}}