1Search::Elasticsearch::UCsleirenCtoS:ne:ta8rr_ic0bh:u::t:DeEidlraePscettri:lc:sCDeCoaRcr(uc3mh)e:n:tCaltiieonnt::8_0::Direct::CCR(3)
2
6 Search::Elasticsearch::Client::8_0::Direct::CCR - Plugin providing
7 cross-cluster replication APIs for Search::Elasticsearch 8.x
8
10 version 8.00
11 DESCRIPTION
13 This module provides methods to use the cross-cluster replication
14 feature.
15 The full documentation for CCR is available here:
17 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-apis.html>
18
20 follow()
21 $response = $es->ccr->follow(
22 index => $index, # required
23 body => {...} # required
24 )
25 The follow() method creates a new follower index that is configured to
27 follow the referenced leader index.
28 Query string parameters:
30 "error_trace",
31 "filter_path",
32 "human",
33 "wait_for_active_shards"
34 See the CCR follow docs
36 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-
37 put-follow.html> for more information.
38 pause_follow()
40 $response = $es->ccr->pause_follow(
41 index => $index, # required
42 )
43 The pause_follow() method pauses following of an index.
45 Query string parameters:
47 "error_trace",
48 "filter_path",
49 "human"
50 See the CCR pause follow docs
52 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-
53 post-pause-follow.html> for more information.
54 resume_follow()
56 $response = $es->ccr->resume_follow(
57 index => $index, # required
58 )
59 The resume_follow() method resumes following of an index.
61 Query string parameters:
63 "error_trace",
64 "filter_path",
65 "human"
66 See the CCR resume follow docs
68 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-
69 post-resume-follow.html> for more information.
70 unfollow()
72 $response = $es->ccr->unfollow(
73 index => $index, # required
74 )
75 The unfollow() method converts a follower index into a normal index.
77 Query string parameters:
79 "error_trace",
80 "filter_path",
81 "human"
82 See the CCR unfollow docs
84 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-
85 post-unfollow.html> for more information.
86 forget_follower()
88 $response = $es->ccr->forget_follower(
89 index => $index, # required
90 )
91 The forget_follower() method removes the follower retention leases from
93 the leader.
94 Query string parameters:
96 "error_trace",
97 "filter_path",
98 "human"
99 See the CCR forget_follower docs
101 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-
102 post-forget-follower.html> for more information.
103
105 stats()
106 $response = $es->ccr->stats()
107 The stats() method returns all stats related to cross-cluster
109 replication.
110 Query string parameters:
112 "error_trace",
113 "filter_path",
114 "human"
115 See the CCR stats docs
117 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-
118 get-stats.html> for more information.
119 follow_stats()
121 $response = $es->ccr->follow_stats(
122 index => $index | \@indices, # optional
123 )
124 The follow_stats() method returns shard-level stats about follower
126 indices.
127 Query string parameters:
129 "error_trace",
130 "filter_path",
131 "human"
132 See the CCR follow stats docs
134 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-
135 get-follow-stats.html> for more information.
136 follow_info()
138 $response = $es->ccr->follow_info(
139 index => $index | \@indices, # optional
140 )
141 The follow_info() method returns the parameters and the status for each
143 follower index.
144 Query string parameters:
146 "error_trace",
147 "filter_path",
148 "human"
149 See the CCR follow info docs
151 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-
152 get-follow-info.html> for more information.
153
155 put_auto_follow_pattern()
156 $response = $es->ccr->put_auto_follow_pattern(
157 name => $name # required
158 )
159 The put_auto_follow_pattern() method creates a new named collection of
161 auto-follow patterns against the remote cluster specified in the
162 request body.
163 Query string parameters:
165 "error_trace",
166 "filter_path",
167 "human"
168 See the CCR put auto follow pattern docs
170 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-
171 put-auto-follow-pattern.html> for more information.
172 get_auto_follow_pattern()
174 $response = $es->ccr->get_auto_follow_pattern(
175 name => $name # optional
176 )
177 The get_auto_follow_pattern() method retrieves a named collection of
179 auto-follow patterns, or all patterns.
180 Query string parameters:
182 "error_trace",
183 "filter_path",
184 "human"
185 See the CCR get auto follow pattern docs
187 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-
188 get-auto-follow-pattern.html> for more information.
189 delete_auto_follow_pattern()
191 $response = $es->ccr->delete_auto_follow_pattern(
192 name => $name # required
193 )
194 The delete_auto_follow_pattern() method deletes a named collection of
196 auto-follow patterns.
197 Query string parameters:
199 "error_trace",
200 "filter_path",
201 "human"
202 See the CCR delete auto follow pattern docs
204 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-
205 delete-auto-follow-pattern.html> for more information.
206
208 Enrico Zimuel <enrico.zimuel@elastic.co>
209
211 This software is Copyright (c) 2022 by Elasticsearch BV.
212 This is free software, licensed under:
214 The Apache License, Version 2.0, January 2004
216perl v5.38.0 Search2:0:2E3l-a0s7t-i2c1search::Client::8_0::Direct::CCR(3)