DESCRIPTION¶

This module provides methods to use the cross-cluster replication feature.

The full documentation for CCR is available here: <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-apis.html>

follow()¶

    $response = $es->ccr->follow(
        index   => $index,  # required
        body    => {...}    # required
    )

The follow() method creates a new follower index that is configured to follow the referenced leader index.

Query string parameters:
"error_trace",
"filter_path",
"human",
"wait_for_active_shards"

See the CCR follow docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html> for more information.

pause_follow()¶

    $response = $es->ccr->pause_follow(
        index   => $index,  # required
    )

The pause_follow() method pauses following of an index.

Query string parameters:
"error_trace",
"filter_path",
"human"

See the CCR pause follow docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html> for more information.

resume_follow()¶

    $response = $es->ccr->resume_follow(
        index   => $index,  # required
    )

The resume_follow() method resumes following of an index.

Query string parameters:
"error_trace",
"filter_path",
"human"

See the CCR resume follow docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html> for more information.

unfollow()¶

    $response = $es->ccr->unfollow(
        index   => $index,  # required
    )

The unfollow() method converts a follower index into a normal index.

Query string parameters:
"error_trace",
"filter_path",
"human"

See the CCR unfollow docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html> for more information.

forget_follower()¶

    $response = $es->ccr->forget_follower(
        index   => $index,  # required
    )

The forget_follower() method removes the follower retention leases from the leader.

Query string parameters:
"error_trace",
"filter_path",
"human"

See the CCR forget_follower docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html> for more information.

stats()¶

    $response = $es->ccr->stats()

The stats() method returns all stats related to cross-cluster replication.

Query string parameters:
"error_trace",
"filter_path",
"human"

See the CCR stats docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html> for more information.

follow_stats()¶

    $response = $es->ccr->follow_stats(
        index   => $index | \@indices,  # optional
    )

The follow_stats() method returns shard-level stats about follower indices.

Query string parameters:
"error_trace",
"filter_path",
"human"

See the CCR follow stats docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html> for more information.

follow_info()¶

    $response = $es->ccr->follow_info(
        index   => $index | \@indices,  # optional
    )

The follow_info() method returns the parameters and the status for each follower index.

Query string parameters:
"error_trace",
"filter_path",
"human"

See the CCR follow info docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html> for more information.

put_auto_follow_pattern()¶

    $response = $es->ccr->put_auto_follow_pattern(
        name    => $name    # required
    )

The 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:
"error_trace",
"filter_path",
"human"

See the CCR put auto follow pattern docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html> for more information.

get_auto_follow_pattern()¶

    $response = $es->ccr->get_auto_follow_pattern(
        name    => $name    # optional
    )

The get_auto_follow_pattern() method retrieves a named collection of auto-follow patterns, or all patterns.

Query string parameters:
"error_trace",
"filter_path",
"human"

See the CCR get auto follow pattern docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html> for more information.

delete_auto_follow_pattern()¶

    $response = $es->ccr->delete_auto_follow_pattern(
        name    => $name    # required
    )

The delete_auto_follow_pattern() method deletes a named collection of auto-follow patterns.

Query string parameters:
"error_trace",
"filter_path",
"human"

See the CCR delete auto follow pattern docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html> for more information.