neptunedata_execute_gremlin_profile_query: Executes a Gremlin Profile query, which runs a specified...

View source: R/neptunedata_operations.R

neptunedata_execute_gremlin_profile_queryR Documentation

Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output

Description

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.

See https://www.paws-r-sdk.com/docs/neptunedata_execute_gremlin_profile_query/ for full documentation.

Usage

neptunedata_execute_gremlin_profile_query(
  gremlinQuery,
  results = NULL,
  chop = NULL,
  serializer = NULL,
  indexOps = NULL
)

Arguments

gremlinQuery

[required] The Gremlin query string to profile.

results

If this flag is set to TRUE, the query results are gathered and displayed as part of the profile report. If FALSE, only the result count is displayed.

chop

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.

serializer

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.

indexOps

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.


paws.database documentation built on Sept. 12, 2024, 6:37 a.m.