Skip to content

public / sequelize

Go to a project

不要怂，就是干，撸起袖子干！

Commit bd9e4231 by Vladlen Committed by Sushant
Options

docs(types): add explanatory comments to operators (#11337)

1 parent 9bd0bc11
Inline Side-by-side
Showing with 432 additions and 1 deletions
docs/querying.md
...@@ -153,6 +153,7 @@ const Op = Sequelize.Op ...@@ -153,6 +153,7 @@ const Op = Sequelize.Op
[Op.lte]: 10, // <= 10 [Op.lte]: 10, // <= 10
[Op.ne]: 20, // != 20 [Op.ne]: 20, // != 20
[Op.eq]: 3, // = 3 [Op.eq]: 3, // = 3
[Op.is]: null // IS NULL
[Op.not]: true, // IS NOT TRUE [Op.not]: true, // IS NOT TRUE
[Op.between]: [6, 10], // BETWEEN 6 AND 10 [Op.between]: [6, 10], // BETWEEN 6 AND 10
[Op.notBetween]: [11, 15], // NOT BETWEEN 11 AND 15 [Op.notBetween]: [11, 15], // NOT BETWEEN 11 AND 15
...@@ -170,13 +171,15 @@ const Op = Sequelize.Op ...@@ -170,13 +171,15 @@ const Op = Sequelize.Op
[Op.iRegexp]: '^[h|a|t]' // ~* '^[h|a|t]' (PG only) [Op.iRegexp]: '^[h|a|t]' // ~* '^[h|a|t]' (PG only)
[Op.notIRegexp]: '^[h|a|t]' // !~* '^[h|a|t]' (PG only) [Op.notIRegexp]: '^[h|a|t]' // !~* '^[h|a|t]' (PG only)
[Op.like]: { [Op.any]: ['cat', 'hat']} [Op.like]: { [Op.any]: ['cat', 'hat']}
// LIKE ANY ARRAY['cat', 'hat'] - also works for iLike and notLike // LIKE ANY ARRAY['cat', 'hat'] - also works for iLike and notLike
[Op.overlap]: [1, 2] // && [1, 2] (PG array overlap operator) [Op.overlap]: [1, 2] // && [1, 2] (PG array overlap operator)
[Op.contains]: [1, 2] // @> [1, 2] (PG array contains operator) [Op.contains]: [1, 2] // @> [1, 2] (PG array contains operator)
[Op.contained]: [1, 2] // <@ [1, 2] (PG array contained by operator) [Op.contained]: [1, 2] // <@ [1, 2] (PG array contained by operator)
[Op.any]: [2,3] // ANY ARRAY[2, 3]::INTEGER (PG only) [Op.any]: [2,3] // ANY ARRAY[2, 3]::INTEGER (PG only)
[Op.col]: 'user.organization_id' // = "user"."organization_id", with dialect specific column identifiers, PG in this example [Op.col]: 'user.organization_id' // = "user"."organization_id", with dialect specific column identifiers, PG in this example
[Op.gt]: { [Op.all]: literal('SELECT 1') }
// > ALL (SELECT 1)
``` ```
#### Range Operators #### Range Operators
......
types/lib/operators.d.ts
...@@ -2,43 +2,471 @@ ...@@ -2,43 +2,471 @@
* object that holds all operator symbols * object that holds all operator symbols
*/ */
declare const Op: { declare const Op: {
/**
* Operator -|- (PG range is adjacent to operator)
*
* ```js
* [Op.adjacent]: [1, 2]
* ```
* In SQL
* ```sql
* -|- [1, 2)
* ```
*/
readonly adjacent: unique symbol; readonly adjacent: unique symbol;
/**
* Operator ALL
*
* ```js
* [Op.gt]: {
* [Op.all]: literal('SELECT 1')
* }
* ```
* In SQL
* ```sql
* > ALL (SELECT 1)
* ```
*/
readonly all: unique symbol; readonly all: unique symbol;
/**
* Operator AND
*
* ```js
* [Op.and]: {a: 5}
* ```
* In SQL
* ```sql
* AND (a = 5)
* ```
*/
readonly and: unique symbol; readonly and: unique symbol;
/**
* Operator ANY ARRAY (PG only)
*
* ```js
* [Op.any]: [2,3]
* ```
* In SQL
* ```sql
* ANY ARRAY[2, 3]::INTEGER
* ```
*
* Operator LIKE ANY ARRAY (also works for iLike and notLike)
*
* ```js
* [Op.like]: { [Op.any]: ['cat', 'hat']}
* ```
* In SQL
* ```sql
* LIKE ANY ARRAY['cat', 'hat']
* ```
*/
readonly any: unique symbol; readonly any: unique symbol;
/**
* Operator BETWEEN
*
* ```js
* [Op.between]: [6, 10]
* ```
* In SQL
* ```sql
* BETWEEN 6 AND 10
* ```
*/
readonly between: unique symbol; readonly between: unique symbol;
/**
* With dialect specific column identifiers (PG in this example)
*
* ```js
* [Op.col]: 'user.organization_id'
* ```
* In SQL
* ```sql
* = "user"."organization_id"
* ```
*/
readonly col: unique symbol; readonly col: unique symbol;
/**
* Operator <@ (PG array contained by operator)
*
* ```js
* [Op.contained]: [1, 2]
* ```
* In SQL
* ```sql
* <@ [1, 2)
* ```
*/
readonly contained: unique symbol; readonly contained: unique symbol;
/**
* Operator @> (PG array contains operator)
*
* ```js
* [Op.contains]: [1, 2]
* ```
* In SQL
* ```sql
* @> [1, 2)
* ```
*/
readonly contains: unique symbol; readonly contains: unique symbol;
/**
* Operator LIKE
*
* ```js
* [Op.endsWith]: 'hat'
* ```
* In SQL
* ```sql
* LIKE '%hat'
* ```
*/
readonly endsWith: unique symbol; readonly endsWith: unique symbol;
/**
* Operator =
*
* ```js
* [Op.eq]: 3
* ```
* In SQL
* ```sql
* = 3
* ```
*/
readonly eq: unique symbol; readonly eq: unique symbol;
/**
* Operator >
*
* ```js
* [Op.gt]: 6
* ```
* In SQL
* ```sql
* > 6
* ```
*/
readonly gt: unique symbol; readonly gt: unique symbol;
/**
* Operator >=
*
* ```js
* [Op.gte]: 6
* ```
* In SQL
* ```sql
* >= 6
* ```
*/
readonly gte: unique symbol; readonly gte: unique symbol;
/**
* Operator ILIKE (case insensitive) (PG only)
*
* ```js
* [Op.iLike]: '%hat'
* ```
* In SQL
* ```sql
* ILIKE '%hat'
* ```
*/
readonly iLike: unique symbol; readonly iLike: unique symbol;
/**
* Operator IN
*
* ```js
* [Op.in]: [1, 2]
* ```
* In SQL
* ```sql
* IN [1, 2]
* ```
*/
readonly in: unique symbol; readonly in: unique symbol;
/**
* Operator ~* (PG only)
*
* ```js
* [Op.iRegexp]: '^[h|a|t]'
* ```
* In SQL
* ```sql
* ~* '^[h|a|t]'
* ```
*/
readonly iRegexp: unique symbol; readonly iRegexp: unique symbol;
/**
* Operator IS
*
* ```js
* [Op.is]: null
* ```
* In SQL
* ```sql
* IS null
* ```
*/
readonly is: unique symbol; readonly is: unique symbol;
/**
* Operator LIKE
*
* ```js
* [Op.like]: '%hat'
* ```
* In SQL
* ```sql
* LIKE '%hat'
* ```
*/
readonly like: unique symbol; readonly like: unique symbol;
/**
* Operator <
*
* ```js
* [Op.lt]: 10
* ```
* In SQL
* ```sql
* < 10
* ```
*/
readonly lt: unique symbol; readonly lt: unique symbol;
/**
* Operator <=
*
* ```js
* [Op.lte]: 10
* ```
* In SQL
* ```sql
* <= 10
* ```
*/
readonly lte: unique symbol; readonly lte: unique symbol;
/**
* Operator !=
*
* ```js
* [Op.ne]: 20
* ```
* In SQL
* ```sql
* != 20
* ```
*/
readonly ne: unique symbol; readonly ne: unique symbol;
/**
* Operator &> (PG range does not extend to the left of operator)
*
* ```js
* [Op.noExtendLeft]: [1, 2]
* ```
* In SQL
* ```sql
* &> [1, 2)
* ```
*/
readonly noExtendLeft: unique symbol; readonly noExtendLeft: unique symbol;
/**
* Operator &< (PG range does not extend to the right of operator)
*
* ```js
* [Op.noExtendRight]: [1, 2]
* ```
* In SQL
* ```sql
* &< [1, 2)
* ```
*/
readonly noExtendRight: unique symbol; readonly noExtendRight: unique symbol;
/**
* Operator NOT
*
* ```js
* [Op.not]: true
* ```
* In SQL
* ```sql
* IS NOT TRUE
* ```
*/
readonly not: unique symbol; readonly not: unique symbol;
/**
* Operator NOT BETWEEN
*
* ```js
* [Op.notBetween]: [11, 15]
* ```
* In SQL
* ```sql
* NOT BETWEEN 11 AND 15
* ```
*/
readonly notBetween: unique symbol; readonly notBetween: unique symbol;
/**
* Operator NOT ILIKE (case insensitive) (PG only)
*
* ```js
* [Op.notILike]: '%hat'
* ```
* In SQL
* ```sql
* NOT ILIKE '%hat'
* ```
*/
readonly notILike: unique symbol; readonly notILike: unique symbol;
/**
* Operator NOT IN
*
* ```js
* [Op.notIn]: [1, 2]
* ```
* In SQL
* ```sql
* NOT IN [1, 2]
* ```
*/
readonly notIn: unique symbol; readonly notIn: unique symbol;
/**
* Operator !~* (PG only)
*
* ```js
* [Op.notIRegexp]: '^[h|a|t]'
* ```
* In SQL
* ```sql
* !~* '^[h|a|t]'
* ```
*/
readonly notIRegexp: unique symbol; readonly notIRegexp: unique symbol;
/**
* Operator NOT LIKE
*
* ```js
* [Op.notLike]: '%hat'
* ```
* In SQL
* ```sql
* NOT LIKE '%hat'
* ```
*/
readonly notLike: unique symbol; readonly notLike: unique symbol;
/**
* Operator NOT REGEXP (MySQL/PG only)
*
* ```js
* [Op.notRegexp]: '^[h|a|t]'
* ```
* In SQL
* ```sql
* NOT REGEXP/!~ '^[h|a|t]'
* ```
*/
readonly notRegexp: unique symbol; readonly notRegexp: unique symbol;
/**
* Operator OR
*
* ```js
* [Op.or]: [{a: 5}, {a: 6}]
* ```
* In SQL
* ```sql
* (a = 5 OR a = 6)
* ```
*/
readonly or: unique symbol; readonly or: unique symbol;
/**
* Operator && (PG array overlap operator)
*
* ```js
* [Op.overlap]: [1, 2]
* ```
* In SQL
* ```sql
* && [1, 2)
* ```
*/
readonly overlap: unique symbol; readonly overlap: unique symbol;
/**
* Internal placeholder
*
* ```js
* [Op.placeholder]: true
* ```
*/
readonly placeholder: unique symbol; readonly placeholder: unique symbol;
/**
* Operator REGEXP (MySQL/PG only)
*
* ```js
* [Op.regexp]: '^[h|a|t]'
* ```
* In SQL
* ```sql
* REGEXP/~ '^[h|a|t]'
* ```
*/
readonly regexp: unique symbol; readonly regexp: unique symbol;
/**
* Operator LIKE
*
* ```js
* [Op.startsWith]: 'hat'
* ```
* In SQL
* ```sql
* LIKE 'hat%'
* ```
*/
readonly startsWith: unique symbol; readonly startsWith: unique symbol;
/**
* Operator << (PG range strictly left of operator)
*
* ```js
* [Op.strictLeft]: [1, 2]
* ```
* In SQL
* ```sql
* << [1, 2)
* ```
*/
readonly strictLeft: unique symbol; readonly strictLeft: unique symbol;
/**
* Operator >> (PG range strictly right of operator)
*
* ```js
* [Op.strictRight]: [1, 2]
* ```
* In SQL
* ```sql
* >> [1, 2)
* ```
*/
readonly strictRight: unique symbol; readonly strictRight: unique symbol;
/**
* Operator LIKE
*
* ```js
* [Op.substring]: 'hat'
* ```
* In SQL
* ```sql
* LIKE '%hat%'
* ```
*/
readonly substring: unique symbol; readonly substring: unique symbol;
/**
* Operator VALUES
*
* ```js
* [Op.values]: [4, 5, 6]
* ```
* In SQL
* ```sql
* VALUES (4), (5), (6)
* ```
*/
readonly values: unique symbol; readonly values: unique symbol;
}; };
export = Op; export = Op;
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!