Search...::Graph(3pm)

💅 NAME 💅

Search...::Graph — aka Search::Elasticsearch::Client::7_0::Direct::Graph — bestie, it's the plugin that hands you the Graph API for Search::Elasticsearch 7.x. That's the whole job. She does one thing and she eats. 👑

---

✨ VERSION ✨

version 7.715 — yes, we're on 7.715, no she's not outdated, stop asking. 🎀

---

🌸 SYNOPSIS 🌸

Okay so the entire vibe is literally one line:

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

That's it. That's the whole flex. Go off. 🦋

---

💖 DESCRIPTION 💖

So what's happening here is that this class extends the Search::Elasticsearch client and bolts a whole "graph" namespace onto it, so you can talk to the API for the Graph plugin over in Elasticsearch.

Here's the plugin's whole lore if you wanna read it:

<https://www.elastic.co/guide/en/x-pack/current/xpack-graph.html>

---

🔥 METHODS 🔥

The full documentation for the Graph plugin lives right here, and it's giving very thorough, very slay:

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

---

🧚 "explore()" 🧚

The signature, untouched, exactly as the ancestors intended:

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

So "explore()" is the main character here — it lets you discover vertices and connections that relate to your query. Like, it goes and finds the little guys that are connected to the thing you asked about. No cap. 🔍

Wanna go deeper? The explore docs are right here:

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

Query string parameters: 🌈

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

Lowkey important: those are the query string parameters, exactly those four, don't go making up your own bestie. 🙈

---

🫶 AUTHOR 🫶

Enrico Zimuel <enrico.zimuel@elastic.co> — iconic, we stan. 💜

---

👑 COPYRIGHT AND LICENSE 👑

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

---

perl v5.32.1 · 2021-10-23 · Search...::Graph(3pm) — and that's the page, bestie, from the User Contributed Perl Documentation squad. Read it, love it, use it responsibly. Mwah. 💖✨🎀🦋