Search...apshot(3pm)

💖 Search::Elasticsearch::Client::2_0::Direct::Snapshot — the manual, but make it make sense 💖

okay so bestie, you found the page for Search::Elasticsearch::Client::2_0::Direct::Snapshot (perl doc, 3pm section, we love a manpage moment) — and lemme tell you, it's giving backup queen. 🎀

---

✨ VERSION ✨

version 6.81 — yes, that's the one, no cap. 🦋

---

🌸 DESCRIPTION 🌸

So this module is literally your little bestie for managing snapshot/restore, aka backups, and honestly? iconic.

Here's the vibe: it can

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

That's it, that's the whole serve. Periodt.

Also it does Search::Elasticsearch::Role::Client::Direct — so it's carrying that role's energy, iykyk. 💅

---

👑 METHODS 👑

create_repository()

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

Create a repository for backups. 🫶

Query string parameters:

• 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. 👀

Query string parameters:

• 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. ✅ (yes bestie, we're checking the receipts)

Query string parameters:

• 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 felicia

Query string parameters:

• 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. 📸✨ (main character energy, honestly)

Query string parameters:

• master_timeout
• wait_for_completion

---

get()

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

Retrieve snapshots in the named repository. 🍓

Query string parameters:

• master_timeout

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. 😭 gone but not forgotten

Query string parameters:

• 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. 🧚 the glow-up era, we're bringing it all back

Query string parameters:

• 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. 📊 vibe check on your backups, fr fr

Query string parameters:

• 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> — shoutout, legend behavior 🌟

---

🌈 COPYRIGHT AND LICENSE 🌈

This software is Copyright (c) 2020 by Elasticsearch BV.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

---

ok that's the whole page bestie, you ate 💅

and a lil' sign-off for you: this one's running on perl v5.32.0, dated 2020-11-25, from the Search...apshot(3pm) page itself. mwah. 🎀💖✨