Database.PostgreSQL.PQTypes.Checks

Checks

checkDatabase :: forall m. (MonadDB m, MonadLog m, MonadThrow m) => ExtrasOptions -> [CompositeType] -> [Domain] -> [Table] -> m ()

Run checks on the database structure and whether the database needs to be migrated. Will do a full check of DB structure.

createTable :: MonadDB m => Bool -> Table -> m ()

createDomain :: MonadDB m => Domain -> m ()

Options

data ExtrasOptions

Constructors

ExtrasOptions

Fields

• eoLockTimeoutMs :: !(Maybe Int)
• eoEnforcePKs :: !Bool

  Validate that every handled table has a primary key

• eoObjectsValidationMode :: !ObjectsValidationMode

  Validation mode for unknown tables and composite types.

• eoAllowHigherTableVersions :: !Bool

  Whether to allow tables in the database to have higher versions than the one in the code definition.

Instances

Eq ExtrasOptions

Defined in Database.PostgreSQL.PQTypes.ExtrasOptions

Methods

(==) :: ExtrasOptions -> ExtrasOptions -> Bool

(/=) :: ExtrasOptions -> ExtrasOptions -> Bool

defaultExtrasOptions :: ExtrasOptions

data ObjectsValidationMode

Constructors

AllowUnknownObjects

DontAllowUnknownObjects

Instances

Eq ObjectsValidationMode

Defined in Database.PostgreSQL.PQTypes.ExtrasOptions

Methods

(==) :: ObjectsValidationMode -> ObjectsValidationMode -> Bool

(/=) :: ObjectsValidationMode -> ObjectsValidationMode -> Bool

Migrations

migrateDatabase :: (MonadBase IO m, MonadDB m, MonadLog m, MonadMask m) => ExtrasOptions -> [Extension] -> [CompositeType] -> [Domain] -> [Table] -> [Migration m] -> m ()

Run migrations and check the database structure.