Execute Gremlin Query

neptunedata_execute_gremlin_query

R Documentation

This commands executes a Gremlin query

Description

This commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to query the graph, as described under The Graph in the Apache TinkerPop3 documentation. More details can also be found in Accessing a Neptune graph with Gremlin.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that enables one of the following IAM actions in that cluster, depending on the query:

• neptune-db:ReadDataViaQuery

• neptune-db:WriteDataViaQuery

• neptune-db:DeleteDataViaQuery

Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

Usage

neptunedata_execute_gremlin_query(gremlinQuery, serializer)

Arguments

gremlinQuery

[required] Using this API, you can run Gremlin queries in string format much as you can using the HTTP endpoint. The interface is compatible with whatever Gremlin version your DB cluster is using (see the Tinkerpop client section to determine which Gremlin releases your engine version supports).

serializer

If non-null, the query results are returned in a serialized response message in the format specified by this parameter. See the GraphSON section in the TinkerPop documentation for a list of the formats that are currently supported.

Value

A list with the following syntax:

list(
  requestId = "string",
  status = list(
    message = "string",
    code = 123,
    attributes = list()
  ),
  result = list(),
  meta = list()
)

Request syntax

svc$execute_gremlin_query(
  gremlinQuery = "string",
  serializer = "string"
)