Scroll to navigation

Search::Elasticsearch::Client::8_0::Direct::Graph(3) User Contributed Perl Documentation Search::Elasticsearch::Client::8_0::Direct::Graph(3)

NAME

Search::Elasticsearch::Client::8_0::Direct::Graph - Plugin providing Graph API for Search::Elasticsearch 8.x

VERSION

version 8.12

SYNOPSIS

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

DESCRIPTION

This class extends the Search::Elasticsearch client with a "graph" namespace, to support the API for the Graph <https://www.elastic.co/guide/en/x-pack/current/xpack-graph.html> plugin for Elasticsearch.

METHODS

The full documentation for the Graph plugin is available here: <https://www.elastic.co/guide/en/graph/current/index.html>

explore()

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

The explore() method allows you to discover vertices and connections which relate to your query.

See the explore docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html> for more information.

Query string parameters:
"error_trace",
"human",
"routing",
"timeout"

AUTHOR

Enrico Zimuel <enrico.zimuel@elastic.co>

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
2024-03-08 perl v5.40.0