Search...Rollup(3pm)

📦 version 7.715, in ubuntu jammy

💖 Search::Elasticsearch::Client::7_0::Direct::Rollup — the Search...Rollup page, bestie edition

okay so this is a page from User Contributed Perl Documentation, and it's the Search...Rollup(3pm) one. It's the Perl docs for the rollup plugin. Strap in. 🎀

✨ NAME ✨

Search::Elasticsearch::Client::7_0::Direct::Rollup — it's the plugin that hands you Rollups for Search::Elasticsearch 7.x. That's it, that's the whole name section. 💅

🌸 VERSION 🌸

version 7.715 — yes, very specific, we love that for it.

🦋 SYNOPSIS 🦋

my $response = $es->rollup->search( body => {...} )

that's the vibe. one line. iconic. ✨

💜 DESCRIPTION 💜

So basically this class extends the Search::Elasticsearch client by bolting on a whole "rollup" namespace, and that namespace exists to support the Rollup APIs over at <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-apis.html>.

If you want the full full documentation for the Rollups feature itself (not just this Perl wrapper), it lives here: <https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html>

👑 GENERAL METHODS 👑

$response = $es->rollup->search(
    index   => $index | \@indices,      # optional
    body    => {...}                    # optional
)

The "search()" method runs a totally normal search, except — plot twist — it can join results from ordinary indices together with results from rolled up indices. bestie behavior fr fr. 🔥

Query string parameters it takes:

  • "error_trace"
  • "filter_path"
  • "human"
  • "typed_keys"

See the rollup search docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-search.html> for more info.

🧚 JOB METHODS 🧚

🌈 "put_job()"

$response = $es->rollup->put_job(
    id      => $id,                     # required
    body    => {...}                    # optional
)

The "put_job()" method creates a rollup job, and that job will rollup matching indices into a rolled up index in the background. lowkey magical. ✨

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the rollup create job docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-put-job.html> for more info.

💀 "delete_job()"

$response = $es->rollup->delete_job(
    id      => $id,                     # required
)

The "delete_job()" method deletes a rollup job, by ID. bye girl 💅

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the rollup delete job docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-delete-job.html> for more info.

🫶 "get_jobs()"

$response = $es->rollup->get_jobs(
    id      => $id,     # optional
)

The "get_job()" method retrieves a rollup job by ID, or all jobs if you don't specify one. (yes the heading says get_jobs() and the prose says "get_job()" — we are simply reporting the lore as written, no notes 📝)

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the rollup get jobs docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-job.html> for more info.

🎀 "start_job()"

$response = $es->rollup->start_job(
    id      => $id,     # required
)

The "start_job()" method starts the specified rollup job. go girl go 🏃♀️

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the rollup start job docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-start-job.html> for more info.

⭐ "stop_job()"

$response = $es->rollup->stop_job(
    id      => $id,     # required
)

The "stop_job()" method stops the specified rollup job. sit. stay. 🐕

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the rollup stop job docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-stop-job.html> for more info.

🔥 DATA METHODS 🔥

💖 "get_rollup_caps()"

$response = $es->rollup->get_rollup_caps(
    id => $index    # optional
)

The "get_rollup_caps()" method returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the get rollup caps docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-caps.html> for more info.

🌸 "get_rollup_index_caps()"

$response = $es->rollup->get_rollup_index_caps(
    id => $index    # optional
)

The "get_rollup_index_caps()" method returns the rollup capabilities of all jobs inside of a rollup index. the way that it just tells you everything?? obsessed. 😭

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the get rollup index caps docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-index-caps.html> for more info.

💜 AUTHOR 💜

Enrico Zimuel <enrico.zimuel@elastic.co> — thank you king 👑

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 was perl v5.32.1, dated 2021-10-23, and yes it really is Search...Rollup(3pm). go forth and roll up your indices, no cap. 🦋✨

📦 where this page comes from