Skip to main content

legacyIdents

@webda/auth


Function: legacyIdents()

legacyIdents(IdentModel?, query?): AsyncGenerator<Ident>

Defined in: packages/auth/src/compat/upgrade.ts:186

Enumerate the v3 idents of a store, for a batch migration (webda auth migrate)

Iterates the ident model (all idents, the v3 ones are filtered client side: they lack providerUid, which stores cannot portably query for) and yields only the v3 records. Pass each to upgradeIdent. Upgrading deletes records, which shifts offset-based pagination (memory and file stores page by position): a migration upgrading while iterating must run passes until one yields nothing (upgrades are idempotent).

Parameters​

IdentModel?​

ModelClass<Ident> = ...

ident model of the application

query?​

string = ""

optional WebdaQL filter, e.g. "_user = 'uid'"

Returns​

AsyncGenerator<Ident>

the v3 idents