Safe Haskell	Safe-Inferred
Language	Haskell2010

Database.Beam.Postgres.Migrate

Contents

Postgres data types
Orphan instances

Description

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

Synopsis

data PgCommandSyntax
migrationBackend :: BeamMigrationBackend Postgres Pg
postgresDataTypeDeserializers :: BeamDeserializers Postgres
pgPredConverter :: HaskellPredicateConverter
getDbConstraints :: Connection -> IO [SomeDatabasePredicate]
getDbConstraintsForSchemas :: Maybe [String] -> Connection -> IO [SomeDatabasePredicate]
pgTypeToHs :: PgDataTypeSyntax -> Maybe HsDataType
migrateScript :: MigrationSteps Postgres () a' -> [ByteString]
writeMigrationScript :: FilePath -> MigrationSteps Postgres () a -> IO ()
pgDataTypeFromAtt :: ByteString -> Oid -> Maybe Int32 -> Maybe PgDataTypeSyntax
tsquery :: DataType Postgres TsQuery
tsvector :: DataType Postgres TsVector
text :: DataType Postgres Text
bytea :: DataType Postgres ByteString
unboundedArray :: forall a. Typeable a => DataType Postgres a -> DataType Postgres (Vector a)
uuid :: DataType Postgres UUID
money :: DataType Postgres PgMoney
json :: (ToJSON a, FromJSON a) => DataType Postgres (PgJSON a)
jsonb :: (ToJSON a, FromJSON a) => DataType Postgres (PgJSONB a)
smallserial :: Integral a => DataType Postgres (SqlSerial a)
serial :: Integral a => DataType Postgres (SqlSerial a)
bigserial :: Integral a => DataType Postgres (SqlSerial a)
point :: DataType Postgres PgPoint
line :: DataType Postgres PgLine
lineSegment :: DataType Postgres PgLineSegment
box :: DataType Postgres PgBox

Documentation

data PgCommandSyntax Source #

Representation of an arbitrary Postgres command. This is the combination of the command syntax (repesented by PgSyntax), as well as the type of command (represented by PgCommandType). The command type is necessary for us to know how to retrieve results from the database.

Instances

Instances details

IsSql92Syntax PgCommandSyntax Source #
Instance details Defined in Database.Beam.Postgres.Syntax Associated Types type Sql92SelectSyntax PgCommandSyntax # type Sql92InsertSyntax PgCommandSyntax # type Sql92UpdateSyntax PgCommandSyntax # type Sql92DeleteSyntax PgCommandSyntax # Methods selectCmd :: Sql92SelectSyntax PgCommandSyntax -> PgCommandSyntax # insertCmd :: Sql92InsertSyntax PgCommandSyntax -> PgCommandSyntax # updateCmd :: Sql92UpdateSyntax PgCommandSyntax -> PgCommandSyntax # deleteCmd :: Sql92DeleteSyntax PgCommandSyntax -> PgCommandSyntax #
IsSql92DdlCommandSyntax PgCommandSyntax Source #
Instance details Defined in Database.Beam.Postgres.Syntax Associated Types type Sql92DdlCommandCreateTableSyntax PgCommandSyntax # type Sql92DdlCommandAlterTableSyntax PgCommandSyntax # type Sql92DdlCommandDropTableSyntax PgCommandSyntax # Methods createTableCmd :: Sql92DdlCommandCreateTableSyntax PgCommandSyntax -> PgCommandSyntax # dropTableCmd :: Sql92DdlCommandDropTableSyntax PgCommandSyntax -> PgCommandSyntax # alterTableCmd :: Sql92DdlCommandAlterTableSyntax PgCommandSyntax -> PgCommandSyntax #
type Sql92DeleteSyntax PgCommandSyntax Source #
Instance details Defined in Database.Beam.Postgres.Syntax type Sql92DeleteSyntax PgCommandSyntax = PgDeleteSyntax
type Sql92InsertSyntax PgCommandSyntax Source #
Instance details Defined in Database.Beam.Postgres.Syntax type Sql92InsertSyntax PgCommandSyntax = PgInsertSyntax
type Sql92SelectSyntax PgCommandSyntax Source #
Instance details Defined in Database.Beam.Postgres.Syntax type Sql92SelectSyntax PgCommandSyntax = PgSelectSyntax
type Sql92UpdateSyntax PgCommandSyntax Source #
Instance details Defined in Database.Beam.Postgres.Syntax type Sql92UpdateSyntax PgCommandSyntax = PgUpdateSyntax
type Sql92DdlCommandAlterTableSyntax PgCommandSyntax Source #
Instance details Defined in Database.Beam.Postgres.Syntax type Sql92DdlCommandAlterTableSyntax PgCommandSyntax = PgAlterTableSyntax
type Sql92DdlCommandCreateTableSyntax PgCommandSyntax Source #
Instance details Defined in Database.Beam.Postgres.Syntax type Sql92DdlCommandCreateTableSyntax PgCommandSyntax = PgCreateTableSyntax
type Sql92DdlCommandDropTableSyntax PgCommandSyntax Source #
Instance details Defined in Database.Beam.Postgres.Syntax type Sql92DdlCommandDropTableSyntax PgCommandSyntax

migrationBackend :: BeamMigrationBackend Postgres Pg Source #

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

postgresDataTypeDeserializers :: BeamDeserializers Postgres Source #

BeamDeserializers for postgres-specific types:

pgPredConverter :: HaskellPredicateConverter Source #

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

getDbConstraints :: Connection -> IO [SomeDatabasePredicate] Source #

getDbConstraintsForSchemas :: Maybe [String] -> Connection -> IO [SomeDatabasePredicate] Source #

pgTypeToHs :: PgDataTypeSyntax -> Maybe HsDataType Source #

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 Postgres () a' -> [ByteString] Source #

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

writeMigrationScript :: FilePath -> MigrationSteps Postgres () a -> IO () Source #

Write the migration given by the MigrationSteps to a file.

pgDataTypeFromAtt :: ByteString -> Oid -> Maybe Int32 -> Maybe PgDataTypeSyntax Source #

Postgres data types

tsquery :: DataType Postgres TsQuery Source #

DataType for tsquery. See TsQuery for more information

tsvector :: DataType Postgres TsVector Source #

DataType for tsvector. See TsVector for more information

text :: DataType Postgres Text Source #

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

bytea :: DataType Postgres ByteString Source #

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

unboundedArray :: forall a. Typeable a => DataType Postgres a -> DataType Postgres (Vector a) Source #

DataType for a Postgres array without any bounds.

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

uuid :: DataType Postgres UUID Source #

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

money :: DataType Postgres PgMoney Source #

DataType for MONEY columns.

json :: (ToJSON a, FromJSON a) => DataType Postgres (PgJSON a) Source #

DataType for JSON. See PgJSON for more information

jsonb :: (ToJSON a, FromJSON a) => DataType Postgres (PgJSONB a) Source #

DataType for JSONB. See PgJSON for more information

smallserial :: Integral a => DataType Postgres (SqlSerial a) Source #

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

serial :: Integral a => DataType Postgres (SqlSerial a) Source #

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

bigserial :: Integral a => DataType Postgres (SqlSerial a) Source #

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

point :: DataType Postgres PgPoint Source #

line :: DataType Postgres PgLine Source #

lineSegment :: DataType Postgres PgLineSegment Source #

box :: DataType Postgres PgBox Source #

Orphan instances

BeamSqlBackendHasSerial Postgres Source #
Instance details Methods genericSerial :: FieldReturnType 'True 'False Postgres (SqlSerial Int) a => Text -> a #