Moduleselda-0.5.2.1Haskell2010

Database.Selda.Backend

API for building Selda backends and adding support for more types in queries.

Synopsis

class MonadSelda
newtype SeldaT
type SeldaM
data SeldaError
newtype StmtID
data BackendID
type QueryRunner
data SeldaBackend
data SeldaConnection
data SqlValue
data IndexMethod
data Param
data ColAttr
data AutoIncType
data PPConfig
value defPPConfig
newtype TableName
newtype ColName
data TableInfo
data ColumnInfo
value isAutoPrimary
value isPrimary
value isUnique
value tableInfo
value fromColInfo
value mkTableName
value mkColName
value fromTableName
value fromColName
value rawTableName
value newConnection
value allStmts
value withBackend
value runSeldaT
value seldaClose

Packageselda-0.5.2.1
Exports35
LanguageHaskell2010
LicenceMIT
SourceBackend.hs

classclass MonadIO m => MonadSelda (m :: Type -> Type) where

Source#

Some monad with Selda SQL capabilitites.

Associated types

type family Backend (m :: Type -> Type)
Type of database backend used by m.

Methods

withConnection :: (SeldaConnection (Backend m) -> m a) -> m a
Pass a Selda connection to the given computation and execute it. After the computation finishes, withConnection is free to do anything it likes to the connection, including closing it or giving it to another Selda computation. Thus, the computation must take care never to return or otherwise access the connection after returning.
transact :: m a -> m a
Perform the given computation as a transaction. Implementations must ensure that subsequent calls to withConnection within the same transaction always passes the same connection to its argument.

Instances1MonadSelda

(MonadIO m, MonadMask m) => MonadSelda (SeldaT b m)Defined in selda-0.5.2.1 · Database.Selda.Backend.Internal

newtypenewtype SeldaT b (m :: Type -> Type) a

Source#

Monad transformer adding Selda SQL capabilities.

Instances11MonadTrans, Monad, Functor, MonadFail, Applicative, MonadIO, …

MonadTrans (SeldaT b)Defined in selda-0.5.2.1 · Database.Selda.Backend.Internal
Monad m => Monad (SeldaT b m)Defined in selda-0.5.2.1 · Database.Selda.Backend.Internal
Functor m => Functor (SeldaT b m)Defined in selda-0.5.2.1 · Database.Selda.Backend.Internal
MonadFail m => MonadFail (SeldaT b m)Defined in selda-0.5.2.1 · Database.Selda.Backend.Internal
Applicative m => Applicative (SeldaT b m)Defined in selda-0.5.2.1 · Database.Selda.Backend.Internal
MonadIO m => MonadIO (SeldaT b m)Defined in selda-0.5.2.1 · Database.Selda.Backend.Internal
MonadCatch m => MonadCatch (SeldaT b m)Defined in selda-0.5.2.1 · Database.Selda.Backend.Internal
MonadMask m => MonadMask (SeldaT b m)Defined in selda-0.5.2.1 · Database.Selda.Backend.Internal
MonadThrow m => MonadThrow (SeldaT b m)Defined in selda-0.5.2.1 · Database.Selda.Backend.Internal
(MonadIO m, MonadMask m) => MonadSelda (SeldaT b m)Defined in selda-0.5.2.1 · Database.Selda.Backend.Internal
type Backend (SeldaT b m) = bDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal

typetype SeldaM b = SeldaT b IO

Source#

The simplest form of Selda computation; SeldaT specialized to IO.

datadata SeldaError

Source#

Thrown by any function in SeldaT if an error occurs.

Constructors

DbError String
Unable to open or connect to database.
SqlError String
An error occurred while executing query.
UnsafeError String
An error occurred due to improper use of an unsafe function.

Instances3Eq, Show, Exception

Eq SeldaErrorDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal
Show SeldaErrorDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal
Exception SeldaErrorDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal

newtypenewtype StmtID

Source#

A prepared statement identifier. Guaranteed to be unique per application.

Instances3Eq, Ord, Show

Eq StmtIDDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal
Ord StmtIDDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal
Show StmtIDDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal

datadata BackendID

Source#

Uniquely identifies some particular backend.

When publishing a new backend, consider submitting a pull request with a constructor for your backend instead of using the Other constructor.

Constructors

Instances3Eq, Ord, Show

Eq BackendIDDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal
Ord BackendIDDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal
Show BackendIDDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal

typetype QueryRunner a = Text -> [Param] -> IO a

Source#

A function which executes a query and gives back a list of extensible tuples; one tuple per result row, and one tuple element per column.

datadata SeldaBackend b

Source#

A collection of functions making up a Selda backend.

Constructors

SeldaBackend
- runStmt :: Text -> [Param] -> IO (Int, [[SqlValue]])
  Execute an SQL statement.
- runStmtWithPK :: Text -> [Param] -> IO Int64
  Execute an SQL statement and return the last inserted primary key, where the primary key is auto-incrementing. Backends must take special care to make this thread-safe.
- prepareStmt :: StmtID -> [SqlTypeRep] -> Text -> IO Dynamic
  Prepare a statement using the given statement identifier.
- runPrepared :: Dynamic -> [Param] -> IO (Int, [[SqlValue]])
  Execute a prepared statement.
- getTableInfo :: TableName -> IO TableInfo
  Get a list of all columns in the given table, with the type and any modifiers for each column. Return an empty list if the given table does not exist.
- ppConfig :: PPConfig
  SQL pretty-printer configuration.
- closeConnection :: SeldaConnection b -> IO ()
  Close the currently open connection.
- backendId :: BackendID
  Unique identifier for this backend.
- disableForeignKeys :: Bool -> IO ()
  Turn on or off foreign key checking, and initiate/commit a transaction.
  When implementing this function, it is safe to assume that disableForeignKeys True will always be called exactly once before each disableForeignKeys False.

datadata SeldaConnection b

datadata SqlValue where

Source#

Some value that is representable in SQL.

Constructors

Instances1Show

Show SqlValueDefined in selda-0.5.2.1 · Database.Selda.SqlType

datadata IndexMethod

Source#

Method to use for indexing with indexedUsing. Index methods are ignored by the SQLite backend, as SQLite doesn't support different index methods.

BTreeIndex HashIndex

Instances3Eq, Ord, Show

Eq IndexMethodDefined in selda-0.5.2.1 · Database.Selda.Table.Type
Ord IndexMethodDefined in selda-0.5.2.1 · Database.Selda.Table.Type
Show IndexMethodDefined in selda-0.5.2.1 · Database.Selda.Table.Type

datadata Param where

Source#

A parameter to a prepared SQL statement.

Constructors

Param :: !Lit a -> Param

Instances3Eq, Ord, Show

Eq ParamDefined in selda-0.5.2.1 · Database.Selda.SQL
Ord ParamDefined in selda-0.5.2.1 · Database.Selda.SQL
Show ParamDefined in selda-0.5.2.1 · Database.Selda.SQL

datadata ColAttr

Source#

Column attributes such as nullability, auto increment, etc. When adding elements, make sure that they are added in the order required by SQL syntax, as this list is only sorted before being pretty-printed.

Constructors

Instances3Eq, Ord, Show

Eq ColAttrDefined in selda-0.5.2.1 · Database.Selda.Table.Type
Ord ColAttrDefined in selda-0.5.2.1 · Database.Selda.Table.Type
Show ColAttrDefined in selda-0.5.2.1 · Database.Selda.Table.Type

datadata AutoIncType

Source#

Strongly or weakly auto-incrementing primary key?

Weak Strong

Instances3Eq, Ord, Show

Eq AutoIncTypeDefined in selda-0.5.2.1 · Database.Selda.Table.Type
Ord AutoIncTypeDefined in selda-0.5.2.1 · Database.Selda.Table.Type
Show AutoIncTypeDefined in selda-0.5.2.1 · Database.Selda.Table.Type

datadata PPConfig

Source#

Backend-specific configuration for the SQL pretty-printer.

Constructors

PPConfig
- ppType :: SqlTypeRep -> Text
  The SQL type name of the given type.
  This function should be used everywhere a type is needed to be printed but in primary keys position. This is due to the fact that some backends might have a special representation of primary keys (using sequences are such). If you have such a need, please use the ppTypePK record instead.
- ppTypeHook :: SqlTypeRep -> [ColAttr] -> (SqlTypeRep -> Text) -> Text
  Hook that allows you to modify ppType output.
- ppTypePK :: SqlTypeRep -> Text
  The SQL type name of the given type for primary keys uses.
- ppPlaceholder :: Int -> Text
  Parameter placeholder for the nth parameter.
- ppColAttrs :: [ColAttr] -> Text
  List of column attributes.
- ppColAttrsHook :: SqlTypeRep -> [ColAttr] -> ([ColAttr] -> Text) -> Text
  Hook that allows you to modify ppColAttrs output.
- ppAutoIncInsert :: Text
  The value used for the next value for an auto-incrementing column. For instance, DEFAULT for PostgreSQL, and NULL for SQLite.
- ppMaxInsertParams :: Maybe Int
  Insert queries may have at most this many parameters; if an insertion has more parameters than this, it will be chunked.
  Note that only insertions of multiple rows are chunked. If your table has more than this many columns, you should really rethink your database design.
- ppIndexMethodHook :: IndexMethod -> Text
  CREATE INDEX suffix to indicate that the index should use the given index method.

valuedefPPConfig :: PPConfig

Source#

Default settings for pretty-printing. Geared towards SQLite.

The default definition of ppTypePK is 'defType, so that you don’t have to do anything special if you don’t use special types for primary keys.

newtypenewtype TableName

Source#

Name of a database table.

Instances4Eq, Ord, Show, IsString

Eq TableNameDefined in selda-0.5.2.1 · Database.Selda.Types
Ord TableNameDefined in selda-0.5.2.1 · Database.Selda.Types
Show TableNameDefined in selda-0.5.2.1 · Database.Selda.Types
IsString TableNameDefined in selda-0.5.2.1 · Database.Selda.Types

newtypenewtype ColName

Source#

Name of a database column.

Instances4Eq, Ord, Show, IsString

Eq ColNameDefined in selda-0.5.2.1 · Database.Selda.Types
Ord ColNameDefined in selda-0.5.2.1 · Database.Selda.Types
Show ColNameDefined in selda-0.5.2.1 · Database.Selda.Types
IsString ColNameDefined in selda-0.5.2.1 · Database.Selda.Types

datadata TableInfo

Source#

Comprehensive information about a table.

Constructors

TableInfo
- tableInfoName :: TableName
  Name of the table.
- tableColumnInfos :: [ColumnInfo]
  Ordered information about each table column.
- tableUniqueGroups :: [[ColName]]
  Unordered list of all (non-PK) uniqueness constraints on this table.
- tablePrimaryKey :: [ColName]
  Unordered list of all primary key constraints on this table.

Instances2Eq, Show

Eq TableInfoDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal
Show TableInfoDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal

datadata ColumnInfo

Source#

Comprehensive information about a column.

Constructors

ColumnInfo
- colName :: ColName
  Name of the column.
- colType :: Either Text SqlTypeRep
  Selda type of the column, or the type name given by the database if Selda couldn't make sense of the type.
- colIsAutoPrimary :: Bool
  Is the given column auto-incrementing?
- colIsNullable :: Bool
  Can the column be NULL?
- colHasIndex :: Bool
  Is the column explicitly indexed (i.e. using indexed)?
- colFKs :: [(TableName, ColName)]
  Any foreign key (table, column) pairs referenced by this column.

Instances2Eq, Show

Eq ColumnInfoDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal
Show ColumnInfoDefined in selda-0.5.2.1 · Database.Selda.Backend.Internal

valueisAutoPrimary :: ColAttr -> Bool

valueisPrimary :: ColAttr -> Bool

valueisUnique :: ColAttr -> Bool

valuetableInfo :: Table a -> TableInfo

Source#

Get the column information for each column in the given table.

valuefromColInfo :: ColInfo -> ColumnInfo

Source#

Convert a ColInfo into a ColumnInfo.

valuemkTableName :: Text -> TableName

Source#

Create a column name.

valuemkColName :: Text -> ColName

Source#

Create a column name.

valuefromTableName :: TableName -> Text

Source#

Convert a table name into a string, with quotes.

valuefromColName :: ColName -> Text

Source#

Convert a column name into a string, with quotes.

valuerawTableName :: TableName -> Text

Source#

Convert a table name into a string, without quotes.

valuenewConnection

:: MonadIO m
=> SeldaBackend b
-> Text
-> m (SeldaConnection b)

Source#

Create a new Selda connection for the given backend and database identifier string.

valueallStmts :: SeldaConnection b -> IO [(StmtID, Dynamic)]

Source#

Get all statements and their corresponding identifiers for the current connection.

valuewithBackend :: MonadSelda m => (SeldaBackend (Backend m) -> m a) -> m a

Source#

Get the backend in use by the computation.

valuerunSeldaT

:: (MonadIO m, MonadMask m)
=> SeldaT b m a
-> SeldaConnection b
-> m a

Source#

Run a Selda transformer. Backends should use this to implement their withX functions.

valueseldaClose :: MonadIO m => SeldaConnection b -> m ()

Source#

Close a reusable Selda connection. Closing a connection while in use is undefined. Passing a closed connection to runSeldaT results in a SeldaError being thrown. Closing a connection more than once is a no-op.

module Database.Selda.SqlType