Create a Distinct Value Cache
Use the influxdb3 create distinct_cache command
to create a Distinct Value Cache (DVC). Provide the following:
Database (
-d,--database): (Required) The name of the database to associate the DVC with. You can also use theINFLUXDB3_DATABASE_NAMEenvironment variable to specify the database.Token (
--token): (Required) Your InfluxDB 3 Core authentication token. You can also use theINFLUXDB3_AUTH_TOKENenvironment variable to specify the token.Table (
-t,--table): (Required) The name of the table to associate the DVC with.Columns (
--columns): (Required) Specify which columns to cache distinct values for. These are typically tag columns but can also be string fields.Maximum cardinality (
--max-cardinality): Specify the maximum number of distinct value combinations to store in the cache. The default maximum cardinality is100000.Maximum age (
--max-age): Specify the maximum age of distinct values to keep in the DVC in humantime form. The default maximum age is24 hours.Cache name: A unique name for the cache. If you don’t provide one, InfluxDB automatically generates a cache name for you.
influxdb3 create distinct_cache \
--database DATABASE_NAME \
--token AUTH_TOKEN \
--table TABLE_NAME \
--columns COLUMNS \
--max-cardinality MAX_CARDINALITY \
--max-age MAX_AGE \
DVC_NAME
Replace the following:
DATABASE_NAME: the name of the database to associate the DVC withAUTH_TOKEN: your InfluxDB 3 Core authentication tokenTABLE_NAME: the name of the table to associate the DVC withCOLUMNS: a comma-delimited list of columns to cache distinct values for–for example:country,county,cityMAX_CARDINALITY: the maximum number of distinct value combinations to cache–for example:10000MAX_AGE: the maximum age of distinct values to keep in the cache in humantime form–for example:6h,1 day,1 weekDVC_NAME: a unique name for the DVC
Values are cached on write
Values are cached on write. When you create a cache, it will not cache previously written points, only newly written points.
DVC size and persistence
The DVC is stored in memory, so it’s important to consider the size and persistence of the cache. For more information, see Important things to know about the Distinct Value Cache.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB 3 Core and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.