Database.Beam.Postgres.Migrate

Migrations support for beam-postgres. See Database.Beam.Migrate for more information on beam migrations.

Documentation

migrationBackend :: BeamMigrationBackend PgCommandSyntax Postgres Connection Pg

Top-level migration backend for use by beam-migrate tools

postgresDataTypeDeserializers :: BeamDeserializers PgCommandSyntax

BeamDeserializers for postgres-specific types:

• bytea
• smallserial
• serial
• bigserial
• tsvector
• tsquery
• text
• json
• jsonb
• uuid
• money

pgPredConverter :: HaskellPredicateConverter

Converts postgres DatabasePredicates to DatabasePredicates in the Haskell syntax. Allows automatic generation of Haskell schemas from postgres constraints.

getDbConstraints :: Connection -> IO [SomeDatabasePredicate]

pgTypeToHs :: PgDataTypeSyntax -> Maybe HsDataType

Turn a PgDataTypeSyntax into the corresponding HsDataType. This is a best effort guess, and may fail on more exotic types. Feel free to send PRs to make this function more robust!

migrateScript :: MigrationSteps PgCommandSyntax () a' -> [ByteString]

Turn a series of MigrationSteps into a line-by-line array of ByteStrings suitable for writing to a script.

writeMigrationScript :: FilePath -> MigrationSteps PgCommandSyntax () a -> IO ()

Write the migration given by the MigrationSteps to a file.

Postgres data types

tsquery :: DataType PgDataTypeSyntax TsQuery

DataType for tsquery. See TsQuery for more information

tsvector :: DataType PgDataTypeSyntax TsVector

DataType for tsvector. See TsVector for more information

text :: DataType PgDataTypeSyntax Text

DataType for Postgres TEXT. characterLargeObject is also mapped to this data type

bytea :: DataType PgDataTypeSyntax ByteString

DataType for Postgres BYTEA. binaryLargeObject is also mapped to this data type

unboundedArray :: forall a. Typeable a => DataType PgDataTypeSyntax a -> DataType PgDataTypeSyntax (Vector a)

DataType for a Postgres array without any bounds.

Note that array support in beam-migrate is still incomplete.

uuid :: DataType PgDataTypeSyntax UUID

DataType for UUID columns. The pgCryptoGenRandomUUID function in the PgCrypto extension can be used to generate UUIDs at random.

money :: DataType PgDataTypeSyntax PgMoney

DataType for MONEY columns.

json :: (ToJSON a, FromJSON a) => DataType PgDataTypeSyntax (PgJSON a)

DataType for JSON. See PgJSON for more information

jsonb :: (ToJSON a, FromJSON a) => DataType PgDataTypeSyntax (PgJSONB a)

DataType for JSONB. See PgJSON for more information

smallserial :: Integral a => DataType PgDataTypeSyntax (SqlSerial a)

Postgres SERIAL data types. Automatically generates an appropriate DEFAULT clause and sequence

serial :: Integral a => DataType PgDataTypeSyntax (SqlSerial a)

Postgres SERIAL data types. Automatically generates an appropriate DEFAULT clause and sequence

bigserial :: Integral a => DataType PgDataTypeSyntax (SqlSerial a)

Postgres SERIAL data types. Automatically generates an appropriate DEFAULT clause and sequence

Orphan instances

IsBeamSerialColumnSchemaSyntax PgColumnSchemaSyntax

Methods

genericSerial :: FieldReturnType True False PgColumnSchemaSyntax (SqlSerial Int) a => Text -> a