influxdata / influxdata/influxdb-client-python

Add examples for BackupService and RestoreService

Open
#617 3 comments 0 reactions 1 assignee Claimed by @trevorbonas View on GitHub
good first issue
Dominant language
Python
Stars
793
Forks
186
Avg merge
3h 2m
Merged PRs (30d)
1

Description

__Proposal:__
Add examples demonstrating how to use the `BackupService` and `RestoreService` as they are both currently undocumented.

__Current behavior:__
Examples are missing apart from brief comments in the source code.

__Desired behavior:__
It would be nice to have examples demonstrating how to use both services, possibly in the `examples` directory or in the README. Personally, I would like to use `BackupService` and `RestoreService` to perform migrations but am unsure how to use these services.

__Alternatives considered:__
Other alternatives to the BackupService and RestoreService is using the Influx CLI with Python subprocess calls, but this is less testable and not preferred.

__Use case:__
Performing backups or restores using the InfluxDB Python client would be much easier with documentation.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.