Search...apshot(3pm)

📦 version 7.715, in ubuntu jammy

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

okay bestie, you know that page you keep landing on in the 3pm section — yes, the one with the truncated name that looks like Search...apshot(3pm)? That's this one. Say hi to the module that handles all your backup business. 💖

✨ NAME ✨

Search::Elasticsearch::Client::7_0::Direct::Snapshot — literally a whole client for managing snapshot/restore. Backups, bestie. The "oh no I deleted production" insurance. 🫶

🌸 VERSION 🌸

version 7.715

🦋 DESCRIPTION 🦋

This module hands you methods to manage snapshot/restore, aka backups. It can:

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

It does Search::Elasticsearch::Role::Client::Direct. slay.

👑 METHODS 👑

💅 create_repository()

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

Create a repository for backups. Your little storage closet, but make it official. ✨

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. It's giving "let me see what we're working with". 👀

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. vibe check on your backup closet, no cap. ✅

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. okay so this one removes them — be so serious when you call it, bestie. 😭

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. main character moment for your data. 👑

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.

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. gone, reduced to atoms. 💀 (fr fr, there's no undo button here.)

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. the comeback arc we've all been waiting for. 🫶

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. the "are we there yet" method. 💅

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>

This software is Copyright (c) 2021 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 little icon was built against perl v5.32.1 and last got its glow-up on 2021-10-23 — mwah, go back up your cluster now. ✨🫶
📦 where this page comes from