Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/influxdb/v2.0/reference/api/influxdb-1x/dbrp.md

3.5 KiB
Raw Blame History

title description menu weight products related
Database and retention policy mapping The database and retention policy (DBRP) mapping service maps InfluxDB 1.x database and retention policy combinations to InfluxDB 2.0 buckets.
influxdb_2_0_ref
name parent
DBRP mapping 1.x compatibility
302
cloud
/influxdb/v2.0/reference/api/influxdb-1x/query
/influxdb/v2.0/reference/api/influxdb-1x/write
/influxdb/v2.0/api/#tag/DBRPs, InfluxDB 2.0 API /dbrps endpoint

The InfluxDB 1.x data model includes databases and retention policies. InfluxDB 2.0 replaces both with buckets. To support InfluxDB 1.x query and write patterns in InfluxDB 2.0, databases and retention policies are mapped to buckets using the database and retention policy (DBRP) mapping service.

The DBRP mapping service uses the database and retention policy specified in compatibility API requests to route operations to a bucket. Create DBRP mappings automatically with the /write compatibility endpoint or create DBRP mappings manually using the /api/v2/dbrps API endpoint.

Default retention policies

A database can have multiple retention policies with one set as default. If no retention policy is specified in a query or write request, InfluxDB uses the default retention policy for the specified database.

DBRP mapping behavior

When writing data

When writing data to InfluxDB 2.0 using the /write compatibility endpoint, the DBRP mapping service checks for a bucket mapped to the database and retention policy:

  • If a mapped bucket is found, data is written to the bucket.

  • If an unmapped bucket with a name matching:

    • database/retention policy exists, a DBRP mapping is added to the bucket, and data is written to the bucket.
    • database exists (without a specified retention policy), the default database retention policy is used, a DBRP mapping is added to the bucket, and data is written to the bucket.

  • If no matching bucket is found, a new database/retention-policy bucket is created with a DBRP mapping, and data is written to the bucket. If no retention policy is specified, autogen is used.

    {{% note %}} To automatically create new buckets, the authentication token used for the write request must be an All Access token. {{% /note %}}

    {{% note %}} To automatically create new buckets, the authentication token used for the write request must be an All Access token. {{% /note %}}

For step-by-step instructions on mapping a bucket to a database and retention policy, see Query data with InfluxQL.

When querying data

When querying data from InfluxDB 2.0 using the /query compatibility endpoint, the DBRP mapping service checks for the specified database and retention policy (if no retention policy is specified, the database's default retention policy is used):

  • If a mapped bucket exists, data is queried from the mapped bucket.
  • If no mapped bucket exists, InfluxDB returns an error.