Preparing search index...
The search index is not available
@sequelize/core
@sequelize/core
ModelScopeOptions
Interface ModelScopeOptions<TAttributes>
Interface for Define Scope Options
Type Parameters
TAttributes =
any
Hierarchy
ModelScopeOptions
Indexable
[
scopeName:
string
]:
FindOptions
<
TAttributes
>
|
(
(
...
args
:
readonly
any
[]
)
=>
FindOptions
<
TAttributes
>
)
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
@sequelize/core
Data
Types
Utils
Base
Error
default
use
Inflection
ISOLATION_
LEVELS
Index
Hints
LOCK
Query
Types
TRANSACTION_
TYPES
Table
Hints
Validation
Error
Item
Origin
Validation
Error
Item
Type
Access
Denied
Error
Aggregate
Error
Association
Association
Error
Async
Queue
Error
Belongs
To
Belongs
To
Many
Bulk
Record
Error
Connection
Acquire
Timeout
Error
Connection
Error
Connection
Refused
Error
Connection
Timed
Out
Error
Database
Error
Deferrable
Eager
Loading
Error
Empty
Result
Error
Error
Exclusion
Constraint
Error
Foreign
Key
Constraint
Error
Has
Many
Has
One
Host
Not
Found
Error
Host
Not
Reachable
Error
Instance
Error
Invalid
Connection
Error
Model
Multi
Association
Optimistic
Lock
Error
Query
Error
Query
Interface
Sequelize
Sequelize
Scope
Error
Timeout
Error
Transaction
Unique
Constraint
Error
Unknown
Constraint
Error
Validation
Error
Validation
Error
Item
Abstract
Data
Type
Abstract
Data
Type
Constructor
Add
Check
Constraint
Options
Add
Default
Constraint
Options
Add
Foreign
Key
Constraint
Options
Add
Primary
Key
Constraint
Options
Add
Scope
Options
Add
Unique
Constraint
Options
Aggregate
Options
Array
Data
Type
Array
Data
Type
Constructor
Array
Data
Type
Options
Association
Options
Association
Scope
Base
Constraint
Options
Belongs
To
Create
Association
Mixin
Options
Belongs
To
Get
Association
Mixin
Options
Belongs
To
Many
Add
Association
Mixin
Options
Belongs
To
Many
Add
Associations
Mixin
Options
Belongs
To
Many
Count
Associations
Mixin
Options
Belongs
To
Many
Create
Association
Mixin
Options
Belongs
To
Many
Get
Associations
Mixin
Options
Belongs
To
Many
Has
Association
Mixin
Options
Belongs
To
Many
Has
Associations
Mixin
Options
Belongs
To
Many
Options
Belongs
To
Many
Remove
Association
Mixin
Options
Belongs
To
Many
Remove
Associations
Mixin
Options
Belongs
To
Many
Set
Associations
Mixin
Options
Belongs
To
Options
Belongs
To
Set
Association
Mixin
Options
Big
Int
Data
Type
Big
Int
Data
Type
Constructor
Blob
Data
Type
Blob
Data
Type
Constructor
Blob
Data
Type
Options
Build
Options
Built
Model
Attribute
Colum
Options
Bulk
Create
Options
Char
Data
Type
Char
Data
Type
Constructor
Char
Data
Type
Options
Collate
Charset
Options
Column
Description
Column
Options
Columns
Description
Config
Connection
Connection
Options
Count
Options
Create
Database
Options
Create
Function
Options
Create
Options
Database
Description
Date
Data
Type
Date
Data
Type
Constructor
Date
Data
Type
Options
Date
Only
Data
Type
Date
Only
Data
Type
Constructor
Decimal
Data
Type
Decimal
Data
Type
Constructor
Decimal
Data
Type
Options
Default
Set
Options
Destroy
Options
Dialect
Options
Double
Data
Type
Double
Data
Type
Constructor
Double
Data
Type
Options
Drop
Options
Enum
Data
Type
Enum
Data
Type
Constructor
Enum
Data
Type
Options
Filterable
Find
And
Count
Options
Find
By
Pk
Options
Find
Options
Find
Or
Build
Options
Find
Or
Create
Options
Float
Data
Type
Float
Data
Type
Constructor
Float
Data
Type
Options
Foreign
Key
Options
Function
Param
Geography
Data
Type
Geography
Data
Type
Constructor
Geography
Data
Type
Options
Geometry
Data
Type
Geometry
Data
Type
Constructor
Geometry
Data
Type
Options
Grouped
Count
Result
Item
Has
Many
Add
Association
Mixin
Options
Has
Many
Add
Associations
Mixin
Options
Has
Many
Count
Associations
Mixin
Options
Has
Many
Create
Association
Mixin
Options
Has
Many
Get
Associations
Mixin
Options
Has
Many
Has
Association
Mixin
Options
Has
Many
Has
Associations
Mixin
Options
Has
Many
Options
Has
Many
Remove
Association
Mixin
Options
Has
Many
Remove
Associations
Mixin
Options
Has
Many
Set
Associations
Mixin
Options
Has
One
Create
Association
Mixin
Options
Has
One
Get
Association
Mixin
Options
Has
One
Options
Has
One
Set
Association
Mixin
Options
Hookable
Include
Options
Include
Through
Options
Increment
Decrement
Options
Increment
Decrement
Options
With
By
Index
Field
Index
Hint
Index
Hintable
Index
Options
Init
Options
Instance
Destroy
Options
Instance
Restore
Options
Instance
Update
Options
Integer
Data
Type
Integer
Data
Type
Constructor
Integer
Data
Type
Options
Join
Table
Attributes
Logging
Medium
Integer
Data
Type
Medium
Integer
Data
Type
Constructor
Model
Attribute
Column
Options
Model
Attribute
Column
References
Options
Model
Get
Options
Model
Getter
Options
Model
Name
Options
Model
Options
Model
Scope
Options
Model
Setter
Options
Model
Validate
Options
Multi
Association
Options
Non
Null
Find
By
Pk
Options
Non
Null
Find
Options
Normalized
Options
Normalized
Replication
Options
Number
Data
Type
Number
Data
Type
Constructor
Number
Data
Type
Options
Operators
Aliases
Options
Paranoid
Pool
Options
Poolable
Projectable
Qi
Arithmetic
Options
Qi
Delete
Options
Qi
Insert
Options
Qi
Options
With
Replacements
Qi
Select
Options
Qi
Update
Options
Qi
Upsert
Options
Query
Interface
Create
Table
Options
Query
Interface
Drop
All
Tables
Options
Query
Interface
Drop
Table
Options
Query
Interface
Index
Options
Query
Options
Query
Options
Transaction
Required
Query
Options
With
Model
Query
Options
With
Type
Query
Raw
Options
Query
Raw
Options
With
Model
Query
Raw
Options
With
Type
Range
Data
Type
Range
Data
Type
Constructor
Range
Data
Type
Options
Real
Data
Type
Real
Data
Type
Constructor
Real
Data
Type
Options
Replaceable
Replication
Options
Restore
Options
Retry
Options
Save
Options
Schema
Options
Scope
Options
Search
Pathable
Set
Options
Silent
Small
Integer
Data
Type
Small
Integer
Data
Type
Constructor
String
Data
Type
String
Data
Type
Constructor
String
Data
Type
Options
Sync
Alter
Options
Sync
Options
Table
Name
With
Schema
Text
Data
Type
Text
Data
Type
Constructor
Text
Data
Type
Options
Through
Options
Tiny
Integer
Data
Type
Tiny
Integer
Data
Type
Constructor
Transaction
Options
Transactionable
Truncate
Options
Update
Options
Upsert
Options
Validator
Virtual
Data
Type
Virtual
Data
Type
Constructor
Where
Geometry
Options
Where
Operators
Add
Constraint
Options
After
Associate
Event
Data
Allow
Any
All
Allow
Not
Or
And
Recursive
Allow
Not
Or
And
With
Implicit
And
Array
Recursive
Attribute
Names
Attributes
Before
Associate
Event
Data
Belongs
To
Create
Association
Mixin
Belongs
To
Get
Association
Mixin
Belongs
To
Many
Add
Association
Mixin
Belongs
To
Many
Add
Associations
Mixin
Belongs
To
Many
Count
Associations
Mixin
Belongs
To
Many
Create
Association
Mixin
Belongs
To
Many
Get
Associations
Mixin
Belongs
To
Many
Has
Association
Mixin
Belongs
To
Many
Has
Associations
Mixin
Belongs
To
Many
Remove
Association
Mixin
Belongs
To
Many
Remove
Associations
Mixin
Belongs
To
Many
Set
Associations
Mixin
Belongs
To
Set
Association
Mixin
Bind
Or
Replacements
Blob
Size
Branded
Keys
Of
Built
Model
Name
Built
Model
Options
Column
Reference
Continuation
Local
Storage
Namespace
Count
With
Options
Creation
Attributes
Creation
Optional
Data
Type
Data
Type
Abstract
Dialect
Dynamic
Values
Empty
Range
Field
Map
Find
Attribute
Options
Foreign
Key
Group
Option
Has
Many
Add
Association
Mixin
Has
Many
Add
Associations
Mixin
Has
Many
Count
Associations
Mixin
Has
Many
Create
Association
Mixin
Has
Many
Get
Associations
Mixin
Has
Many
Has
Association
Mixin
Has
Many
Has
Associations
Mixin
Has
Many
Remove
Association
Mixin
Has
Many
Remove
Associations
Mixin
Has
Many
Set
Associations
Mixin
Has
One
Create
Association
Mixin
Has
One
Get
Association
Mixin
Has
One
Set
Association
Mixin
Identifier
Includeable
Index
Method
Index
Type
Infer
Attributes
Infer
Attributes
Options
Infer
Creation
Attributes
Internal
Infer
Attribute
Keys
From
Fields
Invalid
In
Sql
Array
Is
Branded
Model
Attributes
Model
Defined
Model
Static
Multi
Association
Accessors
Non
Attribute
Normalized
Association
Options
Normalized
Belongs
To
Options
Normalized
Has
Many
Options
Normalized
Has
One
Options
Normalized
Pool
Options
Operator
Values
Optional
Order
Order
Item
Order
Item
Association
Order
Item
Column
Partly
Required
Projection
Alias
Rangable
Range
Range
Part
Rangeable
Data
Type
Referential
Action
Single
Association
Accessors
Static
Values
Table
Name
Text
Length
Update
Values
Where
Attribute
Hash
Where
Attribute
Hash
Value
Where
Left
Operand
Where
Options
Where
Serializable
Value
Creation
Attribute
Brand
Foreign
Key
Brand
Non
Attribute
Brand
Op
ABSTRACT
ARRAY
BIGINT
BLOB
BOOLEAN
CHAR
CIDR
CITEXT
DATE
DATEONLY
DECIMAL
DOUBLE
ENUM
FLOAT
GEOGRAPHY
GEOMETRY
HSTORE
INET
INTEGER
JSON
JSONB
MACADDR
MEDIUMINT
NOW
NUMBER
RANGE
REAL
SMALLINT
STRING
TEXT
TIME
TINYINT
TSVECTOR
UUID
UUIDV1
UUIDV4
VIRTUAL
and
cast
col
fn
is
Model
Static
is
Same
Initial
Model
is
Through
Options
json
literal
or
where
Generated using
TypeDoc
Interface for Define Scope Options