ContextQMD
Back to Nocobase

Update Options

docs/docs/en/api/database/shared/update-options.md

2.0.54981 B
Original Source

Type

typescript
interface UpdateOptions extends Omit<SequelizeUpdateOptions, 'where'> {
  values: Values;
  filter?: Filter;
  filterByTk?: TargetKey;
  whitelist?: WhiteList;
  blacklist?: BlackList;
  updateAssociationValues?: AssociationKeysToBeUpdate;
  context?: any;
}

Details

  • values: The data object for the record to be updated.
  • filter: Specifies the filter conditions for the records to be updated. For detailed usage of Filter, refer to the find() method.
  • filterByTk: Specifies the filter conditions for the records to be updated by TargetKey.
  • whitelist: A whitelist for the values fields. Only fields in this list will be written.
  • blacklist: A blacklist for the values fields. Fields in this list will not be written.
  • transaction: The transaction object. If no transaction parameter is passed, the method will automatically create an internal transaction.

At least one of filterByTk or filter must be passed.