Search...apshot(3pm)

💾 Search::Elasticsearch::Client::8_0::Direct::Snapshot 💾

okay so bestie, welcome to the Search...apshot(3pm) page — that's the manpage name, yes it's abbreviated like that, don't @ me — straight out of the User Contributed Perl Documentation. grab a snack, we're talking about backups. 🎀

✨ VERSION ✨

version 8.12 — that's the vibe check, and she passed. 💅

---

🌸 DESCRIPTION 🌸

This module is your girl for managing snapshot/restore, which is just a fancy way of saying backups, bestie. She can:

• create, get and delete configured backup repositories
• create, get, delete and restore snapshots of your whole cluster or individual indices

It does Search::Elasticsearch::Role::Client::Direct. iconic behavior honestly. 👑

---

🦋 METHODS 🦋

create_repository()

$e->snapshot->create_repository(
    repository  => 'repository',        # required
    body        => { defn }             # required
);

Create a repository for backups. that's the little home where your snapshots live, no cap. 🏠

Query string parameters:

• error_trace
• human
• master_timeout
• timeout
• verify

See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

---

get_repository()

$e->snapshot->get_repository(
    repository  => 'repository' | \@repositories    # optional
);

Retrieve existing repositories. peek at what's already there. 👀

Query string parameters:

• error_trace
• human
• local
• master_timeout

See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

---

verify_repository()

$e->snapshot->verify_repository(
    repository  => 'repository' # required
);

Verify existing repository. like a vibe check but for your backup home. ✅

Query string parameters:

• error_trace
• human
• master_timeout
• timeout

See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

---

delete_repository()

$e->snapshot->delete_repository(
    repository  => 'repository' | \@repositories    # required
);

Delete repositories by name. bye bestie, you won't be missed (jk, please double check this one 🫣).

Query string parameters:

• error_trace
• human
• master_timeout
• timeout

See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

---

create()

$e->snapshot->create(
    repository  => 'repository',     # required
    snapshot    => 'snapshot',       # required,

    body        => { snapshot defn } # optional
);

Create a snapshot of the whole cluster or individual indices in the named repository. this is the moment. the main character moment. 📸✨

Query string parameters:

• error_trace
• human
• master_timeout
• wait_for_completion

---

get()

$e->snapshot->get(
    repository  => 'repository'                   # required
    snapshot    => 'snapshot'   | \@snapshots     # required
);

Retrieve snapshots in the named repository. so you can see all your little babies. 🥹

Query string parameters:

• error_trace
• human
• ignore_unavailable
• master_timeout
• verbose

See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

---

delete()

$e->snapshot->delete(
    repository  => 'repository',              # required
    snapshot    => 'snapshot'                 # required
);

Delete snapshot in the named repository. poof. gone. 💀

Query string parameters:

• error_trace
• human
• master_timeout

See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

---

restore()

$e->snapshot->restore(
    repository  => 'repository',              # required
    snapshot    => 'snapshot'                 # required

    body        => { what to restore }        # optional
);

Restore a named snapshot. bringing it BACK, glow-up edition. 🌈

Query string parameters:

• error_trace
• human
• master_timeout
• wait_for_completion

See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

---

status()

$result = $e->snapshot->status(
    repository  => 'repository',              # optional
    snapshot    => 'snapshot' | \@snapshots   # optional
);

Returns status information about the specified snapshots. notice how this one returns a result — she's giving, and she's taking. 💅

Query string parameters:

• error_trace
• human
• ignore_unavailable
• master_timeout

See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

---

💜 AUTHOR 💜

Enrico Zimuel <enrico.zimuel@elastic.co> — the icon, the legend, the moment. 🫶

---

🎀 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

---

and that's the whole page, bestie! 💖 this beauty ships with perl v5.38.2, dated 2024-02-04 — so go forth, back up your stuff, and slay. ✨🌸 no cap, fr fr. 🦋