/AWS1/CL_NED=>EXECUTEGREMLINPROFILEQUERY()¶
About ExecuteGremlinProfileQuery¶
Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See Gremlin profile API in Neptune for details.
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 allows the neptune-db:ReadDataViaQuery IAM action in that cluster.
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).
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_GREMLINQUERY TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING¶
The Gremlin query string to profile.
Optional arguments:¶
IV_RESULTS TYPE /AWS1/NEDBOOLEAN /AWS1/NEDBOOLEAN¶
If this flag is set to
TRUE, the query results are gathered and displayed as part of the profile report. IfFALSE, only the result count is displayed.
IV_CHOP TYPE /AWS1/NEDINTEGER /AWS1/NEDINTEGER¶
If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.
IV_SERIALIZER TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING¶
If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See Gremlin profile API in Neptune for more information.
IV_INDEXOPS TYPE /AWS1/NEDBOOLEAN /AWS1/NEDBOOLEAN¶
If this flag is set to
TRUE, the results include a detailed report of all index operations that took place during query execution and serialization.