Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
INFLUXD-RESTORE(1)					      INFLUXD-RESTORE(1)

NAME
     influxd-restore  - Restores databases or specific shards to an InfluxDB OSS
     instance  from  the  specified  PATH.  Complete   documentation   for   the
     '-portable'  restore  method  described here, and the deprecated legacy re-
     store format, is  located	here:  https://docs.influxdata.com/influxdb/lat-
     est/administration/backup_and_restore/

SYNOPSIS
     influxd restore -portable [options] PATH

DESCRIPTION
     Uses backup copies from the specified PATH to restore databases or specific
     shards  from  InfluxDB  OSS  or  InfluxDB Enterprise to an InfluxDB OSS in-
     stance.

OPTIONS
     Note: Restore using the -portable option consumes files in an improved  En-
     terprise-compatible format that includes a file manifest.

     -portable
	 Required  to  activate the portable restore mode. If not specified, the
	 legacy restore mode is used.

     -host <host:port>
	 InfluxDB OSS host to connect to where the data will  be  restored.  De-
	 faults to 127.0.0.1:8088.

     -db <db_name>
	 Name  of  database  to be restored from the backup (InfluxDB OSS or In-
	 fluxDB Enterprise)

     -newdb <newdb_name>
	 Name of the InfluxDB OSS database into which the archived data will  be
	 imported  on  the target system. Optional. If not given, then the value
	 of -db <db_name> is used. The new database name must be unique  to  the
	 target system.

     -rp <rp_name>
	 Name  of  retention  policy  from the backup that will be restored. Op-
	 tional. Requires that -db <db_name> is specified.

     -newrp <newrp_name>
	 Name of the retention policy to be created on the  target  system.  Op-
	 tional.  Requires  that  -rp  <rp_name>  is  set. If not given, the -rp
	 <rp_name> value is used.

     -shard <shard_id>
	 Identifier of the shard to be restored. Optional.  If	specified,  then
	 -db <db_name> and -rp <rp_name> are required.

     PATH Path to directory containing the backup files.

SEE ALSO
     influxd-backup(1)

BUGS
     Report  bugs  to the GitHub issue tracker https://github.com/influxdata/in-
     fluxdb.

AUTHORS
     InfluxDB is written and maintained by InfluxData https://influxdata.com.

COPYRIGHT
     InfluxDB is released under the MIT license.

     This man page is released under Creative Commons Attribution  4.0	Interna-
     tional License.

				   08/27/2026		      INFLUXD-RESTORE(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=influxd-restore&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help