1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
<?php
namespace Elastica;
use Elastica\Exception\NotFoundException;
use Elastica\Exception\ResponseException;
/**
* Class Snapshot.
*
* @link http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
*/
class Snapshot
{
/**
* @var Client
*/
protected $_client;
/**
* @param Client $client
*/
public function __construct(Client $client)
{
$this->_client = $client;
}
/**
* Register a snapshot repository.
*
* @param string $name the name of the repository
* @param string $type the repository type ("fs" for file system)
* @param array $settings Additional repository settings. If type "fs" is used, the "location" setting must be provided.
*
* @return Response
*/
public function registerRepository($name, $type, $settings = array())
{
$data = array(
'type' => $type,
'settings' => $settings,
);
return $this->request($name, Request::PUT, $data);
}
/**
* Retrieve a repository record by name.
*
* @param string $name the name of the desired repository
*
* @throws Exception\ResponseException
* @throws Exception\NotFoundException
*
* @return array
*/
public function getRepository($name)
{
try {
$response = $this->request($name);
} catch (ResponseException $e) {
if ($e->getResponse()->getStatus() == 404) {
throw new NotFoundException("Repository '".$name."' does not exist.");
}
throw $e;
}
$data = $response->getData();
return $data[$name];
}
/**
* Retrieve all repository records.
*
* @return array
*/
public function getAllRepositories()
{
return $this->request('_all')->getData();
}
/**
* Create a new snapshot.
*
* @param string $repository the name of the repository in which this snapshot should be stored
* @param string $name the name of this snapshot
* @param array $options optional settings for this snapshot
* @param bool $waitForCompletion if true, the request will not return until the snapshot operation is complete
*
* @return Response
*/
public function createSnapshot($repository, $name, $options = array(), $waitForCompletion = false)
{
return $this->request($repository.'/'.$name, Request::PUT, $options, array('wait_for_completion' => $waitForCompletion));
}
/**
* Retrieve data regarding a specific snapshot.
*
* @param string $repository the name of the repository from which to retrieve the snapshot
* @param string $name the name of the desired snapshot
*
* @throws Exception\ResponseException
* @throws Exception\NotFoundException
*
* @return array
*/
public function getSnapshot($repository, $name)
{
try {
$response = $this->request($repository.'/'.$name);
} catch (ResponseException $e) {
if ($e->getResponse()->getStatus() == 404) {
throw new NotFoundException("Snapshot '".$name."' does not exist in repository '".$repository."'.");
}
throw $e;
}
$data = $response->getData();
return $data['snapshots'][0];
}
/**
* Retrieve data regarding all snapshots in the given repository.
*
* @param string $repository the repository name
*
* @return array
*/
public function getAllSnapshots($repository)
{
return $this->request($repository.'/_all')->getData();
}
/**
* Delete a snapshot.
*
* @param string $repository the repository in which the snapshot resides
* @param string $name the name of the snapshot to be deleted
*
* @return Response
*/
public function deleteSnapshot($repository, $name)
{
return $this->request($repository.'/'.$name, Request::DELETE);
}
/**
* Restore a snapshot.
*
* @param string $repository the name of the repository
* @param string $name the name of the snapshot
* @param array $options options for the restore operation
* @param bool $waitForCompletion if true, the request will not return until the restore operation is complete
*
* @return Response
*/
public function restoreSnapshot($repository, $name, $options = array(), $waitForCompletion = false)
{
return $this->request($repository.'/'.$name.'/_restore', Request::POST, $options, array('wait_for_completion' => $waitForCompletion));
}
/**
* Perform a snapshot request.
*
* @param string $path the URL
* @param string $method the HTTP method
* @param array $data request body data
* @param array $query query string parameters
*
* @return Response
*/
public function request($path, $method = Request::GET, $data = array(), array $query = array())
{
return $this->_client->request('/_snapshot/'.$path, $method, $data, $query);
}
}
|
