Skip to content

Get Propertygraph Stream

neptunedata_get_propertygraph_stream R Documentation

Gets a stream for a property graph

Description

Gets a stream for a property graph.

With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. get_propertygraph_stream lets you collect these change-log entries for a property graph.

The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.

See Capturing graph changes in real time using Neptune streams.

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:GetStreamRecords IAM action in that cluster.

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, depending on the query:

Note that you can restrict property-graph queries using the following IAM context keys:

See Condition keys available in Neptune IAM data-access policy statements).

Usage

neptunedata_get_propertygraph_stream(limit, iteratorType, commitNum,
  opNum, encoding)

Arguments

limit

Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the limit parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.

The range for limit is 1 to 100,000, with a default of 10.

iteratorType

Can be one of:

  • AT_SEQUENCE_NUMBER   –   Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters.

  • AFTER_SEQUENCE_NUMBER   –   Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters.

  • TRIM_HORIZON   –   Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.

  • LATEST   –   Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.

commitNum

The commit number of the starting record to read from the change-log stream. This parameter is required when iteratorType isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST.

opNum

The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is 1.

encoding

If set to TRUE, Neptune compresses the response using gzip encoding.

Value

A list with the following syntax: 

list(
  lastEventId = list(
    "string"
  ),
  lastTrxTimestampInMillis = 123,
  format = "string",
  records = list(
    list(
      commitTimestampInMillis = 123,
      eventId = list(
        "string"
      ),
      data = list(
        id = "string",
        type = "string",
        key = "string",
        value = list(),
        from = "string",
        to = "string"
      ),
      op = "string",
      isLastOp = TRUE|FALSE
    )
  ),
  totalRecords = 123
)

Request syntax

svc$get_propertygraph_stream(
  limit = 123,
  iteratorType = "AT_SEQUENCE_NUMBER"|"AFTER_SEQUENCE_NUMBER"|"TRIM_HORIZON"|"LATEST",
  commitNum = 123,
  opNum = 123,
  encoding = "gzip"
)