Skip to content

Custom Options for Gremlin

This page details the available options you can pass in a Gremlin with() step when using the GafferPop API for querying.

Operation Options

Key: operationOptions

Allows passing options to the underlying Gaffer Operations, this is the same as the options field on a standard JSON query. This will be applied to all operations in the query.

Note that any options should be passed as a list or dictionary.

Example

g.with("operationOptions", ["gaffer.federatedstore.operation.graphIds:graphA"]).V().toList()

g.with_("operationOptions", ["gaffer.federatedstore.operation.graphIds:graphA"]).V().to_list()

or

g.with_("operationOptions", {"gaffer.federatedstore.operation.graphIds": "graphA"}).V().to_list()

GetElements Limit

Key getElementsLimit

Limits the amount of elements returned if performing a query which returns a large amount of elements e.g. a GetAllElements operation. This will override the default for the current query, see the admin guide for more detail on setting up defaults.

Example

g.with("getElementsLimit", 100).V().toList()

Has Step Filter Stage

Key: hasStepFilterStage

Controls which phase the filtering from a Gremlin has() stage is applied to the results. This will apply to all has() steps in the query and override the default, see the admin guide for more detail on setting up defaults.

Example

g.with("hasStepFilterStage", "PRE_AGGREGATION").V().has("count" P.gt(1)).toList()

Cypher Query

Key: cypher

Translates the given Cypher query to Gremlin and executes it on the Graph. This can be used in combination with other with() steps as they will be protected from translation.

Example

g.with("cypher", "MATCH (p:person) RETURN p").call().toList()