Refurb.Types

Module containing externally useful types for Refurb, most notably the Migration type.

Documentation

data ConnInfo

Structure with connection information for connecting to the database.

Constructors

ConnInfo

Fields

• connHost :: Text

  Hostname or IP address of the PostgreSQL server.

• connPort :: Word16

  Port number the PostgreSQL server is running on (usually 5432).

• connUser :: Text

  What user to connect to the database as.

• connPassword :: Text

  What password to connect to the database with.

• connDbName :: Text

  What database in the PostgreSQL server to attach to.

connInfoAsConnString :: ConnInfo -> ByteString

Given a ConnInfo make up the real connection string to pass when connecting to the database. Includes password, so never log this.

connInfoAsLogString :: ConnInfo -> Text

Given a ConnInfo make up the log-safe connection string to show to humans, which omits the password.

data MigrationType

Enumeration of the types of migration that are known about.

Constructors

MigrationSchema

Migration that updates the schema of the database and should be run everywhere.

MigrationSeedData

Migration that installs or replaces data for testing purposes and should never be run in production.

Instances

Eq MigrationType

Methods

(==) :: MigrationType -> MigrationType -> Bool

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

Show MigrationType

Methods

showsPrec :: Int -> MigrationType -> ShowS

show :: MigrationType -> String

showList :: [MigrationType] -> ShowS

type MonadMigration m = (MonadBaseControl IO m, MonadMask m, MonadReader Connection m, MonadLogger m)

Constraint for actions run in the context of a migration, with access to underlying IO, PostgreSQL connection, and logging.

data Migration

Data type of a migration, with its key, type, and actions.

Constructors

Migration

Fields

• _migrationSchema :: Text

  Schema for the migration to run in, which also qualifies the migration key."

• _migrationKey :: Text

  Unique key to identify this migration among all known migrations. Never reuse keys, as they're the only link between the stored migration log and known migrations.

• _migrationType :: MigrationType

  What type of migration this is.

• _migrationCheck :: forall m. MonadMigration m => Maybe (m ())

  Optional action to execute before the primary execution to verify preconditions.

• _migrationExecute :: forall m. MonadMigration m => m ()

  Main migration action, such as creating tables or updating data.

migrationSchema :: Lens' Migration Text

migrationKey :: Lens' Migration Text

migrationType :: Lens' Migration MigrationType

migrationCheck :: forall m. MonadMigration m => Getter Migration (Maybe (m ()))

migrationExecute :: forall m. MonadMigration m => Getter Migration (m ())

migrationQualifiedKey :: Migration -> Text

The fully qualified key of the migration, schema.key

schemaMigration :: Text -> Text -> (forall m. MonadMigration m => m ()) -> Migration

Helper to construct a MigrationSchema type Migration with the given execution action and no check action.

seedDataMigration :: Text -> Text -> (forall m. MonadMigration m => m ()) -> Migration

Helper to construct a MigrationSeedData type Migration with the given execution action and no check action.

withCheck :: Migration -> (forall m. MonadMigration m => m ()) -> Migration

Attach a check function to a Migration.