.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Search::Elasticsearch::Client::8_0::Direct::Graph 3pm" .TH Search::Elasticsearch::Client::8_0::Direct::Graph 3pm 2024-02-04 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Search::Elasticsearch::Client::8_0::Direct::Graph \- Plugin providing Graph API for Search::Elasticsearch 8.x .SH VERSION .IX Header "VERSION" version 8.12 .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& my $response = $es\->graph\->explore(...); .Ve .SS DESCRIPTION .IX Subsection "DESCRIPTION" This class extends the Search::Elasticsearch client with a \f(CW\*(C`graph\*(C'\fR namespace, to support the API for the Graph plugin for Elasticsearch. .SH METHODS .IX Header "METHODS" The full documentation for the Graph plugin is available here: .ie n .SS explore() .el .SS \f(CWexplore()\fP .IX Subsection "explore()" .Vb 5 \& $response = $es\->graph\->explore( \& index => $index | \e@indices, # optional \& type => $type | \e@types, # optional \& body => {...} \& ) .Ve .PP The \f(CWexplore()\fR method allows you to discover vertices and connections which relate to your query. .PP See the explore docs for more information. .PP Query string parameters: \f(CW\*(C`error_trace\*(C'\fR, \f(CW\*(C`human\*(C'\fR, \f(CW\*(C`routing\*(C'\fR, \f(CW\*(C`timeout\*(C'\fR .SH AUTHOR .IX Header "AUTHOR" Enrico Zimuel .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2024 by Elasticsearch BV. .PP This is free software, licensed under: .PP .Vb 1 \& The Apache License, Version 2.0, January 2004 .Ve