Documentation ¶
Overview ¶
Package core is the backbone of PocketBase.
It defines the main PocketBase App interface and its base implementation.
Index ¶
- Constants
- type AdminAuthEvent
- type AdminAuthRefreshEvent
- type AdminAuthWithPasswordEvent
- type AdminConfirmPasswordResetEvent
- type AdminCreateEvent
- type AdminDeleteEvent
- type AdminRequestPasswordResetEvent
- type AdminUpdateEvent
- type AdminViewEvent
- type AdminsListEvent
- type ApiErrorEvent
- type App
- type BaseApp
- func (app *BaseApp) Bootstrap() error
- func (app *BaseApp) Cache() *store.Store[any]
- func (app *BaseApp) DB() *dbx.DBdeprecated
- func (app *BaseApp) Dao() *daos.Dao
- func (app *BaseApp) DataDir() string
- func (app *BaseApp) EncryptionEnv() string
- func (app *BaseApp) IsBootstrapped() bool
- func (app *BaseApp) IsDebug() bool
- func (app *BaseApp) LogsDB() *dbx.DBdeprecated
- func (app *BaseApp) LogsDao() *daos.Dao
- func (app *BaseApp) NewFilesystem() (*filesystem.System, error)
- func (app *BaseApp) NewMailClient() mailer.Mailer
- func (app *BaseApp) OnAdminAfterAuthRefreshRequest() *hook.Hook[*AdminAuthRefreshEvent]
- func (app *BaseApp) OnAdminAfterAuthWithPasswordRequest() *hook.Hook[*AdminAuthWithPasswordEvent]
- func (app *BaseApp) OnAdminAfterConfirmPasswordResetRequest() *hook.Hook[*AdminConfirmPasswordResetEvent]
- func (app *BaseApp) OnAdminAfterCreateRequest() *hook.Hook[*AdminCreateEvent]
- func (app *BaseApp) OnAdminAfterDeleteRequest() *hook.Hook[*AdminDeleteEvent]
- func (app *BaseApp) OnAdminAfterRequestPasswordResetRequest() *hook.Hook[*AdminRequestPasswordResetEvent]
- func (app *BaseApp) OnAdminAfterUpdateRequest() *hook.Hook[*AdminUpdateEvent]
- func (app *BaseApp) OnAdminAuthRequest() *hook.Hook[*AdminAuthEvent]
- func (app *BaseApp) OnAdminBeforeAuthRefreshRequest() *hook.Hook[*AdminAuthRefreshEvent]
- func (app *BaseApp) OnAdminBeforeAuthWithPasswordRequest() *hook.Hook[*AdminAuthWithPasswordEvent]
- func (app *BaseApp) OnAdminBeforeConfirmPasswordResetRequest() *hook.Hook[*AdminConfirmPasswordResetEvent]
- func (app *BaseApp) OnAdminBeforeCreateRequest() *hook.Hook[*AdminCreateEvent]
- func (app *BaseApp) OnAdminBeforeDeleteRequest() *hook.Hook[*AdminDeleteEvent]
- func (app *BaseApp) OnAdminBeforeRequestPasswordResetRequest() *hook.Hook[*AdminRequestPasswordResetEvent]
- func (app *BaseApp) OnAdminBeforeUpdateRequest() *hook.Hook[*AdminUpdateEvent]
- func (app *BaseApp) OnAdminViewRequest() *hook.Hook[*AdminViewEvent]
- func (app *BaseApp) OnAdminsListRequest() *hook.Hook[*AdminsListEvent]
- func (app *BaseApp) OnAfterApiError() *hook.Hook[*ApiErrorEvent]
- func (app *BaseApp) OnAfterBootstrap() *hook.Hook[*BootstrapEvent]
- func (app *BaseApp) OnBeforeApiError() *hook.Hook[*ApiErrorEvent]
- func (app *BaseApp) OnBeforeBootstrap() *hook.Hook[*BootstrapEvent]
- func (app *BaseApp) OnBeforeServe() *hook.Hook[*ServeEvent]
- func (app *BaseApp) OnCollectionAfterCreateRequest() *hook.Hook[*CollectionCreateEvent]
- func (app *BaseApp) OnCollectionAfterDeleteRequest() *hook.Hook[*CollectionDeleteEvent]
- func (app *BaseApp) OnCollectionAfterUpdateRequest() *hook.Hook[*CollectionUpdateEvent]
- func (app *BaseApp) OnCollectionBeforeCreateRequest() *hook.Hook[*CollectionCreateEvent]
- func (app *BaseApp) OnCollectionBeforeDeleteRequest() *hook.Hook[*CollectionDeleteEvent]
- func (app *BaseApp) OnCollectionBeforeUpdateRequest() *hook.Hook[*CollectionUpdateEvent]
- func (app *BaseApp) OnCollectionViewRequest() *hook.Hook[*CollectionViewEvent]
- func (app *BaseApp) OnCollectionsAfterImportRequest() *hook.Hook[*CollectionsImportEvent]
- func (app *BaseApp) OnCollectionsBeforeImportRequest() *hook.Hook[*CollectionsImportEvent]
- func (app *BaseApp) OnCollectionsListRequest() *hook.Hook[*CollectionsListEvent]
- func (app *BaseApp) OnFileDownloadRequest(tags ...string) *hook.TaggedHook[*FileDownloadEvent]
- func (app *BaseApp) OnMailerAfterAdminResetPasswordSend() *hook.Hook[*MailerAdminEvent]
- func (app *BaseApp) OnMailerAfterRecordChangeEmailSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
- func (app *BaseApp) OnMailerAfterRecordResetPasswordSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
- func (app *BaseApp) OnMailerAfterRecordVerificationSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
- func (app *BaseApp) OnMailerBeforeAdminResetPasswordSend() *hook.Hook[*MailerAdminEvent]
- func (app *BaseApp) OnMailerBeforeRecordChangeEmailSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
- func (app *BaseApp) OnMailerBeforeRecordResetPasswordSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
- func (app *BaseApp) OnMailerBeforeRecordVerificationSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
- func (app *BaseApp) OnModelAfterCreate(tags ...string) *hook.TaggedHook[*ModelEvent]
- func (app *BaseApp) OnModelAfterDelete(tags ...string) *hook.TaggedHook[*ModelEvent]
- func (app *BaseApp) OnModelAfterUpdate(tags ...string) *hook.TaggedHook[*ModelEvent]
- func (app *BaseApp) OnModelBeforeCreate(tags ...string) *hook.TaggedHook[*ModelEvent]
- func (app *BaseApp) OnModelBeforeDelete(tags ...string) *hook.TaggedHook[*ModelEvent]
- func (app *BaseApp) OnModelBeforeUpdate(tags ...string) *hook.TaggedHook[*ModelEvent]
- func (app *BaseApp) OnRealtimeAfterMessageSend() *hook.Hook[*RealtimeMessageEvent]
- func (app *BaseApp) OnRealtimeAfterSubscribeRequest() *hook.Hook[*RealtimeSubscribeEvent]
- func (app *BaseApp) OnRealtimeBeforeMessageSend() *hook.Hook[*RealtimeMessageEvent]
- func (app *BaseApp) OnRealtimeBeforeSubscribeRequest() *hook.Hook[*RealtimeSubscribeEvent]
- func (app *BaseApp) OnRealtimeConnectRequest() *hook.Hook[*RealtimeConnectEvent]
- func (app *BaseApp) OnRealtimeDisconnectRequest() *hook.Hook[*RealtimeDisconnectEvent]
- func (app *BaseApp) OnRecordAfterAuthRefreshRequest(tags ...string) *hook.TaggedHook[*RecordAuthRefreshEvent]
- func (app *BaseApp) OnRecordAfterAuthWithOAuth2Request(tags ...string) *hook.TaggedHook[*RecordAuthWithOAuth2Event]
- func (app *BaseApp) OnRecordAfterAuthWithPasswordRequest(tags ...string) *hook.TaggedHook[*RecordAuthWithPasswordEvent]
- func (app *BaseApp) OnRecordAfterConfirmEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordConfirmEmailChangeEvent]
- func (app *BaseApp) OnRecordAfterConfirmPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordConfirmPasswordResetEvent]
- func (app *BaseApp) OnRecordAfterConfirmVerificationRequest(tags ...string) *hook.TaggedHook[*RecordConfirmVerificationEvent]
- func (app *BaseApp) OnRecordAfterCreateRequest(tags ...string) *hook.TaggedHook[*RecordCreateEvent]
- func (app *BaseApp) OnRecordAfterDeleteRequest(tags ...string) *hook.TaggedHook[*RecordDeleteEvent]
- func (app *BaseApp) OnRecordAfterRequestEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordRequestEmailChangeEvent]
- func (app *BaseApp) OnRecordAfterRequestPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordRequestPasswordResetEvent]
- func (app *BaseApp) OnRecordAfterRequestVerificationRequest(tags ...string) *hook.TaggedHook[*RecordRequestVerificationEvent]
- func (app *BaseApp) OnRecordAfterUnlinkExternalAuthRequest(tags ...string) *hook.TaggedHook[*RecordUnlinkExternalAuthEvent]
- func (app *BaseApp) OnRecordAfterUpdateRequest(tags ...string) *hook.TaggedHook[*RecordUpdateEvent]
- func (app *BaseApp) OnRecordAuthRequest(tags ...string) *hook.TaggedHook[*RecordAuthEvent]
- func (app *BaseApp) OnRecordBeforeAuthRefreshRequest(tags ...string) *hook.TaggedHook[*RecordAuthRefreshEvent]
- func (app *BaseApp) OnRecordBeforeAuthWithOAuth2Request(tags ...string) *hook.TaggedHook[*RecordAuthWithOAuth2Event]
- func (app *BaseApp) OnRecordBeforeAuthWithPasswordRequest(tags ...string) *hook.TaggedHook[*RecordAuthWithPasswordEvent]
- func (app *BaseApp) OnRecordBeforeConfirmEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordConfirmEmailChangeEvent]
- func (app *BaseApp) OnRecordBeforeConfirmPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordConfirmPasswordResetEvent]
- func (app *BaseApp) OnRecordBeforeConfirmVerificationRequest(tags ...string) *hook.TaggedHook[*RecordConfirmVerificationEvent]
- func (app *BaseApp) OnRecordBeforeCreateRequest(tags ...string) *hook.TaggedHook[*RecordCreateEvent]
- func (app *BaseApp) OnRecordBeforeDeleteRequest(tags ...string) *hook.TaggedHook[*RecordDeleteEvent]
- func (app *BaseApp) OnRecordBeforeRequestEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordRequestEmailChangeEvent]
- func (app *BaseApp) OnRecordBeforeRequestPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordRequestPasswordResetEvent]
- func (app *BaseApp) OnRecordBeforeRequestVerificationRequest(tags ...string) *hook.TaggedHook[*RecordRequestVerificationEvent]
- func (app *BaseApp) OnRecordBeforeUnlinkExternalAuthRequest(tags ...string) *hook.TaggedHook[*RecordUnlinkExternalAuthEvent]
- func (app *BaseApp) OnRecordBeforeUpdateRequest(tags ...string) *hook.TaggedHook[*RecordUpdateEvent]
- func (app *BaseApp) OnRecordListExternalAuthsRequest(tags ...string) *hook.TaggedHook[*RecordListExternalAuthsEvent]
- func (app *BaseApp) OnRecordViewRequest(tags ...string) *hook.TaggedHook[*RecordViewEvent]
- func (app *BaseApp) OnRecordsListRequest(tags ...string) *hook.TaggedHook[*RecordsListEvent]
- func (app *BaseApp) OnSettingsAfterUpdateRequest() *hook.Hook[*SettingsUpdateEvent]
- func (app *BaseApp) OnSettingsBeforeUpdateRequest() *hook.Hook[*SettingsUpdateEvent]
- func (app *BaseApp) OnSettingsListRequest() *hook.Hook[*SettingsListEvent]
- func (app *BaseApp) RefreshSettings() error
- func (app *BaseApp) ResetBootstrapState() error
- func (app *BaseApp) Settings() *settings.Settings
- func (app *BaseApp) SubscriptionsBroker() *subscriptions.Broker
- type BaseAppConfig
- type BaseCollectionEvent
- type BootstrapEvent
- type CollectionCreateEvent
- type CollectionDeleteEvent
- type CollectionUpdateEvent
- type CollectionViewEvent
- type CollectionsImportEvent
- type CollectionsListEvent
- type FileDownloadEvent
- type MailerAdminEvent
- type MailerRecordEvent
- type ModelEvent
- type RealtimeConnectEvent
- type RealtimeDisconnectEvent
- type RealtimeMessageEvent
- type RealtimeSubscribeEvent
- type RecordAuthEvent
- type RecordAuthRefreshEvent
- type RecordAuthWithOAuth2Event
- type RecordAuthWithPasswordEvent
- type RecordConfirmEmailChangeEvent
- type RecordConfirmPasswordResetEvent
- type RecordConfirmVerificationEvent
- type RecordCreateEvent
- type RecordDeleteEvent
- type RecordListExternalAuthsEvent
- type RecordRequestEmailChangeEvent
- type RecordRequestPasswordResetEvent
- type RecordRequestVerificationEvent
- type RecordUnlinkExternalAuthEvent
- type RecordUpdateEvent
- type RecordViewEvent
- type RecordsListEvent
- type ServeEvent
- type SettingsListEvent
- type SettingsUpdateEvent
Constants ¶
const ( DefaultDataMaxOpenConns int = 100 DefaultDataMaxIdleConns int = 20 DefaultLogsMaxOpenConns int = 10 DefaultLogsMaxIdleConns int = 2 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdminAuthEvent ¶
type AdminAuthRefreshEvent ¶ added in v0.12.0
type AdminAuthWithPasswordEvent ¶ added in v0.12.0
type AdminConfirmPasswordResetEvent ¶ added in v0.12.0
type AdminCreateEvent ¶
type AdminDeleteEvent ¶
type AdminRequestPasswordResetEvent ¶ added in v0.12.0
type AdminUpdateEvent ¶
type AdminViewEvent ¶
type AdminsListEvent ¶
type ApiErrorEvent ¶ added in v0.9.0
type ApiErrorEvent struct { HttpContext echo.Context Error error }
type App ¶
type App interface { // Deprecated: // This method may get removed in the near future. // It is recommended to access the app db instance from app.Dao().DB() or // if you want more flexibility - app.Dao().ConcurrentDB() and app.Dao().NonconcurrentDB(). // // DB returns the default app database instance. DB() *dbx.DB // Dao returns the default app Dao instance. // // This Dao could operate only on the tables and models // associated with the default app database. For example, // trying to access the request logs table will result in error. Dao() *daos.Dao // Deprecated: // This method may get removed in the near future. // It is recommended to access the logs db instance from app.LogsDao().DB() or // if you want more flexibility - app.LogsDao().ConcurrentDB() and app.LogsDao().NonconcurrentDB(). // // LogsDB returns the app logs database instance. LogsDB() *dbx.DB // LogsDao returns the app logs Dao instance. // // This Dao could operate only on the tables and models // associated with the logs database. For example, trying to access // the users table from LogsDao will result in error. LogsDao() *daos.Dao // DataDir returns the app data directory path. DataDir() string // EncryptionEnv returns the name of the app secret env key // (used for settings encryption). EncryptionEnv() string // IsDebug returns whether the app is in debug mode // (showing more detailed error logs, executed sql statements, etc.). IsDebug() bool // Settings returns the loaded app settings. Settings() *settings.Settings // Cache returns the app internal cache store. Cache() *store.Store[any] // SubscriptionsBroker returns the app realtime subscriptions broker instance. SubscriptionsBroker() *subscriptions.Broker // NewMailClient creates and returns a configured app mail client. NewMailClient() mailer.Mailer // NewFilesystem creates and returns a configured filesystem.System instance. // // NB! Make sure to call `Close()` on the returned result // after you are done working with it. NewFilesystem() (*filesystem.System, error) // RefreshSettings reinitializes and reloads the stored application settings. RefreshSettings() error // IsBootstrapped checks if the application was initialized // (aka. whether Bootstrap() was called). IsBootstrapped() bool // Bootstrap takes care for initializing the application // (open db connections, load settings, etc.). // // It will call ResetBootstrapState() if the application was already bootstrapped. Bootstrap() error // ResetBootstrapState takes care for releasing initialized app resources // (eg. closing db connections). ResetBootstrapState() error // OnBeforeBootstrap hook is triggered before initializing the base // application resources (eg. before db open and initial settings load). OnBeforeBootstrap() *hook.Hook[*BootstrapEvent] // OnAfterBootstrap hook is triggered after initializing the base // application resources (eg. after db open and initial settings load). OnAfterBootstrap() *hook.Hook[*BootstrapEvent] // OnBeforeServe hook is triggered before serving the internal router (echo), // allowing you to adjust its options and attach new routes. OnBeforeServe() *hook.Hook[*ServeEvent] // OnBeforeApiError hook is triggered right before sending an error API // response to the client, allowing you to further modify the error data // or to return a completely different API response (using [hook.StopPropagation]). OnBeforeApiError() *hook.Hook[*ApiErrorEvent] // OnAfterApiError hook is triggered right after sending an error API // response to the client. // It could be used to log the final API error in external services. OnAfterApiError() *hook.Hook[*ApiErrorEvent] // OnModelBeforeCreate hook is triggered before inserting a new // entry in the DB, allowing you to modify or validate the stored data. // // If the optional "tags" list (table names and/or the Collection id for Record models) // 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. OnModelBeforeCreate(tags ...string) *hook.TaggedHook[*ModelEvent] // OnModelAfterCreate hook is triggered after successfully // inserting a new entry in the DB. // // If the optional "tags" list (table names and/or the Collection id for Record models) // 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. OnModelAfterCreate(tags ...string) *hook.TaggedHook[*ModelEvent] // OnModelBeforeUpdate hook is triggered before updating existing // entry in the DB, allowing you to modify or validate the stored data. // // If the optional "tags" list (table names and/or the Collection id for Record models) // 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. OnModelBeforeUpdate(tags ...string) *hook.TaggedHook[*ModelEvent] // OnModelAfterUpdate hook is triggered after successfully updating // existing entry in the DB. // // If the optional "tags" list (table names and/or the Collection id for Record models) // 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. OnModelAfterUpdate(tags ...string) *hook.TaggedHook[*ModelEvent] // OnModelBeforeDelete hook is triggered before deleting an // existing entry from the DB. // // If the optional "tags" list (table names and/or the Collection id for Record models) // 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. OnModelBeforeDelete(tags ...string) *hook.TaggedHook[*ModelEvent] // OnModelAfterDelete is triggered after successfully deleting an // existing entry from the DB. // // If the optional "tags" list (table names and/or the Collection id for Record models) // 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. OnModelAfterDelete(tags ...string) *hook.TaggedHook[*ModelEvent] // OnMailerBeforeAdminResetPasswordSend hook is triggered right before // sending a password reset email to an admin. // // Could be used to send your own custom email template if // [hook.StopPropagation] is returned in one of its listeners. OnMailerBeforeAdminResetPasswordSend() *hook.Hook[*MailerAdminEvent] // OnMailerAfterAdminResetPasswordSend hook is triggered after // admin password reset email was successfully sent. OnMailerAfterAdminResetPasswordSend() *hook.Hook[*MailerAdminEvent] // OnMailerBeforeRecordResetPasswordSend hook is triggered right before // sending a password reset email to an auth record. // // Could be used to send your own custom email template if // [hook.StopPropagation] is returned in one of its listeners. // // 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. OnMailerBeforeRecordResetPasswordSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent] // OnMailerAfterRecordResetPasswordSend hook is triggered after // an auth record password reset email was successfully 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. OnMailerAfterRecordResetPasswordSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent] // OnMailerBeforeRecordVerificationSend hook is triggered right before // sending a verification email to an auth record. // // Could be used to send your own custom email template if // [hook.StopPropagation] is returned in one of its listeners. // // 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. OnMailerBeforeRecordVerificationSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent] // OnMailerAfterRecordVerificationSend hook is triggered after a // verification email was successfully sent to an auth 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. OnMailerAfterRecordVerificationSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent] // OnMailerBeforeRecordChangeEmailSend hook is triggered right before // sending a confirmation new address email to an auth record. // // Could be used to send your own custom email template if // [hook.StopPropagation] is returned in one of its listeners. // // 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. OnMailerBeforeRecordChangeEmailSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent] // OnMailerAfterRecordChangeEmailSend hook is triggered after a // verification email was successfully sent to an auth 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. OnMailerAfterRecordChangeEmailSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent] // OnRealtimeConnectRequest hook is triggered right before establishing // the SSE client connection. OnRealtimeConnectRequest() *hook.Hook[*RealtimeConnectEvent] // OnRealtimeDisconnectRequest hook is triggered on disconnected/interrupted // SSE client connection. OnRealtimeDisconnectRequest() *hook.Hook[*RealtimeDisconnectEvent] // OnRealtimeBeforeMessage hook is triggered right before sending // an SSE message to a client. // // Returning [hook.StopPropagation] will prevent sending the message. // Returning any other non-nil error will close the realtime connection. OnRealtimeBeforeMessageSend() *hook.Hook[*RealtimeMessageEvent] // OnRealtimeBeforeMessage hook is triggered right after sending // an SSE message to a client. OnRealtimeAfterMessageSend() *hook.Hook[*RealtimeMessageEvent] // OnRealtimeBeforeSubscribeRequest hook is triggered before changing // the client subscriptions, allowing you to further validate and // modify the submitted change. OnRealtimeBeforeSubscribeRequest() *hook.Hook[*RealtimeSubscribeEvent] // OnRealtimeAfterSubscribeRequest hook is triggered after the client // subscriptions were successfully changed. OnRealtimeAfterSubscribeRequest() *hook.Hook[*RealtimeSubscribeEvent] // OnSettingsListRequest hook is triggered on each successful // API Settings list request. // // Could be used to validate or modify the response before // returning it to the client. OnSettingsListRequest() *hook.Hook[*SettingsListEvent] // OnSettingsBeforeUpdateRequest hook is triggered before each API // Settings update request (after request data load and before settings persistence). // // Could be used to additionally validate the request data or // implement completely different persistence behavior // (returning [hook.StopPropagation]). OnSettingsBeforeUpdateRequest() *hook.Hook[*SettingsUpdateEvent] // OnSettingsAfterUpdateRequest hook is triggered after each // successful API Settings update request. OnSettingsAfterUpdateRequest() *hook.Hook[*SettingsUpdateEvent] // 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. OnFileDownloadRequest(tags ...string) *hook.TaggedHook[*FileDownloadEvent] // OnAdminsListRequest hook is triggered on each API Admins list request. // // Could be used to validate or modify the response before returning it to the client. OnAdminsListRequest() *hook.Hook[*AdminsListEvent] // OnAdminViewRequest hook is triggered on each API Admin view request. // // Could be used to validate or modify the response before returning it to the client. OnAdminViewRequest() *hook.Hook[*AdminViewEvent] // OnAdminBeforeCreateRequest hook is triggered before each API // Admin create request (after request data load and before model persistence). // // Could be used to additionally validate the request data or implement // completely different persistence behavior (returning [hook.StopPropagation]). OnAdminBeforeCreateRequest() *hook.Hook[*AdminCreateEvent] // OnAdminAfterCreateRequest hook is triggered after each // successful API Admin create request. OnAdminAfterCreateRequest() *hook.Hook[*AdminCreateEvent] // OnAdminBeforeUpdateRequest hook is triggered before each API // Admin update request (after request data load and before model persistence). // // Could be used to additionally validate the request data or implement // completely different persistence behavior (returning [hook.StopPropagation]). OnAdminBeforeUpdateRequest() *hook.Hook[*AdminUpdateEvent] // OnAdminAfterUpdateRequest hook is triggered after each // successful API Admin update request. OnAdminAfterUpdateRequest() *hook.Hook[*AdminUpdateEvent] // OnAdminBeforeDeleteRequest hook is triggered before each API // Admin delete request (after model load and before actual deletion). // // Could be used to additionally validate the request data or implement // completely different delete behavior (returning [hook.StopPropagation]). OnAdminBeforeDeleteRequest() *hook.Hook[*AdminDeleteEvent] // OnAdminAfterDeleteRequest hook is triggered after each // successful API Admin delete request. OnAdminAfterDeleteRequest() *hook.Hook[*AdminDeleteEvent] // OnAdminAuthRequest hook is triggered on each successful API Admin // authentication request (sign-in, token refresh, etc.). // // Could be used to additionally validate or modify the // authenticated admin data and token. OnAdminAuthRequest() *hook.Hook[*AdminAuthEvent] // OnAdminBeforeAuthWithPasswordRequest hook is triggered before each Admin // auth with password API request (after request data load and before password validation). // // Could be used to implement for example a custom password validation // or to locate a different Admin identity (by assigning [AdminAuthWithPasswordEvent.Admin]). OnAdminBeforeAuthWithPasswordRequest() *hook.Hook[*AdminAuthWithPasswordEvent] // OnAdminAfterAuthWithPasswordRequest hook is triggered after each // successful Admin auth with password API request. OnAdminAfterAuthWithPasswordRequest() *hook.Hook[*AdminAuthWithPasswordEvent] // OnAdminBeforeAuthRefreshRequest hook is triggered before each Admin // 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 (returning [hook.StopPropagation]). OnAdminBeforeAuthRefreshRequest() *hook.Hook[*AdminAuthRefreshEvent] // OnAdminAfterAuthRefreshRequest hook is triggered after each // successful auth refresh API request (right after generating a new auth token). OnAdminAfterAuthRefreshRequest() *hook.Hook[*AdminAuthRefreshEvent] // OnAdminBeforeRequestPasswordResetRequest hook is triggered before each Admin // request password reset API request (after request data load and before sending the reset email). // // Could be used to additionally validate the request data or implement // completely different password reset behavior (returning [hook.StopPropagation]). OnAdminBeforeRequestPasswordResetRequest() *hook.Hook[*AdminRequestPasswordResetEvent] // OnAdminAfterRequestPasswordResetRequest hook is triggered after each // successful request password reset API request. OnAdminAfterRequestPasswordResetRequest() *hook.Hook[*AdminRequestPasswordResetEvent] // OnAdminBeforeConfirmPasswordResetRequest hook is triggered before each Admin // confirm password reset API request (after request data load and before persistence). // // Could be used to additionally validate the request data or implement // completely different persistence behavior (returning [hook.StopPropagation]). OnAdminBeforeConfirmPasswordResetRequest() *hook.Hook[*AdminConfirmPasswordResetEvent] // OnAdminAfterConfirmPasswordResetRequest hook is triggered after each // successful confirm password reset API request. OnAdminAfterConfirmPasswordResetRequest() *hook.Hook[*AdminConfirmPasswordResetEvent] // 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. OnRecordAuthRequest(tags ...string) *hook.TaggedHook[*RecordAuthEvent] // OnRecordBeforeAuthWithPasswordRequest hook is triggered before each Record // auth with password API request (after request data load and before password validation). // // Could be used to implement for example a custom password validation // or to locate a different Record identity (by assigning [RecordAuthWithPasswordEvent.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. OnRecordBeforeAuthWithPasswordRequest(tags ...string) *hook.TaggedHook[*RecordAuthWithPasswordEvent] // OnRecordAfterAuthWithPasswordRequest hook is triggered after each // successful Record auth with password 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. OnRecordAfterAuthWithPasswordRequest(tags ...string) *hook.TaggedHook[*RecordAuthWithPasswordEvent] // OnRecordBeforeAuthWithOAuth2Request hook is triggered before each Record // OAuth2 sign-in/sign-up API request (after token exchange and before external provider linking). // // If the [RecordAuthWithOAuth2Event.Record] is nil, then the OAuth2 // request will try to create a new auth Record. // // To assign or link a different existing record model you can // overwrite/modify the [RecordAuthWithOAuth2Event.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. OnRecordBeforeAuthWithOAuth2Request(tags ...string) *hook.TaggedHook[*RecordAuthWithOAuth2Event] // OnRecordAfterAuthWithOAuth2Request hook is triggered after each // successful Record OAuth2 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. OnRecordAfterAuthWithOAuth2Request(tags ...string) *hook.TaggedHook[*RecordAuthWithOAuth2Event] // OnRecordBeforeAuthRefreshRequest hook is triggered before 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 (returning [hook.StopPropagation]). // // 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. OnRecordBeforeAuthRefreshRequest(tags ...string) *hook.TaggedHook[*RecordAuthRefreshEvent] // OnRecordAfterAuthRefreshRequest hook is triggered after each // successful auth refresh API request (right after generating a new auth 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. OnRecordAfterAuthRefreshRequest(tags ...string) *hook.TaggedHook[*RecordAuthRefreshEvent] // OnRecordBeforeRequestPasswordResetRequest hook is triggered before each Record // request password reset API request (after request data load and before sending the reset email). // // Could be used to additionally validate the request data or implement // completely different password reset behavior (returning [hook.StopPropagation]). // // 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. OnRecordBeforeRequestPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordRequestPasswordResetEvent] // OnRecordAfterRequestPasswordResetRequest hook is triggered after each // successful request password reset 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. OnRecordAfterRequestPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordRequestPasswordResetEvent] // OnRecordBeforeConfirmPasswordResetRequest hook is triggered before each Record // confirm password reset API request (after request data load and before persistence). // // Could be used to additionally validate the request data or implement // completely different persistence behavior (returning [hook.StopPropagation]). // // 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. OnRecordBeforeConfirmPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordConfirmPasswordResetEvent] // OnRecordAfterConfirmPasswordResetRequest hook is triggered after each // successful confirm password reset 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. OnRecordAfterConfirmPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordConfirmPasswordResetEvent] // OnRecordBeforeRequestVerificationRequest hook is triggered before each Record // request verification API request (after request data load and before sending the verification email). // // Could be used to additionally validate the loaded request data or implement // completely different verification behavior (returning [hook.StopPropagation]). // // 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. OnRecordBeforeRequestVerificationRequest(tags ...string) *hook.TaggedHook[*RecordRequestVerificationEvent] // OnRecordAfterRequestVerificationRequest hook is triggered after each // successful request verification 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. OnRecordAfterRequestVerificationRequest(tags ...string) *hook.TaggedHook[*RecordRequestVerificationEvent] // OnRecordBeforeConfirmVerificationRequest hook is triggered before each Record // confirm verification API request (after request data load and before persistence). // // Could be used to additionally validate the request data or implement // completely different persistence behavior (returning [hook.StopPropagation]). // // 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. OnRecordBeforeConfirmVerificationRequest(tags ...string) *hook.TaggedHook[*RecordConfirmVerificationEvent] // OnRecordAfterConfirmVerificationRequest hook is triggered after each // successful confirm verification 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. OnRecordAfterConfirmVerificationRequest(tags ...string) *hook.TaggedHook[*RecordConfirmVerificationEvent] // OnRecordBeforeRequestEmailChangeRequest hook is triggered before each Record request email change API request // (after request data load and before sending the email link to confirm the change). // // Could be used to additionally validate the request data or implement // completely different request email change behavior (returning [hook.StopPropagation]). // // 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. OnRecordBeforeRequestEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordRequestEmailChangeEvent] // OnRecordAfterRequestEmailChangeRequest hook is triggered after each // successful request email change 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. OnRecordAfterRequestEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordRequestEmailChangeEvent] // OnRecordBeforeConfirmEmailChangeRequest hook is triggered before each Record // confirm email change API request (after request data load and before persistence). // // Could be used to additionally validate the request data or implement // completely different persistence behavior (returning [hook.StopPropagation]). // // 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. OnRecordBeforeConfirmEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordConfirmEmailChangeEvent] // OnRecordAfterConfirmEmailChangeRequest hook is triggered after each // successful confirm email change 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. OnRecordAfterConfirmEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordConfirmEmailChangeEvent] // OnRecordListExternalAuthsRequest hook is triggered on each API record external auths 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. OnRecordListExternalAuthsRequest(tags ...string) *hook.TaggedHook[*RecordListExternalAuthsEvent] // OnRecordBeforeUnlinkExternalAuthRequest hook is triggered before each API record // external auth unlink request (after models load and before the actual relation deletion). // // Could be used to additionally validate the request data or implement // completely different delete behavior (returning [hook.StopPropagation]). // // 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. OnRecordBeforeUnlinkExternalAuthRequest(tags ...string) *hook.TaggedHook[*RecordUnlinkExternalAuthEvent] // OnRecordAfterUnlinkExternalAuthRequest hook is triggered after each // successful API record external auth unlink 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. OnRecordAfterUnlinkExternalAuthRequest(tags ...string) *hook.TaggedHook[*RecordUnlinkExternalAuthEvent] // 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. OnRecordsListRequest(tags ...string) *hook.TaggedHook[*RecordsListEvent] // 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. OnRecordViewRequest(tags ...string) *hook.TaggedHook[*RecordViewEvent] // OnRecordBeforeCreateRequest hook is triggered before each API Record // create request (after request data load and before model persistence). // // Could be used to additionally validate the request data or implement // completely different persistence behavior (returning [hook.StopPropagation]). // // 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. OnRecordBeforeCreateRequest(tags ...string) *hook.TaggedHook[*RecordCreateEvent] // OnRecordAfterCreateRequest hook is triggered after each // successful API Record create 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. OnRecordAfterCreateRequest(tags ...string) *hook.TaggedHook[*RecordCreateEvent] // OnRecordBeforeUpdateRequest hook is triggered before each API Record // update request (after request data load and before model persistence). // // Could be used to additionally validate the request data or implement // completely different persistence behavior (returning [hook.StopPropagation]). // // 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. OnRecordBeforeUpdateRequest(tags ...string) *hook.TaggedHook[*RecordUpdateEvent] // OnRecordAfterUpdateRequest hook is triggered after each // successful API Record update 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. OnRecordAfterUpdateRequest(tags ...string) *hook.TaggedHook[*RecordUpdateEvent] // OnRecordBeforeDeleteRequest hook is triggered before each API Record // delete request (after model load and before actual deletion). // // Could be used to additionally validate the request data or implement // completely different delete behavior (returning [hook.StopPropagation]). // // 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. OnRecordBeforeDeleteRequest(tags ...string) *hook.TaggedHook[*RecordDeleteEvent] // OnRecordAfterDeleteRequest hook is triggered after each // successful API Record delete 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. OnRecordAfterDeleteRequest(tags ...string) *hook.TaggedHook[*RecordDeleteEvent] // 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. OnCollectionsListRequest() *hook.Hook[*CollectionsListEvent] // 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. OnCollectionViewRequest() *hook.Hook[*CollectionViewEvent] // OnCollectionBeforeCreateRequest hook is triggered before each API Collection // create request (after request data load and before model persistence). // // Could be used to additionally validate the request data or implement // completely different persistence behavior (returning [hook.StopPropagation]). OnCollectionBeforeCreateRequest() *hook.Hook[*CollectionCreateEvent] // OnCollectionAfterCreateRequest hook is triggered after each // successful API Collection create request. OnCollectionAfterCreateRequest() *hook.Hook[*CollectionCreateEvent] // OnCollectionBeforeUpdateRequest hook is triggered before each API Collection // update request (after request data load and before model persistence). // // Could be used to additionally validate the request data or implement // completely different persistence behavior (returning [hook.StopPropagation]). OnCollectionBeforeUpdateRequest() *hook.Hook[*CollectionUpdateEvent] // OnCollectionAfterUpdateRequest hook is triggered after each // successful API Collection update request. OnCollectionAfterUpdateRequest() *hook.Hook[*CollectionUpdateEvent] // OnCollectionBeforeDeleteRequest hook is triggered before each API // Collection delete request (after model load and before actual deletion). // // Could be used to additionally validate the request data or implement // completely different delete behavior (returning [hook.StopPropagation]). OnCollectionBeforeDeleteRequest() *hook.Hook[*CollectionDeleteEvent] // OnCollectionAfterDeleteRequest hook is triggered after each // successful API Collection delete request. OnCollectionAfterDeleteRequest() *hook.Hook[*CollectionDeleteEvent] // OnCollectionsBeforeImportRequest hook is triggered before each API // collections import request (after request data load and before the actual import). // // Could be used to additionally validate the imported collections or // to implement completely different import behavior (returning [hook.StopPropagation]). OnCollectionsBeforeImportRequest() *hook.Hook[*CollectionsImportEvent] // OnCollectionsAfterImportRequest hook is triggered after each // successful API collections import request. OnCollectionsAfterImportRequest() *hook.Hook[*CollectionsImportEvent] }
App defines the main PocketBase app interface.
type BaseApp ¶
type BaseApp struct {
// contains filtered or unexported fields
}
BaseApp implements core.App and defines the base PocketBase app structure.
func NewBaseApp ¶
func NewBaseApp(config *BaseAppConfig) *BaseApp
NewBaseApp creates and returns a new BaseApp instance configured with the provided arguments.
To initialize the app, you need to call `app.Bootstrap()`.
func (*BaseApp) Bootstrap ¶
Bootstrap initializes the application (aka. create data dir, open db connections, load settings, etc.).
It will call ResetBootstrapState() if the application was already bootstrapped.
func (*BaseApp) DB
deprecated
func (*BaseApp) EncryptionEnv ¶
EncryptionEnv returns the name of the app secret env key (used for settings encryption).
func (*BaseApp) IsBootstrapped ¶ added in v0.10.0
IsBootstrapped checks if the application was initialized (aka. whether Bootstrap() was called).
func (*BaseApp) IsDebug ¶
IsDebug returns whether the app is in debug mode (showing more detailed error logs, executed sql statements, etc.).
func (*BaseApp) LogsDB
deprecated
Deprecated: This method may get removed in the near future. It is recommended to access the logs db instance from app.LogsDao().DB() or if you want more flexibility - app.LogsDao().ConcurrentDB() and app.LogsDao().NonconcurrentDB().
LogsDB returns the app logs database instance.
func (*BaseApp) NewFilesystem ¶
func (app *BaseApp) NewFilesystem() (*filesystem.System, error)
NewFilesystem creates a new local or S3 filesystem instance based on the current app settings.
NB! Make sure to call `Close()` on the returned result after you are done working with it.
func (*BaseApp) NewMailClient ¶
NewMailClient creates and returns a new SMTP or Sendmail client based on the current app settings.
func (*BaseApp) OnAdminAfterAuthRefreshRequest ¶ added in v0.12.0
func (app *BaseApp) OnAdminAfterAuthRefreshRequest() *hook.Hook[*AdminAuthRefreshEvent]
func (*BaseApp) OnAdminAfterAuthWithPasswordRequest ¶ added in v0.12.0
func (app *BaseApp) OnAdminAfterAuthWithPasswordRequest() *hook.Hook[*AdminAuthWithPasswordEvent]
func (*BaseApp) OnAdminAfterConfirmPasswordResetRequest ¶ added in v0.12.0
func (app *BaseApp) OnAdminAfterConfirmPasswordResetRequest() *hook.Hook[*AdminConfirmPasswordResetEvent]
func (*BaseApp) OnAdminAfterCreateRequest ¶
func (app *BaseApp) OnAdminAfterCreateRequest() *hook.Hook[*AdminCreateEvent]
func (*BaseApp) OnAdminAfterDeleteRequest ¶
func (app *BaseApp) OnAdminAfterDeleteRequest() *hook.Hook[*AdminDeleteEvent]
func (*BaseApp) OnAdminAfterRequestPasswordResetRequest ¶ added in v0.12.0
func (app *BaseApp) OnAdminAfterRequestPasswordResetRequest() *hook.Hook[*AdminRequestPasswordResetEvent]
func (*BaseApp) OnAdminAfterUpdateRequest ¶
func (app *BaseApp) OnAdminAfterUpdateRequest() *hook.Hook[*AdminUpdateEvent]
func (*BaseApp) OnAdminAuthRequest ¶
func (app *BaseApp) OnAdminAuthRequest() *hook.Hook[*AdminAuthEvent]
func (*BaseApp) OnAdminBeforeAuthRefreshRequest ¶ added in v0.12.0
func (app *BaseApp) OnAdminBeforeAuthRefreshRequest() *hook.Hook[*AdminAuthRefreshEvent]
func (*BaseApp) OnAdminBeforeAuthWithPasswordRequest ¶ added in v0.12.0
func (app *BaseApp) OnAdminBeforeAuthWithPasswordRequest() *hook.Hook[*AdminAuthWithPasswordEvent]
func (*BaseApp) OnAdminBeforeConfirmPasswordResetRequest ¶ added in v0.12.0
func (app *BaseApp) OnAdminBeforeConfirmPasswordResetRequest() *hook.Hook[*AdminConfirmPasswordResetEvent]
func (*BaseApp) OnAdminBeforeCreateRequest ¶
func (app *BaseApp) OnAdminBeforeCreateRequest() *hook.Hook[*AdminCreateEvent]
func (*BaseApp) OnAdminBeforeDeleteRequest ¶
func (app *BaseApp) OnAdminBeforeDeleteRequest() *hook.Hook[*AdminDeleteEvent]
func (*BaseApp) OnAdminBeforeRequestPasswordResetRequest ¶ added in v0.12.0
func (app *BaseApp) OnAdminBeforeRequestPasswordResetRequest() *hook.Hook[*AdminRequestPasswordResetEvent]
func (*BaseApp) OnAdminBeforeUpdateRequest ¶
func (app *BaseApp) OnAdminBeforeUpdateRequest() *hook.Hook[*AdminUpdateEvent]
func (*BaseApp) OnAdminViewRequest ¶
func (app *BaseApp) OnAdminViewRequest() *hook.Hook[*AdminViewEvent]
func (*BaseApp) OnAdminsListRequest ¶
func (app *BaseApp) OnAdminsListRequest() *hook.Hook[*AdminsListEvent]
func (*BaseApp) OnAfterApiError ¶ added in v0.9.0
func (app *BaseApp) OnAfterApiError() *hook.Hook[*ApiErrorEvent]
func (*BaseApp) OnAfterBootstrap ¶ added in v0.9.0
func (app *BaseApp) OnAfterBootstrap() *hook.Hook[*BootstrapEvent]
func (*BaseApp) OnBeforeApiError ¶ added in v0.9.0
func (app *BaseApp) OnBeforeApiError() *hook.Hook[*ApiErrorEvent]
func (*BaseApp) OnBeforeBootstrap ¶ added in v0.9.0
func (app *BaseApp) OnBeforeBootstrap() *hook.Hook[*BootstrapEvent]
func (*BaseApp) OnBeforeServe ¶
func (app *BaseApp) OnBeforeServe() *hook.Hook[*ServeEvent]
func (*BaseApp) OnCollectionAfterCreateRequest ¶
func (app *BaseApp) OnCollectionAfterCreateRequest() *hook.Hook[*CollectionCreateEvent]
func (*BaseApp) OnCollectionAfterDeleteRequest ¶
func (app *BaseApp) OnCollectionAfterDeleteRequest() *hook.Hook[*CollectionDeleteEvent]
func (*BaseApp) OnCollectionAfterUpdateRequest ¶
func (app *BaseApp) OnCollectionAfterUpdateRequest() *hook.Hook[*CollectionUpdateEvent]
func (*BaseApp) OnCollectionBeforeCreateRequest ¶
func (app *BaseApp) OnCollectionBeforeCreateRequest() *hook.Hook[*CollectionCreateEvent]
func (*BaseApp) OnCollectionBeforeDeleteRequest ¶
func (app *BaseApp) OnCollectionBeforeDeleteRequest() *hook.Hook[*CollectionDeleteEvent]
func (*BaseApp) OnCollectionBeforeUpdateRequest ¶
func (app *BaseApp) OnCollectionBeforeUpdateRequest() *hook.Hook[*CollectionUpdateEvent]
func (*BaseApp) OnCollectionViewRequest ¶
func (app *BaseApp) OnCollectionViewRequest() *hook.Hook[*CollectionViewEvent]
func (*BaseApp) OnCollectionsAfterImportRequest ¶ added in v0.4.0
func (app *BaseApp) OnCollectionsAfterImportRequest() *hook.Hook[*CollectionsImportEvent]
func (*BaseApp) OnCollectionsBeforeImportRequest ¶ added in v0.4.0
func (app *BaseApp) OnCollectionsBeforeImportRequest() *hook.Hook[*CollectionsImportEvent]
func (*BaseApp) OnCollectionsListRequest ¶
func (app *BaseApp) OnCollectionsListRequest() *hook.Hook[*CollectionsListEvent]
func (*BaseApp) OnFileDownloadRequest ¶
func (app *BaseApp) OnFileDownloadRequest(tags ...string) *hook.TaggedHook[*FileDownloadEvent]
func (*BaseApp) OnMailerAfterAdminResetPasswordSend ¶
func (app *BaseApp) OnMailerAfterAdminResetPasswordSend() *hook.Hook[*MailerAdminEvent]
func (*BaseApp) OnMailerAfterRecordChangeEmailSend ¶ added in v0.8.0
func (app *BaseApp) OnMailerAfterRecordChangeEmailSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
func (*BaseApp) OnMailerAfterRecordResetPasswordSend ¶ added in v0.8.0
func (app *BaseApp) OnMailerAfterRecordResetPasswordSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
func (*BaseApp) OnMailerAfterRecordVerificationSend ¶ added in v0.8.0
func (app *BaseApp) OnMailerAfterRecordVerificationSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
func (*BaseApp) OnMailerBeforeAdminResetPasswordSend ¶
func (app *BaseApp) OnMailerBeforeAdminResetPasswordSend() *hook.Hook[*MailerAdminEvent]
func (*BaseApp) OnMailerBeforeRecordChangeEmailSend ¶ added in v0.8.0
func (app *BaseApp) OnMailerBeforeRecordChangeEmailSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
func (*BaseApp) OnMailerBeforeRecordResetPasswordSend ¶ added in v0.8.0
func (app *BaseApp) OnMailerBeforeRecordResetPasswordSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
func (*BaseApp) OnMailerBeforeRecordVerificationSend ¶ added in v0.8.0
func (app *BaseApp) OnMailerBeforeRecordVerificationSend(tags ...string) *hook.TaggedHook[*MailerRecordEvent]
func (*BaseApp) OnModelAfterCreate ¶
func (app *BaseApp) OnModelAfterCreate(tags ...string) *hook.TaggedHook[*ModelEvent]
func (*BaseApp) OnModelAfterDelete ¶
func (app *BaseApp) OnModelAfterDelete(tags ...string) *hook.TaggedHook[*ModelEvent]
func (*BaseApp) OnModelAfterUpdate ¶
func (app *BaseApp) OnModelAfterUpdate(tags ...string) *hook.TaggedHook[*ModelEvent]
func (*BaseApp) OnModelBeforeCreate ¶
func (app *BaseApp) OnModelBeforeCreate(tags ...string) *hook.TaggedHook[*ModelEvent]
func (*BaseApp) OnModelBeforeDelete ¶
func (app *BaseApp) OnModelBeforeDelete(tags ...string) *hook.TaggedHook[*ModelEvent]
func (*BaseApp) OnModelBeforeUpdate ¶
func (app *BaseApp) OnModelBeforeUpdate(tags ...string) *hook.TaggedHook[*ModelEvent]
func (*BaseApp) OnRealtimeAfterMessageSend ¶ added in v0.9.0
func (app *BaseApp) OnRealtimeAfterMessageSend() *hook.Hook[*RealtimeMessageEvent]
func (*BaseApp) OnRealtimeAfterSubscribeRequest ¶
func (app *BaseApp) OnRealtimeAfterSubscribeRequest() *hook.Hook[*RealtimeSubscribeEvent]
func (*BaseApp) OnRealtimeBeforeMessageSend ¶ added in v0.9.0
func (app *BaseApp) OnRealtimeBeforeMessageSend() *hook.Hook[*RealtimeMessageEvent]
func (*BaseApp) OnRealtimeBeforeSubscribeRequest ¶
func (app *BaseApp) OnRealtimeBeforeSubscribeRequest() *hook.Hook[*RealtimeSubscribeEvent]
func (*BaseApp) OnRealtimeConnectRequest ¶
func (app *BaseApp) OnRealtimeConnectRequest() *hook.Hook[*RealtimeConnectEvent]
func (*BaseApp) OnRealtimeDisconnectRequest ¶ added in v0.9.0
func (app *BaseApp) OnRealtimeDisconnectRequest() *hook.Hook[*RealtimeDisconnectEvent]
func (*BaseApp) OnRecordAfterAuthRefreshRequest ¶ added in v0.12.0
func (app *BaseApp) OnRecordAfterAuthRefreshRequest(tags ...string) *hook.TaggedHook[*RecordAuthRefreshEvent]
func (*BaseApp) OnRecordAfterAuthWithOAuth2Request ¶ added in v0.12.0
func (app *BaseApp) OnRecordAfterAuthWithOAuth2Request(tags ...string) *hook.TaggedHook[*RecordAuthWithOAuth2Event]
func (*BaseApp) OnRecordAfterAuthWithPasswordRequest ¶ added in v0.12.0
func (app *BaseApp) OnRecordAfterAuthWithPasswordRequest(tags ...string) *hook.TaggedHook[*RecordAuthWithPasswordEvent]
func (*BaseApp) OnRecordAfterConfirmEmailChangeRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordAfterConfirmEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordConfirmEmailChangeEvent]
func (*BaseApp) OnRecordAfterConfirmPasswordResetRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordAfterConfirmPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordConfirmPasswordResetEvent]
func (*BaseApp) OnRecordAfterConfirmVerificationRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordAfterConfirmVerificationRequest(tags ...string) *hook.TaggedHook[*RecordConfirmVerificationEvent]
func (*BaseApp) OnRecordAfterCreateRequest ¶
func (app *BaseApp) OnRecordAfterCreateRequest(tags ...string) *hook.TaggedHook[*RecordCreateEvent]
func (*BaseApp) OnRecordAfterDeleteRequest ¶
func (app *BaseApp) OnRecordAfterDeleteRequest(tags ...string) *hook.TaggedHook[*RecordDeleteEvent]
func (*BaseApp) OnRecordAfterRequestEmailChangeRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordAfterRequestEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordRequestEmailChangeEvent]
func (*BaseApp) OnRecordAfterRequestPasswordResetRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordAfterRequestPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordRequestPasswordResetEvent]
func (*BaseApp) OnRecordAfterRequestVerificationRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordAfterRequestVerificationRequest(tags ...string) *hook.TaggedHook[*RecordRequestVerificationEvent]
func (*BaseApp) OnRecordAfterUnlinkExternalAuthRequest ¶ added in v0.8.0
func (app *BaseApp) OnRecordAfterUnlinkExternalAuthRequest(tags ...string) *hook.TaggedHook[*RecordUnlinkExternalAuthEvent]
func (*BaseApp) OnRecordAfterUpdateRequest ¶
func (app *BaseApp) OnRecordAfterUpdateRequest(tags ...string) *hook.TaggedHook[*RecordUpdateEvent]
func (*BaseApp) OnRecordAuthRequest ¶ added in v0.8.0
func (app *BaseApp) OnRecordAuthRequest(tags ...string) *hook.TaggedHook[*RecordAuthEvent]
func (*BaseApp) OnRecordBeforeAuthRefreshRequest ¶ added in v0.12.0
func (app *BaseApp) OnRecordBeforeAuthRefreshRequest(tags ...string) *hook.TaggedHook[*RecordAuthRefreshEvent]
func (*BaseApp) OnRecordBeforeAuthWithOAuth2Request ¶ added in v0.12.0
func (app *BaseApp) OnRecordBeforeAuthWithOAuth2Request(tags ...string) *hook.TaggedHook[*RecordAuthWithOAuth2Event]
func (*BaseApp) OnRecordBeforeAuthWithPasswordRequest ¶ added in v0.12.0
func (app *BaseApp) OnRecordBeforeAuthWithPasswordRequest(tags ...string) *hook.TaggedHook[*RecordAuthWithPasswordEvent]
func (*BaseApp) OnRecordBeforeConfirmEmailChangeRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordBeforeConfirmEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordConfirmEmailChangeEvent]
func (*BaseApp) OnRecordBeforeConfirmPasswordResetRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordBeforeConfirmPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordConfirmPasswordResetEvent]
func (*BaseApp) OnRecordBeforeConfirmVerificationRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordBeforeConfirmVerificationRequest(tags ...string) *hook.TaggedHook[*RecordConfirmVerificationEvent]
func (*BaseApp) OnRecordBeforeCreateRequest ¶
func (app *BaseApp) OnRecordBeforeCreateRequest(tags ...string) *hook.TaggedHook[*RecordCreateEvent]
func (*BaseApp) OnRecordBeforeDeleteRequest ¶
func (app *BaseApp) OnRecordBeforeDeleteRequest(tags ...string) *hook.TaggedHook[*RecordDeleteEvent]
func (*BaseApp) OnRecordBeforeRequestEmailChangeRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordBeforeRequestEmailChangeRequest(tags ...string) *hook.TaggedHook[*RecordRequestEmailChangeEvent]
func (*BaseApp) OnRecordBeforeRequestPasswordResetRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordBeforeRequestPasswordResetRequest(tags ...string) *hook.TaggedHook[*RecordRequestPasswordResetEvent]
func (*BaseApp) OnRecordBeforeRequestVerificationRequest ¶ added in v0.9.0
func (app *BaseApp) OnRecordBeforeRequestVerificationRequest(tags ...string) *hook.TaggedHook[*RecordRequestVerificationEvent]
func (*BaseApp) OnRecordBeforeUnlinkExternalAuthRequest ¶ added in v0.8.0
func (app *BaseApp) OnRecordBeforeUnlinkExternalAuthRequest(tags ...string) *hook.TaggedHook[*RecordUnlinkExternalAuthEvent]
func (*BaseApp) OnRecordBeforeUpdateRequest ¶
func (app *BaseApp) OnRecordBeforeUpdateRequest(tags ...string) *hook.TaggedHook[*RecordUpdateEvent]
func (*BaseApp) OnRecordListExternalAuthsRequest ¶ added in v0.8.0
func (app *BaseApp) OnRecordListExternalAuthsRequest(tags ...string) *hook.TaggedHook[*RecordListExternalAuthsEvent]
func (*BaseApp) OnRecordViewRequest ¶
func (app *BaseApp) OnRecordViewRequest(tags ...string) *hook.TaggedHook[*RecordViewEvent]
func (*BaseApp) OnRecordsListRequest ¶
func (app *BaseApp) OnRecordsListRequest(tags ...string) *hook.TaggedHook[*RecordsListEvent]
func (*BaseApp) OnSettingsAfterUpdateRequest ¶
func (app *BaseApp) OnSettingsAfterUpdateRequest() *hook.Hook[*SettingsUpdateEvent]
func (*BaseApp) OnSettingsBeforeUpdateRequest ¶
func (app *BaseApp) OnSettingsBeforeUpdateRequest() *hook.Hook[*SettingsUpdateEvent]
func (*BaseApp) OnSettingsListRequest ¶
func (app *BaseApp) OnSettingsListRequest() *hook.Hook[*SettingsListEvent]
func (*BaseApp) RefreshSettings ¶
RefreshSettings reinitializes and reloads the stored application settings.
func (*BaseApp) ResetBootstrapState ¶
ResetBootstrapState takes care for releasing initialized app resources (eg. closing db connections).
func (*BaseApp) SubscriptionsBroker ¶
func (app *BaseApp) SubscriptionsBroker() *subscriptions.Broker
SubscriptionsBroker returns the app realtime subscriptions broker instance.
type BaseAppConfig ¶ added in v0.10.0
type BaseAppConfig struct { DataDir string EncryptionEnv string IsDebug bool DataMaxOpenConns int // default to 500 DataMaxIdleConns int // default 20 LogsMaxOpenConns int // default to 100 LogsMaxIdleConns int // default to 5 }
BaseAppConfig defines a BaseApp configuration option
type BaseCollectionEvent ¶ added in v0.12.0
type BaseCollectionEvent struct {
Collection *models.Collection
}
func (*BaseCollectionEvent) Tags ¶ added in v0.12.0
func (e *BaseCollectionEvent) Tags() []string
type BootstrapEvent ¶ added in v0.9.0
type BootstrapEvent struct {
App App
}
type CollectionCreateEvent ¶
type CollectionCreateEvent struct { BaseCollectionEvent HttpContext echo.Context }
type CollectionDeleteEvent ¶
type CollectionDeleteEvent struct { BaseCollectionEvent HttpContext echo.Context }
type CollectionUpdateEvent ¶
type CollectionUpdateEvent struct { BaseCollectionEvent HttpContext echo.Context }
type CollectionViewEvent ¶
type CollectionViewEvent struct { BaseCollectionEvent HttpContext echo.Context }
type CollectionsImportEvent ¶ added in v0.4.0
type CollectionsImportEvent struct { HttpContext echo.Context Collections []*models.Collection }
type CollectionsListEvent ¶
type CollectionsListEvent struct { HttpContext echo.Context Collections []*models.Collection Result *search.Result }
type FileDownloadEvent ¶
type FileDownloadEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record FileField *schema.SchemaField ServedPath string ServedName string }
type MailerAdminEvent ¶
type MailerRecordEvent ¶ added in v0.8.0
type ModelEvent ¶
func (*ModelEvent) Tags ¶ added in v0.12.0
func (e *ModelEvent) Tags() []string
type RealtimeConnectEvent ¶
type RealtimeConnectEvent struct { HttpContext echo.Context Client subscriptions.Client }
type RealtimeDisconnectEvent ¶ added in v0.9.0
type RealtimeDisconnectEvent struct { HttpContext echo.Context Client subscriptions.Client }
type RealtimeMessageEvent ¶ added in v0.9.0
type RealtimeMessageEvent struct { HttpContext echo.Context Client subscriptions.Client Message *subscriptions.Message }
type RealtimeSubscribeEvent ¶
type RealtimeSubscribeEvent struct { HttpContext echo.Context Client subscriptions.Client Subscriptions []string }
type RecordAuthEvent ¶ added in v0.8.0
type RecordAuthEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record Token string Meta any }
type RecordAuthRefreshEvent ¶ added in v0.12.0
type RecordAuthRefreshEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record }
type RecordAuthWithOAuth2Event ¶ added in v0.12.0
type RecordAuthWithOAuth2Event struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record OAuth2User *auth.AuthUser }
type RecordAuthWithPasswordEvent ¶ added in v0.12.0
type RecordAuthWithPasswordEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record Identity string Password string }
type RecordConfirmEmailChangeEvent ¶ added in v0.9.0
type RecordConfirmEmailChangeEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record }
type RecordConfirmPasswordResetEvent ¶ added in v0.9.0
type RecordConfirmPasswordResetEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record }
type RecordConfirmVerificationEvent ¶ added in v0.9.0
type RecordConfirmVerificationEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record }
type RecordCreateEvent ¶
type RecordCreateEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record }
type RecordDeleteEvent ¶
type RecordDeleteEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record }
type RecordListExternalAuthsEvent ¶ added in v0.8.0
type RecordListExternalAuthsEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record ExternalAuths []*models.ExternalAuth }
type RecordRequestEmailChangeEvent ¶ added in v0.9.0
type RecordRequestEmailChangeEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record }
type RecordRequestPasswordResetEvent ¶ added in v0.9.0
type RecordRequestPasswordResetEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record }
type RecordRequestVerificationEvent ¶ added in v0.9.0
type RecordRequestVerificationEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record }
type RecordUnlinkExternalAuthEvent ¶ added in v0.8.0
type RecordUnlinkExternalAuthEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record ExternalAuth *models.ExternalAuth }
type RecordUpdateEvent ¶
type RecordUpdateEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record }
type RecordViewEvent ¶
type RecordViewEvent struct { BaseCollectionEvent HttpContext echo.Context Record *models.Record }
type RecordsListEvent ¶
type RecordsListEvent struct { BaseCollectionEvent HttpContext echo.Context Records []*models.Record Result *search.Result }
type ServeEvent ¶
type ServeEvent struct { App App Router *echo.Echo }