influx-backup 1.0.1 | Documentation

influx-backup

1.0.1

BackupManager ▸
- Instance members
- #init
- #createDir
- #deleteDir
- #backup
- #loadBackup
- #restore
- #dropDatabase
influxd
spawnProcess

Need help reading this?

BackupManager

Backup manager instance.

new BackupManager(config: Object)

Parameters

config (Object) Manager object configuration.

Name	Description
config.db `string`	The name of the database
config.username `string?`	InfluxDB user username
config.password `string?`	InfluxDB user password
config.host `string` (default `localhost`)	Host url where influxdb is running.
config.port `number` (default `8086`)	InfluxDB port.
config.tmp_folder `string` (default `.tmp`)	Temporary folder path.
config.suffix `string` (default `_bak`)	Backup database suffix.
config.retation `string` (default `autogen`)	InfluxDB retation policy to backup.
config.port `number` (default `8088`)	InfluxDB backup port.

Instance Members

▸ init()

Inits the backup manager, checks influxDB version and creates the temporary files folder (if doesn't exists).

init()

▸ createDir()

Creates an empty directory in temporary folder.

createDir(): Promise

Returns

Promise: A promise object with the path to the directory created.

▸ deleteDir(path)

Deletes a directory and all its content.

deleteDir(path: any): Promise<boolean>

Parameters

path (any)

Returns

Promise<boolean>: A promise object that resolves if dir is correctly deleted.

▸ backup(options?)

Start a backup process. Once the backup is done a zip file will be created with all backup genereted files.

backup(options: Object?): Promise<string>

Parameters

options (Object?) Backup options.

Name	Description
options.start `Date?`	Start date of the backup.
options.end `Date` (default `newDate()`)	End date of the backup.
options.fileName `string?`	Custom output backup file name.

Returns

Promise<string>: A promise object with the path to the backup zip file.

▸ loadBackup()

Sideload a backup database to the existing database. Once finished deletes the backup database automatically

loadBackup(): Promise<boolean>

Returns

Promise<boolean>: A promise object that resolves once the database is correctly loaded

▸ restore(restore_path, fileName)

Start a restore. Loads a backup into a backup database, once finished deletes the restore directory.

restore(restore_path: string, fileName: string): Promise<Boolean>

Parameters

restore_path (string) The directory path of the backup zip file.

fileName (string) Name of backup the zip file.

Returns

Promise<Boolean>: A promise object that resolves once the influxd restore command has load all datas in the backup database.

▸ dropDatabase(name)

Drops an influx database (if it exists).

dropDatabase(name: string): Promise<boolean>

Parameters

name (string) The database name.

Returns

Promise<boolean>: A priomise object that resolves once the db is deleted correctly or even if it doesn't exists.

influxd

Creates a queue for influxd commands.

influxd(path: string, args: Array): Promise<boolean>

Parameters

path (string) The cwd path of influxd command (the directory where the command will be executed).

args (Array) Array of args to pass to the influxd command.

Returns

Promise<boolean>: a promise object that resolves once the influxd command has finished.

spawnProcess

Spawn an influxd process and calls resolve once ended.

spawnProcess(path: string, args: Array, resolve: Function, reject: Function)

Parameters

path (string) The cwd path of influxd command (the directory where the command will be executed).

args (Array) Array of args to pass to the influxd command.

resolve (Function) Function to call once the command has finished.

reject (Function) Function to call in case of errors.