Search...::Graph(3pm)

💖 Search::Elasticsearch::Client::8_0::Direct::Graph — the perl manpage, but make it cute

okay bestie, this is a page from the User Contributed Perl Documentation for the module Search...::Graph(3pm). It's a plugin page, it's short, it's iconic, let's go 💅

---

✨ NAME ✨

Search::Elasticsearch::Client::8_0::Direct::Graph — it's the plugin that hands you the Graph API for Search::Elasticsearch 8.x. That's it, that's the whole job 🫶

🌸 VERSION 🌸

version 8.12 — yes, keep up, we're on 8.12 ✨

🦋 SYNOPSIS 🦋

look, it's one line, and it's the vibe:

my $response = $es->graph->explore(...);

that's the whole entrance. so simple. so clean. main character energy fr fr 👑

💜 DESCRIPTION 💜

okay so here's the deal: this class extends the Search::Elasticsearch client by bolting on a "graph" namespace, and the reason it exists is to support the API for the Graph plugin for Elasticsearch.

the Graph plugin docs live here: https://www.elastic.co/guide/en/x-pack/current/xpack-graph.html

that's it. it's giving "small module, big dreams" and honestly? we love that for it 🌈

🎀 METHODS 🎀

the full documentation for the Graph plugin is right here, no gatekeeping:

https://www.elastic.co/guide/en/graph/current/index.html

🔥 explore() 🔥

here's the signature, and bestie, notice that index and type are optional — I said what I said:

$response = $es->graph->explore(
    index => $index | \@indices,        # optional
    type  => $type  | \@types,          # optional
    body  => {...}
)

so what does explore() actually do? it lets you discover vertices and connections that relate to your query. like, it finds the connections. it's a whole detective arc 🔍✨

want more? the explore docs are at:

https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html

💀 Query string parameters 💀

these are the query string params you can pass, no cap:

• "error_trace"
• "human"
• "routing"
• "timeout"

that's the list. all four. don't come for me, I'm just reporting what the manpage says 🙈

🌟 AUTHOR 🌟

Enrico Zimuel <enrico.zimuel@elastic.co> — author icon, we stan 🫶

👑 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

free software?? we love a generous king 💖

---

and that's the page, bestie 🎀 this was put together with perl v5.38.2, dated 2024-02-04, filed under User Contributed Perl Documentation for Search...::Graph(3pm). slay, bye 💅✨