/AWS1/CL_SGF=>DELETERECORD()
¶
About DeleteRecord¶
Deletes a Record
from a FeatureGroup
in the
OnlineStore
. Feature Store supports both SoftDelete
and
HardDelete
. For SoftDelete
(default), feature columns are set
to null
and the record is no longer retrievable by GetRecord
or
BatchGetRecord
. For HardDelete
, the complete
Record
is removed from the OnlineStore
. In both cases, Feature
Store appends the deleted record marker to the OfflineStore
. The deleted
record marker is a record with the same RecordIdentifer
as the original, but
with is_deleted
value set to True
, EventTime
set to
the delete input EventTime
, and other feature values set to
null
.
Note that the EventTime
specified in DeleteRecord
should be
set later than the EventTime
of the existing record in the
OnlineStore
for that RecordIdentifer
. If it is not, the
deletion does not occur:
-
For
SoftDelete
, the existing (not deleted) record remains in theOnlineStore
, though the delete record marker is still written to theOfflineStore
. -
HardDelete
returnsEventTime
:400 ValidationException
to indicate that the delete operation failed. No delete record marker is written to theOfflineStore
.
When a record is deleted from the OnlineStore
, the deleted record marker is
appended to the OfflineStore
. If you have the Iceberg table format enabled for
your OfflineStore
, you can remove all history of a record from the
OfflineStore
using Amazon Athena or Apache Spark. For information on how to
hard delete a record from the OfflineStore
with the Iceberg table format
enabled, see Delete records from the offline store.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_FEATUREGROUPNAME
TYPE /AWS1/SGFFEATUREGROUPNAMEORARN
/AWS1/SGFFEATUREGROUPNAMEORARN
¶
The name or Amazon Resource Name (ARN) of the feature group to delete the record from.
IV_RECORDIDVALUEASSTRING
TYPE /AWS1/SGFVALUEASSTRING
/AWS1/SGFVALUEASSTRING
¶
The value for the
RecordIdentifier
that uniquely identifies the record, in string format.
IV_EVENTTIME
TYPE /AWS1/SGFVALUEASSTRING
/AWS1/SGFVALUEASSTRING
¶
Timestamp indicating when the deletion event occurred.
EventTime
can be used to query data at a certain point in time.
Optional arguments:¶
IT_TARGETSTORES
TYPE /AWS1/CL_SGFTARGETSTORES_W=>TT_TARGETSTORES
TT_TARGETSTORES
¶
A list of stores from which you're deleting the record. By default, Feature Store deletes the record from all of the stores that you're using for the
FeatureGroup
.
IV_DELETIONMODE
TYPE /AWS1/SGFDELETIONMODE
/AWS1/SGFDELETIONMODE
¶
The name of the deletion mode for deleting the record. By default, the deletion mode is set to
SoftDelete
.