apoc.es.get

Procedure Apoc Extended

apoc.es.get(host-or-key,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value - perform a GET operation on elastic search

Signature

apoc.es.get(host :: STRING?, index :: STRING?, type :: STRING?, id :: STRING?, query :: ANY?, payload :: ANY?, config = {} :: MAP?) :: (value :: MAP?)

Input parameters

Name	Type	Default
host	STRING?	null
index	STRING?	null
type	STRING?	null
id	STRING?	null
query	ANY?	null
payload	ANY?	null
config	MAP?	{}

Name

Type

Default

host

STRING?

null

index

STRING?

null

type

STRING?

null

STRING?

null

query

ANY?

null

payload

ANY?

null

config

MAP?

{}

Output parameters

Name	Type
value	MAP?

Name

Type

value

MAP?

Usage Examples

The examples in this section are based on the following Elastic instance:

version: '3.5'
services:
  elastic:
    image: docker.elastic.co/elasticsearch/elasticsearch:7.10.0
    ports:
      - 9200:9200
      - 9300:9300
    environment:
      - discovery.type=single-node

with a dataset created by downloading this file, and executing the command:

curl -H 'Content-Type: application/json' -XPOST 'localhost:9200/bank/_bulk?pretty&refresh' --data-binary '@accounts.json'

We can find the document with id 1, by running the following query:

CALL apoc.es.get("localhost","bank","_doc","1",null,null);

Table 1. Results
value
{_seq_no: 0, found: TRUE, _index: "bank", _type: "_doc", _source: {account_number: 1, firstname: "Amber", address: "880 Holmes Lane", balance: 39225, gender: "M", city: "Brogan", employer: "Pyrami", state: "IL", age: 32, email: "amberduke@pyrami.com", lastname: "Duke"}, _id: "1", _version: 1, _primary_term: 1}