This is archived documentation for InfluxData product versions that are no longer maintained. For newer documentation, see the latest InfluxData documentation.
InfluxQL offers a full suite of administrative commands.
Data Management: | Retention Policy Management: |
CREATE DATABASE | CREATE RETENTION POLICY |
DROP DATABASE | ALTER RETENTION POLICY |
DROP SERIES | DROP RETENTION POLICY |
DELETE | |
DROP MEASUREMENT | |
DROP SHARD |
If you’re looking for SHOW
queries (for example, SHOW DATABASES
or SHOW RETENTION POLICIES
), see Schema Exploration.
The examples in the sections below use InfluxDB’s Command Line Interface (CLI).
You can also execute the commands using the HTTP API; simply send a GET
request to the /query
endpoint and include the command in the URL parameter q
.
See the Querying Data guide for more on using the HTTP API.
Note: When authentication is enabled, only admin users can execute most of the commands listed on this page. See the documentation on authentication and authorization for more information.
Data Management
CREATE DATABASE
Creates a new database.
Syntax
CREATE DATABASE <database_name> [WITH [DURATION <duration>] [REPLICATION <n>] [SHARD DURATION <duration>] [NAME <retention-policy-name>]]
Description of Syntax
CREATE DATABASE
requires a database name.
The WITH
, DURATION
, REPLICATION
, SHARD DURATION
, and NAME
clauses are optional and create a single retention policy associated with the created database.
If you do not specify one of the clauses after WITH
, the relevant behavior defaults to the autogen
retention policy settings.
The created retention policy automatically serves as the database’s default retention policy.
For more information about those clauses, see Retention Policy Management.
A successful CREATE DATABASE
query returns an empty result.
If you attempt to create a database that already exists, InfluxDB does nothing and does not return an error.
Examples
Example 1: Create a database
> CREATE DATABASE "NOAA_water_database"
>
The query creates a database called NOAA_water_database
.
By default, InfluxDB also creates the autogen
retention policy and associates it with the NOAA_water_database
.
Example 2: Create a database with a specific retention policy
> CREATE DATABASE "NOAA_water_database" WITH DURATION 3d REPLICATION 1 SHARD DURATION 1h NAME "liquid"
>
The query creates a database called NOAA_water_database
.
It also creates a default retention policy for NOAA_water_database
with a DURATION
of three days, a replication factor of one, a shard group duration of one hour, and with the name liquid
.
Delete a database with DROP DATABASE
The DROP DATABASE
query deletes all of the data, measurements, series, continuous queries, and retention policies from the specified database.
The query takes the following form:
DROP DATABASE <database_name>
Drop the database NOAA_water_database:
> DROP DATABASE "NOAA_water_database"
>
A successful DROP DATABASE
query returns an empty result.
If you attempt to drop a database that does not exist, InfluxDB does not return an error.
Drop series from the index with DROP SERIES
The DROP SERIES
query deletes all points from a series in a database,
and it drops the series from the index.
Note:
DROP SERIES
does not support time intervals in theWHERE
clause. SeeDELETE
for that functionality.
The query takes the following form, where you must specify either the FROM
clause or the WHERE
clause:
DROP SERIES FROM <measurement_name[,measurement_name]> WHERE <tag_key>='<tag_value>'
Drop all series from a single measurement:
> DROP SERIES FROM "h2o_feet"
Drop series with a specific tag pair from a single measurement:
> DROP SERIES FROM "h2o_feet" WHERE "location" = 'santa_monica'
Drop all points in the series that have a specific tag pair from all measurements in the database:
> DROP SERIES WHERE "location" = 'santa_monica'
A successful DROP SERIES
query returns an empty result.
Delete series with DELETE
The DELETE
query deletes all points from a
series in a database.
Unlike
DROP SERIES
, it does not drop the series from the index and it supports time intervals
in the WHERE
clause.
The query takes the following form where you must include either the FROM
clause or the WHERE
clause, or both:
DELETE FROM <measurement_name> WHERE [<tag_key>='<tag_value>'] | [<time interval>]
Delete all data associated with the measurement h2o_feet
:
> DELETE FROM "h2o_feet"
Delete all data associated with the measurement h2o_quality
and where the tag randtag
equals 3
:
> DELETE FROM "h2o_quality" WHERE "randtag" = '3'
Delete all data in the database that occur before January 01, 2016:
> DELETE WHERE time < '2016-01-01'
A successful DELETE
query returns an empty result.
Things to note about DELETE
:
DELETE
supports regular expressions in theFROM
clause when specifying measurement names and in theWHERE
clause when specifying tag values.DELETE
does not support fields in theWHERE
clause.- If you need to delete points in the future, you must specify that time period as
DELETE SERIES
runs fortime < now()
by default. Syntax
Delete measurements with DROP MEASUREMENT
The DROP MEASUREMENT
query deletes all data and series from the specified measurement and deletes the
measurement from the index.
The query takes the following form:
DROP MEASUREMENT <measurement_name>
Delete the measurement h2o_feet
:
> DROP MEASUREMENT "h2o_feet"
Note:
DROP MEASUREMENT
drops all data and series in the measurement. It does not drop the associated continuous queries.
A successful DROP MEASUREMENT
query returns an empty result.
Currently, InfluxDB does not support regular expressions with DROP MEASUREMENTS
.
See GitHub Issue #4275 for more information.
Delete a shard with DROP SHARD
The DROP SHARD
query deletes a shard. It also drops the shard from the
metastore.
The query takes the following form:
DROP SHARD <shard_id_number>
Delete the shard with the id 1
:
> DROP SHARD 1
>
A successful DROP SHARD
query returns an empty result.
InfluxDB does not return an error if you attempt to drop a shard that does not
exist.
Retention Policy Management
The following sections cover how to create, alter, and delete retention policies.
Note that when you create a database, InfluxDB automatically creates a retention policy named autogen
which has infinite retention.
You may rename that retention policy or disable its auto-creation in the configuration file.
Create retention policies with CREATE RETENTION POLICY
Syntax
CREATE RETENTION POLICY <retention_policy_name> ON <database_name> DURATION <duration> REPLICATION <n> [SHARD DURATION <duration>] [DEFAULT]
Description of Syntax
DURATION
The DURATION
clause determines how long InfluxDB keeps the data.
The <duration>
is a duration literal
or INF
(infinite).
The minimum duration for a retention policy is one hour and the maximum
duration is INF
.
REPLICATION
The REPLICATION
clause determines how many independent copies of each point
are stored in the cluster, where n
is the number of data nodes.
Replication factors do not serve a purpose with single node instances.
SHARD DURATION
The SHARD DURATION
clause determines the time range covered by a shard group.
The <duration>
is a duration literal
and does not support an INF
(infinite) duration.
This setting is optional.
By default, the shard group duration is determined by the retention policy’s
DURATION
:
Retention Policy’s DURATION | Shard Group Duration |
---|---|
< 2 days | 1 hour |
>= 2 days and <= 6 months | 1 day |
> 6 months | 7 days |
The minimum allowable SHARD GROUP DURATION
is 1h
.
If the CREATE RETENTION POLICY
query attempts to set the SHARD GROUP DURATION
to less than 1h
and greater than 0s
, InfluxDB automatically sets the SHARD GROUP DURATION
to 1h
.
If the CREATE RETENTION POLICY
query attempts to set the SHARD GROUP DURATION
to 0s
, InfluxDB automatically sets the SHARD GROUP DURATION
according to the default settings listed above.
See Shard Group Duration Management for recommended configurations.
DEFAULT
Sets the new retention policy as the default retention policy for the database.
This setting is optional.
Examples
Example 1: Create a retention policy
> CREATE RETENTION POLICY "one_day_only" ON "NOAA_water_database" DURATION 1d REPLICATION 1
>
The query creates a retention policy called one_day_only
for the database
NOAA_water_database
with a one day duration and a replication factor of one.
Example 2: Create a DEFAULT retention policy
> CREATE RETENTION POLICY "one_day_only" ON "NOAA_water_database" DURATION 23h60m REPLICATION 1 DEFAULT
>
The query creates the same retention policy as the one in the example above, but sets it as the default retention policy for the database.
A successful CREATE RETENTION POLICY
query returns an empty response.
If you attempt to create a retention policy identical to one that already exists, InfluxDB does not return an error.
If you attempt to create a retention policy with the same name as an existing retention policy but with differing attributes, InfluxDB returns an error.
Note: You can also specify a new retention policy in the
CREATE DATABASE
query. See Create a database with CREATE DATABASE.
Modify retention policies with ALTER RETENTION POLICY
The ALTER RETENTION POLICY
query takes the following form, where you must declare at least one of the retention policy attributes DURATION
, REPLICATION
, SHARD DURATION
, or DEFAULT
:
ALTER RETENTION POLICY <retention_policy_name> ON <database_name> DURATION <duration> REPLICATION <n> SHARD DURATION <duration> DEFAULT
Replication factors do not serve a purpose with single node instances.
First, create the retention policy what_is_time
with a DURATION
of two days:
> CREATE RETENTION POLICY "what_is_time" ON "NOAA_water_database" DURATION 2d REPLICATION 1
>
Modify what_is_time
to have a three week DURATION
, a 30 minute shard group duration, and make it the DEFAULT
retention policy for NOAA_water_database
.
> ALTER RETENTION POLICY "what_is_time" ON "NOAA_water_database" DURATION 3w SHARD DURATION 30m DEFAULT
>
In the last example, what_is_time
retains its original replication factor of 1.
A successful ALTER RETENTION POLICY
query returns an empty result.
Delete retention policies with DROP RETENTION POLICY
Delete all measurements and data in a specific retention policy with:
DROP RETENTION POLICY <retention_policy_name> ON <database_name>
Delete the retention policy what_is_time
in the NOAA_water_database
database:
> DROP RETENTION POLICY "what_is_time" ON "NOAA_water_database"
>
A successful DROP RETENTION POLICY
query returns an empty result.
If you attempt to drop a retention policy that does not exist, InfluxDB does not return an error.