Skip to main content

records

Creates, updates, deletes, gets or lists a records resource.

Overview

Namerecords
TypeResource
Idaws.keyspacesstreams.records

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
change_recordsarrayAn array of change data records retrieved from the specified shard. Each record represents a single data modification (insert, update, or delete) to a row in the Amazon Keyspaces table. Records include the primary key columns and information about what data was modified.
iterator_descriptionobjectProvides information about the current iterator at the time GetRecords request was processed by Keyspaces.
next_shard_iteratorstringThe next position in the shard from which to start sequentially reading data records. If null, the shard has been closed and the requested iterator will not return any more data.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_recordsselectregionRetrieves data records from a specified shard in an Amazon Keyspaces data stream. This operation returns a collection of data records from the shard, including the primary key columns and information about modifications made to the captured table data. Each record represents a single data modification in the Amazon Keyspaces table and includes metadata about when the change occurred.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Retrieves data records from a specified shard in an Amazon Keyspaces data stream. This operation returns a collection of data records from the shard, including the primary key columns and information about modifications made to the captured table data. Each record represents a single data modification in the Amazon Keyspaces table and includes metadata about when the change occurred.

SELECT
change_records,
iterator_description,
next_shard_iterator
FROM aws.keyspacesstreams.records
WHERE region = '{{ region }}' -- required
;