logologo
Get Started
Guide
Development
Plugins
API
English
简体中文
Get Started
Guide
Development
Plugins
API
English
简体中文
logologo
API Overview

@nocobase/auth

AuthManager
Auth
BaseAuth

@nocobase/cli

NocoBase CLI
Global Environment Variables

@nocobase/client

Application
Plugin

@nocobase/database

Collection
Field

interfaces

BaseInterface
Filter Operators

RelationRepository

BelongsToManyRepository
belongs-to-repository
HasManyRepository
HasOneRepository
Repository

shared

create-options
destroy-options
find-one
find-options
transaction
update-options

@nocobase/flow-engine

DataSourceManager
FlowContext
FlowEngine
FlowModel
FlowResource

@nocobase/server

AppCommand
Application
AuditManager
Context
Migration
Plugin

@nocobase/sdk

Auth
Storage
Previous Pagetransaction
Next PageDataSourceManager

Type

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.