elasticsearch (version 0.1.0)

get: get

Description

Get a typed JSON document from the index based on its id.

Usage

get(client, ...)
"get"(client, index, type = "_all", id, fields = NULL, source = TRUE, source_include = NULL, parent = NULL, source_exclude = NULL, realtime = TRUE, routing = NULL, preference = "random", refresh = FALSE, version = NULL, version_type = NULL, exists = FALSE, raw = FALSE, validate_params = TRUE, get_source = FALSE)

Arguments

client
index
String The name of the index
type
String The type of the document (use _all to fetch the first document matching the ID across all types)
id
String The document ID
fields
String, String[] A comma-separated list of fields to return in the response
source
String, String[], Logical True or false to return the _source field or not, or a list of fields to return
source_include
String, String[], Logical A list of fields to extract and return from the _source field
parent
String The ID of the parent document
source_exclude
String, String[], Logical A list of fields to exclude from the returned _source field
realtime
Logical Specify whether to perform the operation in realtime or search mode
routing
String Specific routing value
preference
String Specify the node or shard the operation should be performed on (default: random)
refresh
Logical Refresh the shard containing the document before performing the operation
version
Number Explicit version number for concurrency control
version_type
String Specific version type

Details

get searches a document in an index based on its id and returns it.

References

http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html

Examples

get("twitter", id="1")
get("twitter", "tweet", "1")
get("twitter", "tweet", "1", 'c("name", "date")')
get("twitter", "tweet", "1", 'c("name", "date")', TRUE)