Database.Beam.Sqlite.Migrate

Migrations support for SQLite databases

beam-migrate CLI support

migrationBackend :: BeamMigrationBackend Sqlite SqliteM

Top-level BeamMigrationBackend loaded dynamically by the beam-migrate CLI tool.

data SqliteCommandSyntax

A SQLite command. INSERT is special cased to handle AUTO INCREMENT columns. The fromSqliteCommand function will take an SqliteCommandSyntax and convert it into the correct SqliteSyntax.

Instances

IsSql92Syntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

Associated Types

type Sql92SelectSyntax SqliteCommandSyntax

type Sql92InsertSyntax SqliteCommandSyntax

type Sql92UpdateSyntax SqliteCommandSyntax

type Sql92DeleteSyntax SqliteCommandSyntax

Methods

selectCmd :: Sql92SelectSyntax SqliteCommandSyntax -> SqliteCommandSyntax

insertCmd :: Sql92InsertSyntax SqliteCommandSyntax -> SqliteCommandSyntax

updateCmd :: Sql92UpdateSyntax SqliteCommandSyntax -> SqliteCommandSyntax

deleteCmd :: Sql92DeleteSyntax SqliteCommandSyntax -> SqliteCommandSyntax

IsSql92DdlCommandSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

Associated Types

type Sql92DdlCommandCreateTableSyntax SqliteCommandSyntax

type Sql92DdlCommandAlterTableSyntax SqliteCommandSyntax

type Sql92DdlCommandDropTableSyntax SqliteCommandSyntax

Methods

createTableCmd :: Sql92DdlCommandCreateTableSyntax SqliteCommandSyntax -> SqliteCommandSyntax

dropTableCmd :: Sql92DdlCommandDropTableSyntax SqliteCommandSyntax -> SqliteCommandSyntax

alterTableCmd :: Sql92DdlCommandAlterTableSyntax SqliteCommandSyntax -> SqliteCommandSyntax

type Sql92DeleteSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92DeleteSyntax SqliteCommandSyntax = SqliteDeleteSyntax

type Sql92InsertSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92InsertSyntax SqliteCommandSyntax = SqliteInsertSyntax

type Sql92SelectSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92SelectSyntax SqliteCommandSyntax = SqliteSelectSyntax

type Sql92UpdateSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92UpdateSyntax SqliteCommandSyntax = SqliteUpdateSyntax

type Sql92DdlCommandAlterTableSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92DdlCommandAlterTableSyntax SqliteCommandSyntax

type Sql92DdlCommandCreateTableSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92DdlCommandCreateTableSyntax SqliteCommandSyntax

type Sql92DdlCommandDropTableSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92DdlCommandDropTableSyntax SqliteCommandSyntax

beam-migrate utility functions

migrateScript :: MigrationSteps Sqlite () a -> [ByteString]

Render a series of MigrationSteps in the SqliteCommandSyntax into a line-by-line list of lazy BL'ByteStrings. The output is suitable for inclusion in a migration script. Comments are generated giving a description of each migration step.

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

Write the output of migrateScript to a file

sqlitePredConverter :: HaskellPredicateConverter

HaskellPredicateConverter that can convert all constraints generated by getDbConstaints into their equivalent in the beam-migrate haskell syntax. Suitable for auto-generation of a haskell migration.

sqliteTypeToHs :: SqliteDataTypeSyntax -> Maybe HsDataType

Convert a SQLite data type to the corresponding Haskell one

getDbConstraints :: SqliteM [SomeDatabasePredicate]

Get a list of database predicates for the current database. This is beam's best guess at providing a schema for the current database. Note that SQLite type names are not standardized, and the so-called column "affinities" are too broad to be of use. This function attemps to guess a good enough type based on the exact type supplied in the CREATE TABLE commands. It will correctly parse any type generated by beam and most SQL compliant types, but it may falter on databases created or managed by tools that do not follow these standards.

SQLite-specific data types

sqliteText :: DataType Sqlite Text

sqliteBlob :: DataType Sqlite ByteString

sqliteBigInt :: DataType Sqlite Int64