Class BackupAPI

Backup API

Index

Constructors

Methods

getBackupKV getBackupMetadata getBackupShardId

Constructors

constructor

new BackupAPI(influxDB: InfluxDB): BackupAPI
Creates BackupAPI
Parameters
- influxDB: InfluxDB
  an instance that knows how to communicate with InfluxDB server
Returns BackupAPI
- Defined in apis/src/generated/BackupAPI.ts:24

Methods

getBackupKV

getBackupKV(
request?: GetBackupKVRequest,
requestOptions?: RequestOptions,
): Promise<string>
Download snapshot of metadata stored in the server's embedded KV store. Don't use with InfluxDB versions greater than InfluxDB 2.1.x. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBackupKV
Parameters
- Optionalrequest: GetBackupKVRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/BackupAPI.ts:34

getBackupMetadata

getBackupMetadata(
request?: GetBackupMetadataRequest,
requestOptions?: RequestOptions,
): Promise<MetadataBackup>
Download snapshot of all metadata in the server. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBackupMetadata
Parameters
- Optionalrequest: GetBackupMetadataRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<MetadataBackup>
promise of response
- Defined in apis/src/generated/BackupAPI.ts:52

getBackupShardId

getBackupShardId(
request: GetBackupShardIdRequest,
requestOptions?: RequestOptions,
): Promise<string>
Download snapshot of all TSM data in a shard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBackupShardId
Parameters
- request: GetBackupShardIdRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/BackupAPI.ts:70