Snapshot Client
- class opensearchpy.client.snapshot.SnapshotClient(client)[source]
Bases:
NamespacedClient
- cleanup_repository(repository, params=None, headers=None)[source]
Removes stale data from repository.
- Parameters:
repository – A repository name
(Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection to master node
cluster_manager_timeout – Explicit operation timeout for connection to cluster_manager node
timeout – Explicit operation timeout
- clone(repository, snapshot, target_snapshot, body, params=None, headers=None)[source]
Clones indices from one snapshot into another snapshot in the same repository.
- Parameters:
repository – A repository name
snapshot – The name of the snapshot to clone from
target_snapshot – The name of the cloned snapshot to create
body – The snapshot clone definition
(Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection to master node
cluster_manager_timeout – Explicit operation timeout for connection to cluster_manager node
- create(repository, snapshot, body=None, params=None, headers=None)[source]
Creates a snapshot in a repository.
- Parameters:
repository – A repository name
snapshot – A snapshot name
body – The snapshot definition
(Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection to master node
cluster_manager_timeout – Explicit operation timeout for connection to cluster_manager node
wait_for_completion – Should this request wait until the operation has completed before returning
- create_repository(repository, body, params=None, headers=None)[source]
Creates a repository.
- Parameters:
repository – A repository name
body – The repository definition
(Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection to master node
cluster_manager_timeout – Explicit operation timeout for connection to cluster_manager node
timeout – Explicit operation timeout
verify – Whether to verify the repository after creation
- delete(repository, snapshot, params=None, headers=None)[source]
Deletes a snapshot.
- Parameters:
repository – A repository name
snapshot – A snapshot name
(Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection to master node
cluster_manager_timeout – Explicit operation timeout for connection to cluster_manager node
- delete_repository(repository, params=None, headers=None)[source]
Deletes a repository.
- Parameters:
repository – Name of the snapshot repository to unregister. Wildcard (*) patterns are supported.
(Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection to master node
cluster_manager_timeout – Explicit operation timeout for connection to cluster_manager node
timeout – Explicit operation timeout
- get(repository, snapshot, params=None, headers=None)[source]
Returns information about a snapshot.
- Parameters:
repository – A repository name
snapshot – A comma-separated list of snapshot names
ignore_unavailable – Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
include_repository – Whether to include the repository name in the snapshot info. Defaults to true.
index_details – Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
(Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection to master node
cluster_manager_timeout – Explicit operation timeout for connection to cluster_manager node
verbose – Whether to show verbose snapshot info or only show the basic info found in the repository index blob
- get_repository(repository=None, params=None, headers=None)[source]
Returns information about a repository.
- Parameters:
repository – A comma-separated list of repository names
local – Return local information, do not retrieve the state from cluster_manager node (default: false)
(Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection to master node
cluster_manager_timeout – Explicit operation timeout for connection to cluster_manager node
- repository_analyze(repository, params=None, headers=None)[source]
Analyzes a repository for correctness and performance
- Parameters:
repository – A repository name
blob_count – Number of blobs to create during the test. Defaults to 100.
concurrency – Number of operations to run concurrently during the test. Defaults to 10.
detailed – Whether to return detailed results or a summary. Defaults to ‘false’ so that only the summary is returned.
early_read_node_count – Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the ‘rare_action_probability’ parameter is also relevant. Defaults to 2.
max_blob_size – Maximum size of a blob to create during the test, e.g ‘1gb’ or ‘100mb’. Defaults to ‘10mb’.
max_total_data_size – Maximum total size of all blobs to create during the test, e.g ‘1tb’ or ‘100gb’. Defaults to ‘1gb’.
rare_action_probability – Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02.
rarely_abort_writes – Whether to rarely abort writes before they complete. Defaults to ‘true’.
read_node_count – Number of nodes on which to read a blob after writing. Defaults to 10.
seed – Seed for the random number generator used to create the test workload. Defaults to a random value.
timeout – Explicit operation timeout. Defaults to ’30s’.
- restore(repository, snapshot, body=None, params=None, headers=None)[source]
Restores a snapshot.
- Parameters:
repository – A repository name
snapshot – A snapshot name
body – Details of what to restore
(Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection to master node
cluster_manager_timeout – Explicit operation timeout for connection to cluster_manager node
wait_for_completion – Should this request wait until the operation has completed before returning
- status(repository=None, snapshot=None, params=None, headers=None)[source]
Returns information about the status of a snapshot.
- Parameters:
repository – A repository name
snapshot – A comma-separated list of snapshot names
ignore_unavailable – Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
(Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection to master node
cluster_manager_timeout – Explicit operation timeout for connection to cluster_manager node
- verify_repository(repository, params=None, headers=None)[source]
Verifies a repository.
- Parameters:
repository – A repository name
(Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection to master node
cluster_manager_timeout – Explicit operation timeout for connection to cluster_manager node
timeout – Explicit operation timeout