docs: describe `findByPk`'s option bag #15115

evanrittenhouse · 2022-10-11T14:47:06Z

Pull Request Checklist

Have you added new tests to prevent regressions?
If a documentation update is necessary, have you opened a PR to the documentation repository?
Did you update the typescript typings accordingly (if applicable)?
Does the description below contain a link to an existing issue (Closes #[issue]) or a description of the issue you are solving?
Does the name of your PR follow our conventions?

Description Of Change

Todos

Closes sequelize/website#202. Not sure if we want to add more documentation, but I didn't want to duplicate work when FindOptions already exists.

Duplicate of #15111

This adds supports for sending JS BigInt values to databases. For retrieving SQL BigInts as JS BigInts, see sequelize#14296

Co-authored-by: Renovate Bot <bot@renovateapp.com>

) Co-authored-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

…ize#14521) Co-authored-by: Renovate Bot <bot@renovateapp.com>

)

Co-authored-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: SequelizeJS <mail@sequelizejs.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

@typeparam

* refactor: migrate associations to ts (wip) * refactor: migrate has-one to ts * refactor: migrate belongs-to association to TS * refactor: fix typing errors in has-one, belongs-to * refactor: migrate has-many to ts * refactor: migrate has-many to ts * refactor: finish migrating has-many.ts * refactor: migrate association/index.ts * refactor: continue association migration to ts * build: accept @typeparam, @internal typedoc tags * feat: improve typings of hasOne.set * fix: make HasOneGetAssociationMixin's output nullable * fix: improve typing of BelongsTo set method * feat: update hasMany * refactor: complete typing associations * fix: fix failing tests * refactor: migrate sequelize export to esm * fix: fix associations based on unit tests * fix: fix associations based on intergration tests * test: add test to prevent duplicate associations aliases * fix: fix Sequelize typings * test: unify groupedLimit m-n test with the integration one * feat: forbid instanciating Association/ManyAssociation * docs: revert accidental comment removal * fix: normalize includes before merging them * fix: replace query generator trying to create a new association * refactor: revert changes to reduce noise * test: fix mssql query generator test * feat: forbid users from instantiating association Classes * fix: dedupe BelongsToMany association * fix: use isSameModel to compare models * feat: improve error message for 'this association was already created' * fix: continue work to fix tests * feat: fix associations based on unit tests * refactor: migrate mixin.js to typescript * refactor: rename 'mixin.ts' -> 'define-association-methods.ts' * fix: fix accidental usage of _.eq instead of _.isEqual * test: fix m:n tests * refactor: move association definitions methods inside their classes * refactor: continue refactoring associations * feat: improve association deduplication * fix: remove accidental export * test: support 'cause' property when checking error message * fix: normalize belongs to many opts, improve error msg * feat: print error cause on systems without support * test: fix belongs to many tests * fix: continue fixing based on tests * fix: normalize the right timestamps option * feat: add Model.{getInitialModel,withoutScope}, rename schema+(un)?scope * fix: add deprecation IDs * feat: improve 'invalid scope' error message * fix: new batch of fixes * fix: make association.get return Map for multiple * docs: remove todos * fix: fix failing tests * fix: rollback test update * test: fix mariadb/mysql test * test: fix test * test: fix mysql8 test * feat(types): strongly type association mixins * test: migrate association.test to ts * test: migrate belongs-to test * feat(types): strongly type belongsToMany FKs * test: test deep through options version * test: test sourceKey/targetKey typing * test: migrate has-one unit test to typescript * test: migrate has-many unit tests to ts * test: migrate belongs-to-many unit test to ts * test: fix test * test: fix support.js * test: test two associations sharing the same pair * docs: update tsdoc of associations * feat: refactor associations to support 'inverse' option * feat: remove onUpdate, onDelete, inverse.{onUpdate,onDelete} They already exist as foreignKey.{onDelete,onUpdate}, otherkey.{onDelete,onUpdate} * fix: make CASCADE default onDelete for non-null FKs * refactor: normalize otherKey option * feat: rename constraints, foreignKeyConstraint to foreignKeyConstraints * fix: fix wrong scope option being passed to belongsTo * feat: support 'inverse' in belongs-to * feat: force all self-associations to be named * fix: simplify the name of foreignKeys on through models * fix: special case through models in order by * test: fix tests * test: fix broken test * fix: fix sqlite treating allowNull undefined as false * test: improve sql minifier * feat: use through model name in groupedLimit through include * refactor: remove unnecessary changes * test: mute type error due to missing typing * refactor: update comments * refactor: update comment * test: update unit tests Co-authored-by: Fauzan "Evan Edrok" 0x <fncolon@pm.me> Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>

…e#14531) Co-authored-by: Renovate Bot <bot@renovateapp.com>

…ize#14533) Co-authored-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Zoé <zoe@ephys.dev>

…14541) Co-authored-by: Renovate Bot <bot@renovateapp.com>

) Co-authored-by: Renovate Bot <bot@renovateapp.com>

Move my email to Gmail for security reports and accept specific mail only.

…ize#14558) Co-authored-by: Renovate Bot <bot@renovateapp.com>

…equelize#14560) Explanation: - User.sync(), which references the schema, was executed before the schema exists - add an `await` before the schema is created to enforce sequencing/synchronocity Subtle style change: - remove word 'even' from test description Addresses only PostgreSQL-portion of issue sequelize#14161

Co-authored-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Zoé <zoe@ephys.dev>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: SequelizeJS <mail@sequelizejs.com> Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

* get-options documentation improved The documentation of instance.get was lacking information when it simply returns instance.dataValues, or when it returns a copy of instance.dataValues. Searching a reason for this phenomenon, I also found the great 'clone'option, which was also lacking a description. Added both things. * close===true * clone===true (the second...) * line moved up * get-options as an interface * Lint mistakes solved (hopefully solved) * lint mistake fixed 2 Co-authored-by: X <fncolon@pm.me> Co-authored-by: Zoé <zoe@ephys.dev>

Co-authored-by: SequelizeJS <mail@sequelizejs.com> Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

…15079) * docs: correct instructions for running databases in Docker * docs: correct, add versioning info for test databases Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>

evanrittenhouse · 2022-10-11T14:48:21Z

src/model.js

+   * @param {Model<any, any>}              [options.instance=null] A sequelize instance used to build the return instance.
+   * @param {number|Literal}               [options.limit=null] Limits how many items will be returned by the operation.
+   * @param {boolean|LOCK|{level: LOCK; of: ModelStatic<Model<any, any>>}}                 [options.lock=null] Lock the selected rows. Possible options are transaction.LOCK.UPDATE and transaction.LOCK.SHARE. Postgres also supports transaction.LOCK.KEY_SHARE, transaction.LOCK.NO_KEY_UPDATE and specific model locks with joins
+   * @param {boolean}                      [options.logging=false] A function that gets executed while running the query to log the sql.


This line gave me syntax errors when trying to copy the callback signature from v7, so I left it out.

ephys · 2022-10-11T15:23:54Z

Did you mean to target the v6 branch? This will unfortunately not resolve sequelize/website#202 since it's a v6 only issue 😅

evanrittenhouse · 2022-10-11T15:24:58Z

Yeah I did 😬 I had some issues with the git remote on my local. Should I just do a new PR?

E: @ephys changed the base branch to v6.

fzn0x · 2022-10-11T18:49:47Z

This is a lot of conflicts when we target it directly in the same PR, can you replicate this PR to a new PR that targetting v6 branch?

fzn0x · 2022-10-11T18:50:14Z

Since v6 branch is different source of truth

ephys · 2022-10-12T09:51:50Z

You can open a new PR if you want but you can also repurpose this one :)

Here is how:

copy your changes in a temporary file somewhere (or you will lose them)
git checkout v6
delete this branch git branch -D findbypk_jsdoc
recreate it from v6 git checkout -B findbypk_jsdoc
paste the changes you copied
push & replace the branch on the remote git push origin findbypk_jsdoc --force

evanrittenhouse · 2022-10-14T13:33:29Z

@ephys just getting to this, did we remove the commit linting on v6 commits? Seems like I'm getting 107 (!) errors when trying to commit on the new branch as you mentioned. Though these are actually in the code (i.e. unexpected trailing comma, etc.), so I'm not sure if v6 follows a different linting strategy...?

WikiRik · 2022-10-17T18:29:03Z

@ephys just getting to this, did we remove the commit linting on v6 commits? Seems like I'm getting 107 (!) errors when trying to commit on the new branch as you mentioned. Though these are actually in the code (i.e. unexpected trailing comma, etc.), so I'm not sure if v6 follows a different linting strategy...?

v6 does indeed follow a different config for the linter

ephys · 2022-11-28T17:30:16Z

This PR has been inactive for a while (says the person with 4 PRs in draft since January). Is there still interest in pursuing it, is it blocked, or should we close it?

I'll remove review requests until the branch issue has been resolved, but feel free to re-request a review when ready

WikiRik · 2023-01-03T12:59:03Z

I'm closing this, we can always review a recreation on this PR that works for v6

papandreou and others added 30 commits May 14, 2022 12:53

feat: support using JS BigInt in queries (sequelize#14485)

15b5619

This adds supports for sending JS BigInt values to databases. For retrieving SQL BigInts as JS BigInts, see sequelize#14296

meta: update sequelize AUTHORS (sequelize#14507)

51eff65

chore(deps): update commitlint monorepo to v16.3.0 (sequelize#14506)

4ddf1b1

Co-authored-by: Renovate Bot <bot@renovateapp.com>

chore(deps): update dependency @types/node to v16.11.36 (sequelize#14502

d44fd4c

) Co-authored-by: Renovate Bot <bot@renovateapp.com>

chore(deps): update commitlint monorepo to v17 (sequelize#14512)

a7736da

Co-authored-by: Renovate Bot <bot@renovateapp.com>

refactor: ♻️ migrate moment.js to dayjs (sequelize#14400)

9395e79

chore(deps): update dependency eslint-plugin-jsdoc to v39.3.0 (sequel…

96686c0

…ize#14521) Co-authored-by: Renovate Bot <bot@renovateapp.com>

feat: support uri strings in replication options (sequelize#14501)

ebf0659

ci: enable sqlite unit tests (sequelize#14525)

0641d05

fix: expand where $bind & :replacements can be used (sequelize#14524

87a6123

)

chore(deps): update dependency eslint to v8.16.0 (sequelize#14527)

422dd46

Co-authored-by: Renovate Bot <bot@renovateapp.com>

meta: update sequelize AUTHORS (sequelize#14528)

ca73608

Co-authored-by: SequelizeJS <mail@sequelizejs.com>

build(deps): remove cheerio and module-alias (sequelize#14529)

9d1b061

build(deps): lock file maintenance (sequelize#14530)

f859326

Co-authored-by: Renovate Bot <bot@renovateapp.com>

chore(deps): update dependency lcov-result-merger to v3.2.0 (sequeliz…

18d4cbf

…e#14531) Co-authored-by: Renovate Bot <bot@renovateapp.com>

chore(deps): update dependency eslint-plugin-jsdoc to v39.3.2 (sequel…

e3f6248

…ize#14533) Co-authored-by: Renovate Bot <bot@renovateapp.com>

chore(deps): update dependency typescript to v4.7.2 (sequelize#14537)

cb24466

Co-authored-by: Renovate Bot <bot@renovateapp.com>

ci(typescript): add TS 4.7 to CI (sequelize#14378)

30160cb

Co-authored-by: Zoé <zoe@ephys.dev>

chore(deps): update dependency @commitlint/cli to v17.0.1 (sequelize#…

22e7950

…14541) Co-authored-by: Renovate Bot <bot@renovateapp.com>

chore(deps): update dependency snowflake-sdk to v1.6.10 (sequelize#14550

64b37de

) Co-authored-by: Renovate Bot <bot@renovateapp.com>

docs: update CONTACT.md email (sequelize#14552)

226584e

Move my email to Gmail for security reports and accept specific mail only.

chore(deps): update dependency eslint-plugin-mocha to v10.0.5 (sequel…

840864a

…ize#14558) Co-authored-by: Renovate Bot <bot@renovateapp.com>

chore(deps): update dependency esbuild to v0.14.41 (sequelize#14556)

c4954af

Co-authored-by: Renovate Bot <bot@renovateapp.com>

feat: improve sequelize.query stacktraces (sequelize#14553)

ba4d1b1

Co-authored-by: Zoé <zoe@ephys.dev>

docs: fix typedoc link to Sequelize#define (sequelize#14536)

077fd97

chore(deps): update dependency lint-staged to v12.4.2 (sequelize#14534)

5c8c4c5

Co-authored-by: Renovate Bot <bot@renovateapp.com>

meta: update sequelize AUTHORS (sequelize#14563)

836b14b

Co-authored-by: SequelizeJS <mail@sequelizejs.com> Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>

build(deps): lock file maintenance (sequelize#14567)

4eba1d1

Co-authored-by: Renovate Bot <bot@renovateapp.com>

WikiRik and others added 10 commits October 1, 2022 19:12

meta(types): add dialect typing stubs (sequelize#15071)

47b1dd0

meta: use crypto module instead of uuid (sequelize#15074)

54435cc

meta: update sequelize AUTHORS (sequelize#15076)

e98adec

Co-authored-by: SequelizeJS <mail@sequelizejs.com> Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>

meta: update dependency sqlite3 to v5.1.2 (sequelize#15081)

e1bdf53

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

meta: lock file maintenance (sequelize#15080)

27beae8

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

meta: update dependency sinon to v14.0.1 (sequelize#15083)

f712f1f

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

docs: update instructions for running databases in Docker (sequelize#…

cf367ca

…15079) * docs: correct instructions for running databases in Docker * docs: correct, add versioning info for test databases Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>

change jsdoc for findbypk

fcfad3d

Copy documentation from V7

4eefc1e

evanrittenhouse mentioned this pull request Oct 11, 2022

docs: change jsdoc for findbypk #15111

Closed

5 tasks

evanrittenhouse commented Oct 11, 2022

View reviewed changes

evanrittenhouse requested review from ephys and a team October 11, 2022 14:48

ephys changed the title ~~Findbypk jsdoc~~ docs: describe findByPk's option bag Oct 11, 2022

evanrittenhouse changed the base branch from main to v6 October 11, 2022 18:22

WikiRik added the v6 label Nov 6, 2022

WikiRik marked this pull request as draft November 16, 2022 12:20

ephys removed request for a team and ephys November 28, 2022 17:31

WikiRik closed this Jan 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: describe `findByPk`'s option bag #15115

docs: describe `findByPk`'s option bag #15115

evanrittenhouse commented Oct 11, 2022

evanrittenhouse Oct 11, 2022

ephys commented Oct 11, 2022

evanrittenhouse commented Oct 11, 2022 •

edited

fzn0x commented Oct 11, 2022

fzn0x commented Oct 11, 2022

ephys commented Oct 12, 2022

evanrittenhouse commented Oct 14, 2022 •

edited

WikiRik commented Oct 17, 2022

ephys commented Nov 28, 2022 •

edited

WikiRik commented Jan 3, 2023

docs: describe findByPk's option bag #15115

docs: describe findByPk's option bag #15115

Conversation

evanrittenhouse commented Oct 11, 2022

Pull Request Checklist

Description Of Change

Todos

evanrittenhouse Oct 11, 2022

Choose a reason for hiding this comment

ephys commented Oct 11, 2022

evanrittenhouse commented Oct 11, 2022 • edited

fzn0x commented Oct 11, 2022

fzn0x commented Oct 11, 2022

ephys commented Oct 12, 2022

evanrittenhouse commented Oct 14, 2022 • edited

WikiRik commented Oct 17, 2022

ephys commented Nov 28, 2022 • edited

WikiRik commented Jan 3, 2023

docs: describe `findByPk`'s option bag #15115

docs: describe `findByPk`'s option bag #15115

evanrittenhouse commented Oct 11, 2022 •

edited

evanrittenhouse commented Oct 14, 2022 •

edited

ephys commented Nov 28, 2022 •

edited