Search...apshot(3pm)

📦
version 6.81 · 3 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

💖 Search::Elasticsearch::Client::1_0::Direct::Snapshot 💖

okay so. bestie. this is a Perl module — a client for managing snapshot/restore, from the Search::Elasticsearch::Client::1_0::Direct family. it lives in the User Contributed Perl Documentation section of your man pages, so that's the manual we're vibing in. 🫶

✨ VERSION ✨

version 6.81 — yes she's got a version number, she's official. 👑

🌸 DESCRIPTION 🌸

This module provides methods to manage snapshot/restore, or backups. It can create, get and delete configured backup repositories, and create, get, delete and restore snapshots of your cluster or indices.

so like… it's the backup bestie. it makes repos, it inspects them, it yeets them, and it does the same for snapshots of your whole cluster or just some lil indices. everything is organized. everything is cute. nothing is lost. 🎀

also it does Search::Elasticsearch::Role::Client::Direct — that's the role it's consuming, 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. like, show me what repos I already have, bestie 🕵️♀️

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. vibe check on your repo, basically ✨

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. goodbye, repo 💀👋

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 moment fr fr

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. 🗑️

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. bringing it BACK, the comeback era 🦋🔥

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. ⏳ cute lil progress report

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> — ty king 🫶

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

okay that's the whole page, bestie, no skips no skimming. 💖 this gem is perl v5.36.0, dated 2022-08-28, from the User Contributed Perl Documentation section. slay, go make some backups, periodt. ✨🎀🦋

📦 where this page comes from