Class RestoreAPI

Restore API

Index

Constructors

Methods

postRestoreBucketID postRestoreBucketMetadata postRestoreKV postRestoreShardId postRestoreSQL

Constructors

constructor

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

Methods

postRestoreBucketID

postRestoreBucketID(
request: PostRestoreBucketIDRequest,
requestOptions?: RequestOptions,
): Promise<string>
Overwrite storage metadata for a bucket with shard info from a backup. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostRestoreBucketID
Parameters
- request: PostRestoreBucketIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/RestoreAPI.ts:91

postRestoreBucketMetadata

postRestoreBucketMetadata(
request: PostRestoreBucketMetadataRequest,
requestOptions?: RequestOptions,
): Promise<RestoredBucketMappings>
Create a new bucket pre-seeded with shard info from a backup. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostRestoreBucketMetadata
Parameters
- request: PostRestoreBucketMetadataRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<RestoredBucketMappings>
promise of response
- Defined in apis/src/generated/RestoreAPI.ts:110

postRestoreKV

postRestoreKV(
request: PostRestoreKVRequest,
requestOptions?: RequestOptions,
): Promise<{ token?: string }>
Overwrite the embedded KV store on the server with a backed-up snapshot. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostRestoreKV
Parameters
- request: PostRestoreKVRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<{ token?: string }>
promise of response
- Defined in apis/src/generated/RestoreAPI.ts:50

postRestoreShardId

postRestoreShardId(
request: PostRestoreShardIdRequest,
requestOptions?: RequestOptions,
): Promise<void>
Restore a TSM snapshot into a shard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostRestoreShardId
Parameters
- request: PostRestoreShardIdRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/RestoreAPI.ts:129

postRestoreSQL

postRestoreSQL(
request: PostRestoreSQLRequest,
requestOptions?: RequestOptions,
): Promise<void>
Overwrite the embedded SQL store on the server with a backed-up snapshot. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostRestoreSQL
Parameters
- request: PostRestoreSQLRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/RestoreAPI.ts:72