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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
package Search::Elasticsearch::Client::8_0::Direct::CCR;
$Search::Elasticsearch::Client::8_0::Direct::CCR::VERSION = '8.12';
use Moo;
with 'Search::Elasticsearch::Client::8_0::Role::API';
with 'Search::Elasticsearch::Role::Client::Direct';
use Search::Elasticsearch::Util qw(parse_params);
use namespace::clean;
__PACKAGE__->_install_api('ccr');
1;
=pod
=encoding UTF-8
=head1 NAME
Search::Elasticsearch::Client::8_0::Direct::CCR - Plugin providing cross-cluster replication APIs for Search::Elasticsearch 8.x
=head1 VERSION
version 8.12
=head2 DESCRIPTION
This module provides methods to use the cross-cluster replication feature.
The full documentation for CCR is available here:
L<https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-apis.html>
=head1 FOLLOW METHODS
=head2 C<follow()>
$response = $es->ccr->follow(
index => $index, # required
body => {...} # required
)
The C<follow()> method creates a new follower index that is configured to follow the referenced leader index.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>,
C<wait_for_active_shards>
See the L<CCR follow docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html>
for more information.
=head2 C<pause_follow()>
$response = $es->ccr->pause_follow(
index => $index, # required
)
The C<pause_follow()> method pauses following of an index.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<CCR pause follow docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html>
for more information.
=head2 C<resume_follow()>
$response = $es->ccr->resume_follow(
index => $index, # required
)
The C<resume_follow()> method resumes following of an index.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<CCR resume follow docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html>
for more information.
=head2 C<unfollow()>
$response = $es->ccr->unfollow(
index => $index, # required
)
The C<unfollow()> method converts a follower index into a normal index.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<CCR unfollow docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html>
for more information.
=head2 C<forget_follower()>
$response = $es->ccr->forget_follower(
index => $index, # required
)
The C<forget_follower()> method removes the follower retention leases from the leader.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<CCR forget_follower docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html>
for more information.
=head1 STATS METHODS
=head2 C<stats()>
$response = $es->ccr->stats()
The C<stats()> method returns all stats related to cross-cluster replication.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<CCR stats docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html>
for more information.
=head2 C<follow_stats()>
$response = $es->ccr->follow_stats(
index => $index | \@indices, # optional
)
The C<follow_stats()> method returns shard-level stats about follower indices.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<CCR follow stats docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html>
for more information.
=head2 C<follow_info()>
$response = $es->ccr->follow_info(
index => $index | \@indices, # optional
)
The C<follow_info()> method returns the parameters and the status for each follower index.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<CCR follow info docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html>
for more information.
=head1 AUTO-FOLLOW METHODS
=head2 C<put_auto_follow_pattern()>
$response = $es->ccr->put_auto_follow_pattern(
name => $name # required
)
The C<put_auto_follow_pattern()> method creates a new named collection of auto-follow patterns against the remote cluster specified in the request body.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<CCR put auto follow pattern docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html>
for more information.
=head2 C<get_auto_follow_pattern()>
$response = $es->ccr->get_auto_follow_pattern(
name => $name # optional
)
The C<get_auto_follow_pattern()> method retrieves a named collection of auto-follow patterns, or all patterns.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<CCR get auto follow pattern docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html>
for more information.
=head2 C<delete_auto_follow_pattern()>
$response = $es->ccr->delete_auto_follow_pattern(
name => $name # required
)
The C<delete_auto_follow_pattern()> method deletes a named collection of auto-follow patterns.
Query string parameters:
C<error_trace>,
C<filter_path>,
C<human>
See the L<CCR delete auto follow pattern docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html>
for more information.
=head1 AUTHOR
Enrico Zimuel <enrico.zimuel@elastic.co>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2024 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
__END__
# ABSTRACT: Plugin providing cross-cluster replication APIs for Search::Elasticsearch 8.x
|
