static/jsvm/interfaces/core.App.html
App defines the main PocketBase app interface.
Note that the interface is not intended to be implemented manually by users and instead they should use core.BaseApp (either directly or as embedded field in a custom struct).
This interface exists to make testing easier and to allow users to create common and pluggable helpers and methods that doesn't rely on a specific wrapped app struct (hence the large interface size).
auxConcurrentDBauxDBauxDeleteauxDeleteWithContextauxHasTableauxModelQueryauxNonconcurrentDBauxRunInTransactionauxSaveauxSaveNoValidateauxSaveNoValidateWithContextauxSaveWithContextauxVacuumbootstrapcanAccessRecordcollectionQueryconcurrentDBcountRecordscreateBackupcreateViewFieldscrondataDirdbdeletedeleteAllAuthOriginsByRecorddeleteAllMFAsByRecorddeleteAllOTPsByRecorddeleteExpiredMFAsdeleteExpiredOTPsdeleteOldLogsdeleteTabledeleteViewdeleteWithContextencryptionEnvexpandRecordexpandRecordsfindAllAuthOriginsByCollectionfindAllAuthOriginsByRecordfindAllCollectionsfindAllExternalAuthsByCollectionfindAllExternalAuthsByRecordfindAllMFAsByCollectionfindAllMFAsByRecordfindAllOTPsByCollectionfindAllOTPsByRecordfindAllRecordsfindAuthOriginByIdfindAuthOriginByRecordAndFingerprintfindAuthRecordByEmailfindAuthRecordByTokenfindCachedCollectionByNameOrIdfindCachedCollectionReferencesfindCollectionByNameOrIdfindCollectionReferencesfindFirstExternalAuthByExprfindFirstRecordByDatafindFirstRecordByFilterfindLogByIdfindMFAByIdfindOTPByIdfindRecordByIdfindRecordByViewFilefindRecordsByFilterfindRecordsByIdshasTableimportCollectionsimportCollectionsByMarshaledJSONisBootstrappedisCollectionNameUniqueisDevisTransactionallogQueryloggerlogsStatsmodelQuerynewBackupsFilesystemnewFilesystemnewMailClientnonconcurrentDBonBackupCreateonBackupRestoreonBatchRequestonBootstraponCollectionAfterCreateErroronCollectionAfterCreateSuccessonCollectionAfterDeleteErroronCollectionAfterDeleteSuccessonCollectionAfterUpdateErroronCollectionAfterUpdateSuccessonCollectionCreateonCollectionCreateExecuteonCollectionCreateRequestonCollectionDeleteonCollectionDeleteExecuteonCollectionDeleteRequestonCollectionUpdateonCollectionUpdateExecuteonCollectionUpdateRequestonCollectionValidateonCollectionViewRequestonCollectionsImportRequestonCollectionsListRequestonFileDownloadRequestonFileTokenRequestonMailerRecordAuthAlertSendonMailerRecordEmailChangeSendonMailerRecordOTPSendonMailerRecordPasswordResetSendonMailerRecordVerificationSendonMailerSendonModelAfterCreateErroronModelAfterCreateSuccessonModelAfterDeleteErroronModelAfterDeleteSuccessonModelAfterUpdateErroronModelAfterUpdateSuccessonModelCreateonModelCreateExecuteonModelDeleteonModelDeleteExecuteonModelUpdateonModelUpdateExecuteonModelValidateonRealtimeConnectRequestonRealtimeMessageSendonRealtimeSubscribeRequestonRecordAfterCreateErroronRecordAfterCreateSuccessonRecordAfterDeleteErroronRecordAfterDeleteSuccessonRecordAfterUpdateErroronRecordAfterUpdateSuccessonRecordAuthRefreshRequestonRecordAuthRequestonRecordAuthWithOAuth2RequestonRecordAuthWithOTPRequestonRecordAuthWithPasswordRequestonRecordConfirmEmailChangeRequestonRecordConfirmPasswordResetRequestonRecordConfirmVerificationRequestonRecordCreateonRecordCreateExecuteonRecordCreateRequestonRecordDeleteonRecordDeleteExecuteonRecordDeleteRequestonRecordEnrichonRecordRequestEmailChangeRequestonRecordRequestOTPRequestonRecordRequestPasswordResetRequestonRecordRequestVerificationRequestonRecordUpdateonRecordUpdateExecuteonRecordUpdateRequestonRecordValidateonRecordViewRequestonRecordsListRequestonServeonSettingsListRequestonSettingsReloadonSettingsUpdateRequestonTerminaterecordQueryreloadCachedCollectionsreloadSettingsresetBootstrapStaterestartrestoreBackuprunAllMigrationsrunAppMigrationsrunInTransactionrunSystemMigrationssavesaveNoValidatesaveNoValidateWithContextsaveViewsaveWithContextsettingsstoresubscriptionsBrokersyncRecordTableSchematableColumnstableIndexestableInfotruncateCollectiontxInfounsafeWithoutHooksvacuumvalidatevalidateWithContext
AuxConcurrentDB returns the concurrent app auxiliary.db builder instance.
This method is used mainly internally for executing db read operations in a concurrent/non-blocking manner.
Most users should use simply AuxDB() as it will automatically route the query execution to AuxConcurrentDB() or AuxNonconcurrentDB().
In a transaction the AuxConcurrentDB() and AuxNonconcurrentDB() refer to the same *dbx.TX instance.
AuxDB returns the app auxiliary.db builder instance.
To minimize SQLITE_BUSY errors, it automatically routes the SELECT queries to the underlying concurrent db pool and everything else to the nonconcurrent one.
For more finer control over the used connections pools you can call directly AuxConcurrentDB() or AuxNonconcurrentDB().
AuxDelete deletes the specified model from the auxiliary database.
AuxDeleteWithContext deletes the specified model from the auxiliary database (the context could be used to limit the query execution).
AuxHasTable checks if a table (or view) with the provided name exists (case insensitive) in the auxiliary.db.
AuxModelQuery creates a new preconfigured select auxiliary.db query with preset SELECT, FROM and other common fields based on the provided model.
AuxNonconcurrentDB returns the nonconcurrent app auxiliary.db builder instance.
The returned db instance is limited only to a single open connection, meaning that it can process only 1 db operation at a time (other queries queue up).
This method is used mainly internally and in the tests to execute write (save/delete) db operations as it helps with minimizing the SQLITE_BUSY errors.
Most users should use simply AuxDB() as it will automatically route the query execution to AuxConcurrentDB() or AuxNonconcurrentDB().
In a transaction the AuxConcurrentDB() and AuxNonconcurrentDB() refer to the same *dbx.TX instance.
AuxRunInTransaction wraps fn into a transaction for the auxiliary app database.
It is safe to nest RunInTransaction calls as long as you use the callback's txApp.
-
- (txApp): void
-
-
AuxSave validates and saves the specified model into the auxiliary app database.
If you don't want to run validations, use [App.AuxSaveNoValidate()].
AuxSaveNoValidate saves the specified model into the auxiliary app database without performing validations.
If you want to also run validations before persisting, use [App.AuxSave()].
AuxSaveNoValidateWithContext is the same as [App.AuxSaveNoValidate()] but allows specifying a context to limit the db execution.
If you want to also run validations before persisting, use [App.AuxSaveWithContext()].
AuxSaveWithContext is the same as [App.AuxSave()] but allows specifying a context to limit the db execution.
If you don't want to run validations, use [App.AuxSaveNoValidateWithContext()].
AuxVacuum executes VACUUM on the auxiliary.db in order to reclaim unused auxiliary db disk space.
Bootstrap initializes the application (aka. create data dir, open db connections, load settings, etc.).
It will call ResetBootstrapState() if the application was already bootstrapped.
CanAccessRecord checks if a record is allowed to be accessed by the specified requestInfo and accessRule.
Rule and db checks are ignored in case requestInfo.Auth is a superuser.
The returned error indicate that something unexpected happened during the check (eg. invalid rule or db query error).
The method always return false on invalid rule or db query error.
Example:
requestInfo, _ := e.RequestInfo() record, _ := app.FindRecordById("example", "RECORD_ID") rule := types.Pointer("@request.auth.id != '' || status = 'public'") // ... or use one of the record collection's rule, eg. record.Collection().ViewRule if ok, _ := app.CanAccessRecord(record, requestInfo, rule); ok { ... }Copy
CollectionQuery returns a new Collection select query.
ConcurrentDB returns the concurrent app data.db builder instance.
This method is used mainly internally for executing db read operations in a concurrent/non-blocking manner.
Most users should use simply DB() as it will automatically route the query execution to ConcurrentDB() or NonconcurrentDB().
In a transaction the ConcurrentDB() and NonconcurrentDB() refer to the same *dbx.TX instance.
CountRecords returns the total number of records in a collection.
Rest ...exprs: Expression[]CreateBackup creates a new backup of the current app pb_data directory.
Backups can be stored on S3 if it is configured in app.Settings().Backups.
Please refer to the godoc of the specific CoreApp implementation for details on the backup procedures.
CreateViewFields creates a new FieldsList from the provided select query.
There are some caveats:
NB! Be aware that this method is vulnerable to SQL injection and the "dangerousSelectQuery" argument must come only from trusted input!
Cron returns the app cron instance.
DataDir returns the app data directory path.
DB returns the default app data.db builder instance.
To minimize SQLITE_BUSY errors, it automatically routes the SELECT queries to the underlying concurrent db pool and everything else to the nonconcurrent one.
For more finer control over the used connections pools you can call directly ConcurrentDB() or NonconcurrentDB().
Delete deletes the specified model from the regular app database.
DeleteAllAuthOriginsByRecord deletes all AuthOrigin models associated with the provided record.
Returns a combined error with the failed deletes.
DeleteAllMFAsByRecord deletes all MFA models associated with the provided record.
Returns a combined error with the failed deletes.
DeleteAllOTPsByRecord deletes all OTP models associated with the provided record.
Returns a combined error with the failed deletes.
DeleteExpiredMFAs deletes the expired MFAs for all auth collections.
DeleteExpiredOTPs deletes the expired OTPs for all auth collections.
DeleteOldLogs delete all logs that are created before createdBefore.
DeleteTable drops the specified table.
This method is a no-op if a table with the provided name doesn't exist.
NB! Be aware that this method is vulnerable to SQL injection and the "dangerousTableName" argument must come only from trusted input!
DeleteView drops the specified view name.
This method is a no-op if a view with the provided name doesn't exist.
NB! Be aware that this method is vulnerable to SQL injection and the "dangerousViewName" argument must come only from trusted input!
Delete deletes the specified model from the regular app database (the context could be used to limit the query execution).
EncryptionEnv returns the name of the app secret env key (currently used primarily for optional settings encryption but this may change in the future).
ExpandRecord expands the relations of a single Record model.
If optFetchFunc is not set, then a default function will be used that returns all relation records.
Returns a map with the failed expand parameters and their errors.
ExpandRecords expands the relations of the provided Record models list.
If optFetchFunc is not set, then a default function will be used that returns all relation records.
Returns a map with the failed expand parameters and their errors.
FindAllAuthOriginsByCollection returns all AuthOrigin models linked to the provided collection (in DESC order).
FindAllAuthOriginsByRecord returns all AuthOrigin models linked to the provided auth record (in DESC order).
FindCollections finds all collections by the given type(s).
If collectionTypes is not set, it returns all collections.
Example:
app.FindAllCollections() // all collections app.FindAllCollections("auth", "view") // only auth and view collectionsCopy
Rest ...collectionTypes: string[]FindAllExternalAuthsByCollection returns all ExternalAuth models linked to the provided auth collection.
FindAllExternalAuthsByRecord returns all ExternalAuth models linked to the provided auth record.
FindAllMFAsByCollection returns all MFA models linked to the provided collection.
FindAllMFAsByRecord returns all MFA models linked to the provided auth record.
FindAllOTPsByCollection returns all OTP models linked to the provided collection.
FindAllOTPsByRecord returns all OTP models linked to the provided auth record.
FindAllRecords finds all records matching specified db expressions.
Returns all collection records if no expression is provided.
Returns an empty slice if no records are found.
Example:
// no extra expressions app.FindAllRecords("example") // with extra expressions expr1 := dbx.HashExp{"email": "[email protected]"} expr2 := dbx.NewExp("LOWER(username) = {:username}", dbx.Params{"username": "test"}) app.FindAllRecords("example", expr1, expr2)Copy
Rest ...exprs: Expression[]FindAuthOriginById returns a single AuthOrigin model by its id.
FindAuthOriginByRecordAndFingerprint returns a single AuthOrigin model by its authRecord relation and fingerprint.
FindAuthRecordByEmail finds the auth record associated with the provided email.
Returns an error if it is not an auth collection or the record is not found.
FindAuthRecordByToken finds the auth record associated with the provided JWT (auth, file, verifyEmail, changeEmail, passwordReset types).
Optionally specify a list of validTypes to check tokens only from those types.
Returns an error if the JWT is invalid, expired or not associated to an auth collection record.
Rest ...validTypes: string[]FindCachedCollectionByNameOrId is similar to [App.FindCollectionByNameOrId] but retrieves the Collection from the app cache instead of making a db call.
NB! This method is suitable for read-only Collection operations.
Returns [sql.ErrNoRows] if no Collection is found for consistency with the [App.FindCollectionByNameOrId] method.
If you plan making changes to the returned Collection model, use [App.FindCollectionByNameOrId] instead.
Caveats:
- The returned Collection should be used only for read-only operations. Avoid directly modifying the returned cached Collection as it will affect the global cached value even if you don't persist the changes in the database! - If you are updating a Collection in a transaction and then call this method before commit, it'll return the cached Collection state and not the one from the uncommitted transaction. - The cache is automatically updated on collections db change (create/update/delete). To manually reload the cache you can call [App.ReloadCachedCollections]Copy
FindCachedCollectionReferences is similar to [App.FindCollectionReferences] but retrieves the Collection from the app cache instead of making a db call.
NB! This method is suitable for read-only Collection operations.
If you plan making changes to the returned Collection model, use [App.FindCollectionReferences] instead.
Caveats:
- The returned Collection should be used only for read-only operations. Avoid directly modifying the returned cached Collection as it will affect the global cached value even if you don't persist the changes in the database! - If you are updating a Collection in a transaction and then call this method before commit, it'll return the cached Collection state and not the one from the uncommitted transaction. - The cache is automatically updated on collections db change (create/update/delete). To manually reload the cache you can call [App.ReloadCachedCollections].Copy
Rest ...excludeIds: string[]FindCollectionByNameOrId finds a single collection by its name (case insensitive) or id.s
FindCollectionReferences returns information for all relation fields referencing the provided collection.
If the provided collection has reference to itself then it will be also included in the result. To exclude it, pass the collection id as the excludeIds argument.
Rest ...excludeIds: string[]FindFirstExternalAuthByExpr returns the first available (the most recent created) ExternalAuth model that satisfies the non-nil expression.
FindFirstRecordByData returns the first found record matching the provided key-value pair.
FindFirstRecordByFilter returns the first available record matching the provided filter (if any).
NB! Use the last params argument to bind untrusted user variables!
Returns sql.ErrNoRows if no record is found.
Example:
app.FindFirstRecordByFilter("posts", "") app.FindFirstRecordByFilter("posts", "slug={:slug} && status='public'", dbx.Params{"slug": "test"})Copy
Rest ...params: Params[]FindLogById finds a single Log entry by its id.
FindMFAById returns a single MFA model by its id.
FindOTPById returns a single OTP model by its id.
FindRecordById finds the Record model by its id.
Rest ...optFilters: ((q) => void)[]FindRecordByViewFile returns the original Record of the provided view collection file.
FindRecordsByFilter returns limit number of records matching the provided string filter.
NB! Use the last "params" argument to bind untrusted user variables!
The filter argument is optional and can be empty string to target all available records.
The sort argument is optional and can be empty string OR the same format used in the web APIs, ex. "-created,title".
If the limit argument is <= 0, no limit is applied to the query and all matching records are returned.
Returns an empty slice if no records are found.
Example:
app.FindRecordsByFilter( "posts", "title ~ {:title} && visible = {:visible}", "-created", 10, 0, dbx.Params{"title": "lorem ipsum", "visible": true} )Copy
Rest ...params: Params[]FindRecordsByIds finds all records by the specified ids. If no records are found, returns an empty slice.
Rest ...optFilters: ((q) => void)[]HasTable checks if a table (or view) with the provided name exists (case insensitive). in the data.db.
ImportCollections imports the provided collections data in a single transaction.
For existing matching collections, the imported data is unmarshaled on top of the existing model.
NB! If deleteMissing is true, ALL NON-SYSTEM COLLECTIONS AND SCHEMA FIELDS, that are not present in the imported configuration, WILL BE DELETED (this includes their related records data).
ImportCollectionsByMarshaledJSON is the same as [ImportCollections] but accept marshaled json array as import data (usually used for the autogenerated snapshots).
IsBootstrapped checks if the application was initialized (aka. whether Bootstrap() was called).
IsCollectionNameUnique checks that there is no existing collection with the provided name (case insensitive!).
Note: case insensitive check because the name is used also as table name for the records.
Rest ...excludeIds: string[]IsDev returns whether the app is in dev mode.
When enabled logs, executed sql statements, etc. are printed to the stderr.
IsTransactional checks if the current app instance is part of a transaction.
LogQuery returns a new Log select query.
Logger returns the default app logger.
If the application is not bootstrapped yet, fallbacks to slog.Default().
LogsStatsItem returns hourly grouped logs statistics.
ModelQuery creates a new preconfigured select data.db query with preset SELECT, FROM and other common fields based on the provided model.
NewBackupsFilesystem creates a new local or S3 filesystem instance for managing app backups based on the current app settings.
NB! Make sure to call Close() on the returned result after you are done working with it.
NewFilesystem creates a new local or S3 filesystem instance for managing regular app files (ex. record uploads) based on the current app settings.
NB! Make sure to call Close() on the returned result after you are done working with it.
NewMailClient creates and returns a new SMTP or Sendmail client based on the current app settings.
NonconcurrentDB returns the nonconcurrent app data.db builder instance.
The returned db instance is limited only to a single open connection, meaning that it can process only 1 db operation at a time (other queries queue up).
This method is used mainly internally and in the tests to execute write (save/delete) db operations as it helps with minimizing the SQLITE_BUSY errors.
Most users should use simply DB() as it will automatically route the query execution to ConcurrentDB() or NonconcurrentDB().
In a transaction the ConcurrentDB() and NonconcurrentDB() refer to the same *dbx.TX instance.
OnBackupCreate hook is triggered on each [App.CreateBackup] call.
OnBackupRestore hook is triggered before app backup restore (aka. [App.RestoreBackup] call).
Note that by default on success the application is restarted and the after state of the hook is ignored.
OnBatchRequest hook is triggered on each API batch request.
Could be used to additionally validate or modify the submitted batch requests.
OnBootstrap hook is triggered when initializing the main application resources (db, app settings, etc).
OnCollectionAfterCreateError is a Collection proxy model hook of [OnModelAfterCreateError].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionAfterCreateSuccess is a Collection proxy model hook of [OnModelAfterCreateSuccess].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionAfterDeleteError is a Collection proxy model hook of [OnModelAfterDeleteError].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionAfterDeleteSuccess is a Collection proxy model hook of [OnModelAfterDeleteSuccess].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionAfterUpdateError is a Collection proxy model hook of [OnModelAfterUpdateError].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionAfterUpdateSuccess is a Collection proxy model hook of [OnModelAfterUpdateSuccess].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionCreate is a Collection proxy model hook of [OnModelCreate].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionCreateExecute is a Collection proxy model hook of [OnModelCreateExecute].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionCreateRequest hook is triggered on each API Collection create request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
OnCollectionDelete is a Collection proxy model hook of [OnModelDelete].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionDeleteExecute is a Collection proxy model hook of [OnModelDeleteExecute].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionDeleteRequest hook is triggered on each API Collection delete request.
Could be used to additionally validate the request data or implement completely different delete behavior.
OnCollectionUpdate is a Collection proxy model hook of [OnModelUpdate].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionUpdateExecute is a Collection proxy model hook of [OnModelUpdateExecute].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionUpdateRequest hook is triggered on each API Collection update request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
OnCollectionValidate is a Collection proxy model hook of [OnModelValidate].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnCollectionViewRequest hook is triggered on each API Collection view request.
Could be used to validate or modify the response before returning it to the client.
OnCollectionsBeforeImportRequest hook is triggered on each API collections import request.
Could be used to additionally validate the imported collections or to implement completely different import behavior.
OnCollectionsListRequest hook is triggered on each API Collections list request.
Could be used to validate or modify the response before returning it to the client.
OnFileDownloadRequest hook is triggered before each API File download request.
Could be used to validate or modify the file response before returning it to the client.
Rest ...tags: string[]OnFileBeforeTokenRequest hook is triggered on each auth file token API request.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnMailerRecordAuthAlertSend hook is triggered when sending a new device login auth alert email, allowing you to intercept and customize the email message that is being sent.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnMailerRecordEmailChangeSend hook is triggered when sending a confirmation new address email to an auth record, allowing you to intercept and customize the email message that is being sent.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnMailerRecordOTPSend hook is triggered when sending an OTP email to an auth record, allowing you to intercept and customize the email message that is being sent.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnMailerBeforeRecordResetPasswordSend hook is triggered when sending a password reset email to an auth record, allowing you to intercept and customize the email message that is being sent.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnMailerBeforeRecordVerificationSend hook is triggered when sending a verification email to an auth record, allowing you to intercept and customize the email message that is being sent.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnMailerSend hook is triggered every time when a new email is being sent using the [App.NewMailClient()] instance.
It allows intercepting the email message or to use a custom mailer client.
OnModelAfterCreateError is triggered after each failed Model DB create persistence.
Note that the execution of this hook is either immediate or delayed depending on the error:
- "immediate" on App.Save() failure - "delayed" on transaction rollbackCopy
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelAfterCreateSuccess is triggered after each successful Model DB create persistence.
Note that when a Model is persisted as part of a transaction, this hook is delayed and executed only AFTER the transaction has been committed. This hook is NOT triggered in case the transaction rollbacks (aka. when the model wasn't persisted).
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelAfterDeleteError is triggered after each failed Model DB delete persistence.
Note that the execution of this hook is either immediate or delayed depending on the error:
- "immediate" on App.Delete() failure - "delayed" on transaction rollbackCopy
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelAfterDeleteSuccess is triggered after each successful Model DB delete persistence.
Note that when a Model is deleted as part of a transaction, this hook is delayed and executed only AFTER the transaction has been committed. This hook is NOT triggered in case the transaction rollbacks (aka. when the model delete wasn't persisted).
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelAfterUpdateError is triggered after each failed Model DB update persistence.
Note that the execution of this hook is either immediate or delayed depending on the error:
- "immediate" on App.Save() failure - "delayed" on transaction rollbackCopy
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelAfterUpdateSuccess is triggered after each successful Model DB update persistence.
Note that when a Model is persisted as part of a transaction, this hook is delayed and executed only AFTER the transaction has been committed. This hook is NOT triggered in case the transaction rollbacks (aka. when the model changes weren't persisted).
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelCreate is triggered every time when a new model is being created (e.g. triggered by App.Save()).
Operations BEFORE the e.Next() execute before the model validation and the INSERT DB statement.
Operations AFTER the e.Next() execute after the model validation and the INSERT DB statement.
Note that successful execution doesn't guarantee that the model is persisted in the database since its wrapping transaction may not have been committed yet. If you want to listen to only the actual persisted events, you can bind to [OnModelAfterCreateSuccess] or [OnModelAfterCreateError] hooks.
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelCreateExecute is triggered after successful Model validation and right before the model INSERT DB statement execution.
Usually it is triggered as part of the App.Save() in the following firing order: OnModelCreate {
-> OnModelValidate (skipped with App.SaveNoValidate()) -> OnModelCreateExecuteCopy
}
Note that successful execution doesn't guarantee that the model is persisted in the database since its wrapping transaction may have been committed yet. If you want to listen to only the actual persisted events, you can bind to [OnModelAfterCreateSuccess] or [OnModelAfterCreateError] hooks.
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelDelete is triggered every time when a new model is being deleted (e.g. triggered by App.Delete()).
Note that successful execution doesn't guarantee that the model is deleted from the database since its wrapping transaction may not have been committed yet. If you want to listen to only the actual persisted deleted events, you can bind to [OnModelAfterDeleteSuccess] or [OnModelAfterDeleteError] hooks.
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelUpdateExecute is triggered right before the model DELETE DB statement execution.
Usually it is triggered as part of the App.Delete() in the following firing order: OnModelDelete {
-> (internal delete checks) -> OnModelDeleteExecuteCopy
}
Note that successful execution doesn't guarantee that the model is deleted from the database since its wrapping transaction may not have been committed yet. If you want to listen to only the actual persisted deleted events, you can bind to [OnModelAfterDeleteSuccess] or [OnModelAfterDeleteError] hooks.
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelUpdate is triggered every time when a new model is being updated (e.g. triggered by App.Save()).
Operations BEFORE the e.Next() execute before the model validation and the UPDATE DB statement.
Operations AFTER the e.Next() execute after the model validation and the UPDATE DB statement.
Note that successful execution doesn't guarantee that the model is persisted in the database since its wrapping transaction may not have been committed yet. If you want to listen to only the actual persisted events, you can bind to [OnModelAfterUpdateSuccess] or [OnModelAfterUpdateError] hooks.
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelUpdateExecute is triggered after successful Model validation and right before the model UPDATE DB statement execution.
Usually it is triggered as part of the App.Save() in the following firing order: OnModelUpdate {
-> OnModelValidate (skipped with App.SaveNoValidate()) -> OnModelUpdateExecuteCopy
}
Note that successful execution doesn't guarantee that the model is persisted in the database since its wrapping transaction may have been committed yet. If you want to listen to only the actual persisted events, you can bind to [OnModelAfterUpdateSuccess] or [OnModelAfterUpdateError] hooks.
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnModelValidate is triggered every time when a model is being validated (e.g. triggered by App.Validate() or App.Save()).
For convenience, if you want to listen to only the Record models events without doing manual type assertion, you can attach to the OnRecord* proxy hooks.
If the optional "tags" list (Collection id/name, Model table name, etc.) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRealtimeConnectRequest hook is triggered when establishing the SSE client connection.
Any execution after e.Next() of a hook handler happens after the client disconnects.
OnRealtimeMessageSend hook is triggered when sending an SSE message to a client.
OnRealtimeSubscribeRequest hook is triggered when updating the client subscriptions, allowing you to further validate and modify the submitted change.
OnRecordAfterCreateError is a Record proxy model hook of [OnModelAfterCreateError].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordAfterCreateSuccess is a Record proxy model hook of [OnModelAfterCreateSuccess].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordAfterDeleteError is a Record proxy model hook of [OnModelAfterDeleteError].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordAfterDeleteSuccess is a Record proxy model hook of [OnModelAfterDeleteSuccess].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordAfterUpdateError is a Record proxy model hook of [OnModelAfterUpdateError].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordAfterUpdateSuccess is a Record proxy model hook of [OnModelAfterUpdateSuccess].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordAuthRefreshRequest hook is triggered on each Record auth refresh API request (right before generating a new auth token).
Could be used to additionally validate the request data or implement completely different auth refresh behavior.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordAuthRequest hook is triggered on each successful API record authentication request (sign-in, token refresh, etc.).
Could be used to additionally validate or modify the authenticated record data and token.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordAuthWithOAuth2Request hook is triggered on each Record OAuth2 sign-in/sign-up API request (after token exchange and before external provider linking).
If [RecordAuthWithOAuth2RequestEvent.Record] is not set, then the OAuth2 request will try to create a new auth Record.
To assign or link a different existing record model you can change the [RecordAuthWithOAuth2RequestEvent.Record] field.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordAuthWithOTPRequest hook is triggered on each Record auth with OTP API request.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordAuthWithPasswordRequest hook is triggered on each Record auth with password API request.
[RecordAuthWithPasswordRequestEvent.Record] could be nil if no matching identity is found, allowing you to manually locate a different Record model (by reassigning [RecordAuthWithPasswordRequestEvent.Record]).
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordConfirmEmailChangeRequest hook is triggered on each Record confirm email change API request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordConfirmPasswordResetRequest hook is triggered on each Record confirm password reset API request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordConfirmVerificationRequest hook is triggered on each Record confirm verification API request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordCreate is a Record proxy model hook of [OnModelCreate].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordCreateExecute is a Record proxy model hook of [OnModelCreateExecute].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordCreateRequest hook is triggered on each API Record create request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordDelete is a Record proxy model hook of [OnModelDelete].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordDeleteExecute is a Record proxy model hook of [OnModelDeleteExecute].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordDeleteRequest hook is triggered on each API Record delete request.
Could be used to additionally validate the request data or implement completely different delete behavior.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordEnrich is triggered every time when a record is enriched (as part of the builtin Record responses, during realtime message seriazation, or when [apis.EnrichRecord] is invoked).
It could be used for example to redact/hide or add computed temporary Record model props only for the specific request info. For example:
app.OnRecordEnrich("posts").BindFunc(func(e core.*RecordEnrichEvent) {
// hide one or more fields e.Record.Hide("role") // add new custom field for registered users if e.RequestInfo.Auth != nil && e.RequestInfo.Auth.Collection().Name == "users" { e.Record.WithCustomData(true) // for security requires explicitly allowing it e.Record.Set("computedScore", e.Record.GetInt("score") * e.RequestInfo.Auth.GetInt("baseScore")) } return e.Next()Copy
})
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordRequestEmailChangeRequest hook is triggered on each Record request email change API request.
Could be used to additionally validate the request data or implement completely different request email change behavior.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordRequestOTPRequest hook is triggered on each Record request OTP API request.
[RecordCreateOTPRequestEvent.Record] could be nil if no matching identity is found, allowing you to manually create or locate a different Record model (by reassigning [RecordCreateOTPRequestEvent.Record]).
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordRequestPasswordResetRequest hook is triggered on each Record request password reset API request.
Could be used to additionally validate the request data or implement completely different password reset behavior.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordRequestVerificationRequest hook is triggered on each Record request verification API request.
Could be used to additionally validate the loaded request data or implement completely different verification behavior.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordUpdate is a Record proxy model hook of [OnModelUpdate].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordUpdateExecute is a Record proxy model hook of [OnModelUpdateExecute].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordUpdateRequest hook is triggered on each API Record update request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordValidate is a Record proxy model hook of [OnModelValidate].
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordViewRequest hook is triggered on each API Record view request.
Could be used to validate or modify the response before returning it to the client.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnRecordsListRequest hook is triggered on each API Records list request.
Could be used to validate or modify the response before returning it to the client.
If the optional "tags" list (Collection ids or names) is specified, then all event handlers registered via the created hook will be triggered and called only if their event data origin matches the tags.
Rest ...tags: string[]OnServe hook is triggered when the app web server is started (after starting the TCP listener but before initializing the blocking serve task), allowing you to adjust its options and attach new routes or middlewares.
OnSettingsListRequest hook is triggered on each API Settings list request.
Could be used to validate or modify the response before returning it to the client.
OnSettingsReload hook is triggered every time when the App.Settings() is being replaced with a new state.
Calling App.Settings() after e.Next() returns the new state.
OnSettingsUpdateRequest hook is triggered on each API Settings update request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
OnTerminate hook is triggered when the app is in the process of being terminated (ex. on SIGTERM signal).
Note that the app could be terminated abruptly without awaiting the hook completion.
RecordQuery returns a new Record select query from a collection model, id or name.
In case a collection id or name is provided and that collection doesn't actually exists, the generated query will be created with a cancelled context and will fail once an executor (Row(), One(), All(), etc.) is called.
ReloadCachedCollections fetches all collections and caches them into the app store.
ReloadSettings reinitializes and reloads the stored application settings.
ResetBootstrapState releases the initialized core app resources (closing db connections, stopping cron ticker, etc.).
Restart restarts (aka. replaces) the current running application process.
NB! It relies on execve which is supported only on UNIX based systems.
RestoreBackup restores the backup with the specified name and restarts the current running application process.
The safely perform the restore it is recommended to have free disk space for at least 2x the size of the restored pb_data backup.
Please refer to the godoc of the specific CoreApp implementation for details on the restore procedures.
NB! This feature is experimental and currently is expected to work only on UNIX based systems.
RunAllMigrations applies all system and app migrations (aka. from both [core.SystemMigrations] and [CoreAppMigrations]).
RunAppMigrations applies all new migrations registered in the [CoreAppMigrations] list.
RunInTransaction wraps fn into a transaction for the regular app database.
It is safe to nest RunInTransaction calls as long as you use the callback's txApp.
-
- (txApp): void
-
-
RunSystemMigrations applies all new migrations registered in the [core.SystemMigrations] list.
Save validates and saves the specified model into the regular app database.
If you don't want to run validations, use [App.SaveNoValidate()].
SaveNoValidate saves the specified model into the regular app database without performing validations.
If you want to also run validations before persisting, use [App.Save()].
SaveNoValidateWithContext is the same as [App.SaveNoValidate()] but allows specifying a context to limit the db execution.
If you want to also run validations before persisting, use [App.SaveWithContext()].
SaveView creates (or updates already existing) persistent SQL view.
NB! Be aware that this method is vulnerable to SQL injection and its arguments must come only from trusted input!
SaveWithContext is the same as [App.Save()] but allows specifying a context to limit the db execution.
If you don't want to run validations, use [App.SaveNoValidateWithContext()].
Settings returns the loaded app settings.
Store returns the app runtime store.
SubscriptionsBroker returns the app realtime subscriptions broker instance.
SyncRecordTableSchema compares the two provided collections and applies the necessary related record table changes.
If oldCollection is null, then only newCollection is used to create the record table.
This method is automatically invoked as part of a collection create/update/delete operation.
TableColumns returns all column names of a single table by its name.
TableIndexes returns a name grouped map with all non empty index of the specified table.
Note: This method doesn't return an error on nonexisting table.
TableInfo returns the "table_info" pragma result for the specified table.
TruncateCollection deletes all records associated with the provided collection.
The truncate operation is executed in a single transaction, aka. either everything is deleted or none.
Note that this method will also trigger the records related cascade and file delete actions.
TxInfo returns the transaction associated with the current app instance (if any).
Could be used if you want to execute indirectly a function after the related app transaction completes using app.TxInfo().OnAfterFunc(callback).
UnsafeWithoutHooks returns a shallow copy of the current app WITHOUT any registered hooks.
NB! Note that using the returned app instance may cause data integrity errors since the Record validations and data normalizations (including files uploads) rely on the app hooks to work.
Vacuum executes VACUUM on the data.db in order to reclaim unused data db disk space.
Validate triggers the OnModelValidate hook for the specified model.
ValidateWithContext is the same as Validate but allows specifying the ModelEvent context.
OSLightDark
Generated using TypeDoc