NAME

Search::Elasticsearch::Plugin::XPack::2_0::Graph - Plugin providing Graph API for Search::Elasticsearch 2.x

VERSION

version 6.00

SYNOPSIS

    use Search::Elasticsearch();

    my $es = Search::Elasticsearch->new(
        nodes    => \@nodes,
        plugins  => ['XPack']
    );

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

DESCRIPTION

This class extends the Search::Elasticsearch client with a graph namespace, to support the API for the Graph plugin for Elasticsearch. In other words, it can be used as follows:

    use Search::Elasticsearch();
    my $es = Search::Elasticsearch->new(
        nodes    => \@nodes,
        plugins  => ['XPack']
    );

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

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 for more information.

AUTHOR

Clinton Gormley <drtech@cpan.org>

COPYRIGHT AND LICENSE

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

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004