Migrations Reference


                    
                    
                    CreateAdminUsers

A Migration that creates the admin user upon startup. The password and recovery key are read from environment variables ADMIN_PASSWORD and RECOVERY_KEY if present, otherwise defaults are used.

The defaults are intended and fine for development and testing, but should never be used in production. If not set to proper values in docker-compose.yml (or whatever other environment of your choice), reminders are printed to console during startup.

Declaration

Swift

struct CreateAdminUsers : AsyncMigration

Show on GitHub


                    
                    
                    CreateAlertWordPivotSchema

Declaration

Swift

struct CreateAlertWordPivotSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateAlertWordSchema

Declaration

Swift

struct CreateAlertWordSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateAnnouncementSchema

Declaration

Swift

struct CreateAnnouncementSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateBoardgameFavoriteSchema

Declaration

Swift

struct CreateBoardgameFavoriteSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateBoardgameSchema

Declaration

Swift

struct CreateBoardgameSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateCategories

A Migration that creates an initial set of categories for Forums.

Declaration

Swift

struct CreateCategories : AsyncMigration

Show on GitHub


                    
                    
                    CreateCategorySchema

Declaration

Swift

struct CreateCategorySchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateClientUsers

A Migration that creates a set of registered client users during startup, from a registered-clients.txt file located in the seeds/ subdirectory of the project. The file must be of the format:

clientUsername1:password1:recoveryKey1 clientUsername2:password2:recoveryKey2 …

Note

Each API client that wishes to make use of ClientController endpoints must provide a client username:password:recovery key triplet prior to production startup.

Declaration

Swift

struct CreateClientUsers : AsyncMigration

Show on GitHub


                    
                    
                    CreateCustomEnums

Declaration

Swift

struct CreateCustomEnums : AsyncMigration

Show on GitHub


                    
                    
                    CreateDailyThemeSchema

Declaration

Swift

struct CreateDailyThemeSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateEventFavoriteSchema

Declaration

Swift

struct CreateEventFavoriteSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateEventSchema

Declaration

Swift

struct CreateEventSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateFezParticipantSchema

Declaration

Swift

struct CreateFezParticipantSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateFezPostSchema

Declaration

Swift

struct CreateFezPostSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateForumEditSchema

Declaration

Swift

struct CreateForumEditSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateForumPostEditSchema

Declaration

Swift

struct CreateForumPostEditSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateForumPostSchema

Declaration

Swift

struct CreateForumPostSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateForumReadersSchema

Declaration

Swift

struct CreateForumReadersSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateForums

A Migration that creates an initial set of Twit-arr official Forums.

Declaration

Swift

struct CreateForums : AsyncMigration

Show on GitHub


                    
                    
                    CreateForumSchema

Declaration

Swift

struct CreateForumSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateFriendlyFezEditSchema

Declaration

Swift

struct CreateFriendlyFezEditSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateFriendlyFezSchema

Declaration

Swift

struct CreateFriendlyFezSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateKaraokeFavoriteSchema

Declaration

Swift

struct CreateKaraokeFavoriteSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateKaraokePlayedSongSchema

Declaration

Swift

struct CreateKaraokePlayedSongSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateKaraokeSongSchema

Declaration

Swift

struct CreateKaraokeSongSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateModeratorActionSchema

Declaration

Swift

struct CreateModeratorActionSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateMuteWordSchema

Declaration

Swift

struct CreateMuteWordSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreatePostLikesSchema

Declaration

Swift

struct CreatePostLikesSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateProfileEditSchema

Declaration

Swift

struct CreateProfileEditSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateRegistrationCodeSchema

Declaration

Swift

struct CreateRegistrationCodeSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateReportSchema

Declaration

Swift

struct CreateReportSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateTestData

A Migration that seeds the db with test data. Once we have clients that can post data, we can get rid of this file.

Declaration

Swift

struct CreateTestData : AsyncMigration

Show on GitHub


                    
                    
                    CreateTestUsers

A Migration that creates a set of test users during startup, so that there exists one at each .accessLevel. This migration should only be run in non-production environments.

Declaration

Swift

struct CreateTestUsers : AsyncMigration

Show on GitHub


                    
                    
                    CreateTimeZoneChangeSchema

This is the migration that creates the TimeZoneChange table.

Declaration

Swift

struct CreateTimeZoneChangeSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateTokenSchema

Creates the db schema for the Token table.

Declaration

Swift

struct CreateTokenSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateTwarrtEditSchema

Declaration

Swift

struct CreateTwarrtEditSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateTwarrtLikesSchema

Declaration

Swift

struct CreateTwarrtLikesSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateTwarrtSchema

Declaration

Swift

struct CreateTwarrtSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateUserFavoriteSchema

Declaration

Swift

struct CreateUserFavoriteSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateUserNoteSchema

Declaration

Swift

struct CreateUserNoteSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateUserRoleSchema

Declaration

Swift

struct CreateUserRoleSchema : AsyncMigration

Show on GitHub


                    
                    
                    CreateUserSchema

Creates the User table in the database and specifies its fields.

Declaration

Swift

struct CreateUserSchema : AsyncMigration

Show on GitHub


                    
                    
                    ImportBoardgames

A Migration that imports the Games Catalog JSON file.

This file is located in the seeds/ subdirectory of the project.

Declaration

Swift

struct ImportBoardgames : AsyncMigration

Show on GitHub


                    
                    
                    ImportEvents

A Migration that imports the event schedule from a schedule.ics file located in the seeds/ subdirectory of the project.

Declaration

Swift

struct ImportEvents : AsyncMigration

Show on GitHub


                    
                    
                    ImportKaraokeSongs

A Migration that imports the Karaoke Song Catalog file.

This file is located in the seeds/ subdirectory of the project.

Declaration

Swift

struct ImportKaraokeSongs : AsyncMigration

Show on GitHub


                    
                    
                    ImportRegistrationCodes

A Migration that populates the RegistrationCode database from a registration-codes.txt file located in the seeds/ subdirectory of the project.

Declaration

Swift

struct ImportRegistrationCodes : AsyncMigration

Show on GitHub


                    
                    
                    SetInitialCategoryForumCounts

A Migration that initializes the ForumCount field in each category. This migration should run after all the migrations that generate forum threads.

Declaration

Swift

struct SetInitialCategoryForumCounts : AsyncMigration

Show on GitHub


                    
                    
                    SetInitialEventForums

A Migration that creates Forums for each Event in the schedule.

Declaration

Swift

struct SetInitialEventForums : AsyncMigration

Show on GitHub


                    
                    
                    UpdateForumReadersLastPostReadSchema

Declaration

Swift

struct UpdateForumReadersLastPostReadSchema : AsyncMigration

Show on GitHub


                    
                    
                    UpdateForumReadersMuteSchema

Declaration

Swift

struct UpdateForumReadersMuteSchema : AsyncMigration

Show on GitHub