deleteItem method

Future<DeleteItemOutput> deleteItem({
  1. required Map<String, AttributeValue> key,
  2. required String tableName,
  3. String? conditionExpression,
  4. ConditionalOperator? conditionalOperator,
  5. Map<String, ExpectedAttributeValue>? expected,
  6. Map<String, String>? expressionAttributeNames,
  7. Map<String, AttributeValue>? expressionAttributeValues,
  8. ReturnConsumedCapacity? returnConsumedCapacity,
  9. ReturnItemCollectionMetrics? returnItemCollectionMetrics,
  10. ReturnValue? returnValues,
})

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

May throw ConditionalCheckFailedException. May throw ProvisionedThroughputExceededException. May throw ResourceNotFoundException. May throw ItemCollectionSizeLimitExceededException. May throw TransactionConflictException. May throw RequestLimitExceeded. May throw InternalServerError.

Parameter key : A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Parameter tableName : The name of the table from which to delete the item.

Parameter conditionExpression : A condition that must be satisfied in order for a conditional DeleteItem to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
  • Logical operators: AND | OR | NOT
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Parameter conditionalOperator : This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Parameter expected : This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Parameter expressionAttributeNames : One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.
  • To create a placeholder for repeating occurrences of an attribute name in an expression.
  • To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
  • Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
  • {"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
  • #P = :val
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Parameter expressionAttributeValues : One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Parameter returnItemCollectionMetrics : Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Parameter returnValues : Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
  • ALL_OLD - The content of the old item is returned.

Implementation

Future<DeleteItemOutput> deleteItem({
  required Map<String, AttributeValue> key,
  required String tableName,
  String? conditionExpression,
  ConditionalOperator? conditionalOperator,
  Map<String, ExpectedAttributeValue>? expected,
  Map<String, String>? expressionAttributeNames,
  Map<String, AttributeValue>? expressionAttributeValues,
  ReturnConsumedCapacity? returnConsumedCapacity,
  ReturnItemCollectionMetrics? returnItemCollectionMetrics,
  ReturnValue? returnValues,
}) async {
  ArgumentError.checkNotNull(key, 'key');
  ArgumentError.checkNotNull(tableName, 'tableName');
  _s.validateStringLength(
    'tableName',
    tableName,
    3,
    255,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'DynamoDB_20120810.DeleteItem'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Key': key,
      'TableName': tableName,
      if (conditionExpression != null)
        'ConditionExpression': conditionExpression,
      if (conditionalOperator != null)
        'ConditionalOperator': conditionalOperator.toValue(),
      if (expected != null) 'Expected': expected,
      if (expressionAttributeNames != null)
        'ExpressionAttributeNames': expressionAttributeNames,
      if (expressionAttributeValues != null)
        'ExpressionAttributeValues': expressionAttributeValues,
      if (returnConsumedCapacity != null)
        'ReturnConsumedCapacity': returnConsumedCapacity.toValue(),
      if (returnItemCollectionMetrics != null)
        'ReturnItemCollectionMetrics': returnItemCollectionMetrics.toValue(),
      if (returnValues != null) 'ReturnValues': returnValues.toValue(),
    },
  );

  return DeleteItemOutput.fromJson(jsonResponse.body);
}