influx v1 dbrp update

  • influx CLI 2.0.2+
  • InfluxDB 2.0.1+

This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.

The influx v1 dbrp update command updates a DBRP mapping in the InfluxDB 1.x compatibility API.

Usage

  1. influx v1 dbrp update [flags]

Flags

FlagDescriptionInput typeMaps to ?
-c—active-configConfig name to use for commandstringINFLUX_ACTIVE_CONFIG
—configs-pathPath to the influx CLI configurations (default: ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
—defaultSet DBRP mapping’s retention policy as default
-h—helpHelp for the update command
—hide-headersHide the table headers (default: false)INFLUX_HIDE_HEADERS
—hostHTTP address of InfluxDBstringINFLUX_HOST
—id(Required) DBRP IDstring
—jsonOutput data as JSON (default: false)INFLUX_OUTPUT_JSON
-o—orgOrganization name (mutually exclusive with —org-id)stringINFLUX_ORG
—org-idOrganization ID (mutually exclusive with —org)stringINFLUX_ORG_ID
-r—rpInfluxDB v1 retention policy to map from
—skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t—tokenAPI tokenstringINFLUX_TOKEN

Examples

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by either the active influx CLI configuration or by environment variables (INFLUX_HOST, INFLUX_ORG, and INFLUX_TOKEN). If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:

  • --host: InfluxDB host
  • -o, --org or --org-id: InfluxDB organization name or ID
  • -t, --token: InfluxDB API token
Set a DBRP mapping as default
  1. influx v1 dbrp update \
  2.   --id 12ab34cd56ef78 \
  3.   --default
Update the retention policy of a DBRP mapping
  1. influx v1 dbrp update \
  2.   --id 12ab34cd56ef78 \
  3.   --rp new-rp-name

DBRP