Function updateById

updateById<DocumentType>(ctx, collectionName, objectId, updates, options?): Promise<DocumentType>
Update a document using its _id.

This operation allows you to do a partial update of a collection document i.e. without specifying all the values (it uses DynamoDBs UpdateItem` operation).

At this time, the updates value just updates specified key paths on the target document.

If some of the update key paths are indexed values, the indexes will also be updated. Because of this, you must specify all the key values in an access pattern to ensure indexes are updated consistently.
Type Parameters
- DocumentType extends DocumentWithId
  
  your document type - used to set return type
Parameters
- ctx: Context
  
  context
- collectionName: string
  
  the collection to update
- objectId: string
  
  the _id value of the object to update
- updates: Updates
  
  the set of updates to apply.
- options: {
  condition?: CompositeCondition;
  } = {}
  
  options to apply (including conditional checks)
  - Optional condition?: CompositeCondition
Returns Promise<DocumentType>
the updated object value in its entirety.

Throws
CollectionNotFoundException collection not found

Throws
InvalidUpdatesException thrown when the updates object is invalid or incomplete

Throws
InvalidUpdateValueException thrown when one of the update values is an invalid type
- Defined in src/operations/update_by_id.ts:664

Generated using TypeDoc