persistent-2.13.3.5: Type-safe, multi-backend data serialization.
Safe Haskell None
Language Haskell2010

Database.Persist.Sql.Types.Internal

Description

Breaking changes to this module are not reflected in the major version number. Prefer to import from Database.Persist.Sql instead. If you neeed something from this module, please file an issue on GitHub.

Synopsis

Documentation

class HasPersistBackend backend => IsPersistBackend backend where Source #

Class which witnesses that backend is essentially the same as BaseBackend backend . That is, they're isomorphic and backend is just some wrapper over BaseBackend backend .

Methods

mkPersistBackend :: BaseBackend backend -> backend Source #

This function is how we actually construct and tag a backend as having read or write capabilities. It should be used carefully and only when actually constructing a backend . Careless use allows us to accidentally run a write query against a read-only database.

newtype SqlReadBackend Source #

An SQL backend which can only handle read queries

The constructor was exposed in 2.10.0.

Instances

Instances details
PersistStoreRead SqlReadBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PersistCore SqlReadBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

IsPersistBackend SqlReadBackend Source #
Instance details

Defined in Database.Persist.Sql.Types.Internal

HasPersistBackend SqlReadBackend Source #
Instance details

Defined in Database.Persist.Sql.Types.Internal

PersistUniqueRead SqlReadBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistUnique

PersistQueryRead SqlReadBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistQuery

BackendCompatible SqlBackend SqlReadBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Bounded ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Enum ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Eq ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Integral ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Num ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Ord ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Read ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Real ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Show ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Generic ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

ToJSON ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

FromJSON ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

ToHttpApiData ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

FromHttpApiData ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PathPiece ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PersistField ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PersistFieldSql ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

newtype BackendKey SqlReadBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

type BaseBackend SqlReadBackend Source #
Instance details

Defined in Database.Persist.Sql.Types.Internal

type Rep ( BackendKey SqlReadBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

type Rep ( BackendKey SqlReadBackend ) = D1 (' MetaData "BackendKey" "Database.Persist.Sql.Orphan.PersistStore" "persistent-2.13.3.5-AzqyBkRvmH2EfWG2peHu6H" ' True ) ( C1 (' MetaCons "SqlReadBackendKey" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unSqlReadBackendKey") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int64 )))

newtype SqlWriteBackend Source #

An SQL backend which can handle read or write queries

The constructor was exposed in 2.10.0

Instances

Instances details
PersistStoreWrite SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Methods

insert :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => record -> ReaderT SqlWriteBackend m ( Key record) Source #

insert_ :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => record -> ReaderT SqlWriteBackend m () Source #

insertMany :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => [record] -> ReaderT SqlWriteBackend m [ Key record] Source #

insertMany_ :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => [record] -> ReaderT SqlWriteBackend m () Source #

insertEntityMany :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => [ Entity record] -> ReaderT SqlWriteBackend m () Source #

insertKey :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => Key record -> record -> ReaderT SqlWriteBackend m () Source #

repsert :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => Key record -> record -> ReaderT SqlWriteBackend m () Source #

repsertMany :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => [( Key record, record)] -> ReaderT SqlWriteBackend m () Source #

replace :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => Key record -> record -> ReaderT SqlWriteBackend m () Source #

delete :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => Key record -> ReaderT SqlWriteBackend m () Source #

update :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => Key record -> [ Update record] -> ReaderT SqlWriteBackend m () Source #

updateGet :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlWriteBackend ) => Key record -> [ Update record] -> ReaderT SqlWriteBackend m record Source #

PersistStoreRead SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PersistCore SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

IsPersistBackend SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Types.Internal

HasPersistBackend SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Types.Internal

PersistUniqueWrite SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistUnique

PersistUniqueRead SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistUnique

PersistQueryWrite SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistQuery

PersistQueryRead SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistQuery

BackendCompatible SqlBackend SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Bounded ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Enum ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Eq ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Integral ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Num ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Ord ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Read ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Real ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Show ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Generic ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

ToJSON ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

FromJSON ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

ToHttpApiData ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

FromHttpApiData ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PathPiece ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PersistField ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PersistFieldSql ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

newtype BackendKey SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

type BaseBackend SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Types.Internal

type Rep ( BackendKey SqlWriteBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

type Rep ( BackendKey SqlWriteBackend ) = D1 (' MetaData "BackendKey" "Database.Persist.Sql.Orphan.PersistStore" "persistent-2.13.3.5-AzqyBkRvmH2EfWG2peHu6H" ' True ) ( C1 (' MetaCons "SqlWriteBackendKey" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unSqlWriteBackendKey") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int64 )))

readToUnknown :: Monad m => ReaderT SqlReadBackend m a -> ReaderT SqlBackend m a Source #

Useful for running a read query against a backend with unknown capabilities.

readToWrite :: Monad m => ReaderT SqlReadBackend m a -> ReaderT SqlWriteBackend m a Source #

Useful for running a read query against a backend with read and write capabilities.

writeToUnknown :: Monad m => ReaderT SqlWriteBackend m a -> ReaderT SqlBackend m a Source #

Useful for running a write query against an untagged backend with unknown capabilities.

data Statement Source #

A Statement is a representation of a database query that has been prepared and stored on the server side.

data IsolationLevel Source #

Please refer to the documentation for the database in question for a full overview of the semantics of the varying isloation levels

Instances

Instances details
Bounded IsolationLevel Source #
Instance details

Defined in Database.Persist.SqlBackend.Internal.IsolationLevel

Enum IsolationLevel Source #
Instance details

Defined in Database.Persist.SqlBackend.Internal.IsolationLevel

Eq IsolationLevel Source #
Instance details

Defined in Database.Persist.SqlBackend.Internal.IsolationLevel

Ord IsolationLevel Source #
Instance details

Defined in Database.Persist.SqlBackend.Internal.IsolationLevel

Show IsolationLevel Source #
Instance details

Defined in Database.Persist.SqlBackend.Internal.IsolationLevel

data SqlBackend Source #

A SqlBackend represents a handle or connection to a database. It contains functions and values that allow databases to have more optimized implementations, as well as references that benefit performance and sharing.

Instead of using the SqlBackend constructor directly, use the mkSqlBackend function.

A SqlBackend is *not* thread-safe. You should not assume that a SqlBackend can be shared among threads and run concurrent queries. This *will* result in problems. Instead, you should create a Pool SqlBackend , known as a ConnectionPool , and pass that around in multi-threaded applications.

To run actions in the persistent library, you should use the runSqlConn function. If you're using a multithreaded application, use the runSqlPool function.

Constructors

SqlBackend

Fields

Instances

Instances details
PersistStoreWrite SqlBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Methods

insert :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => record -> ReaderT SqlBackend m ( Key record) Source #

insert_ :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => record -> ReaderT SqlBackend m () Source #

insertMany :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => [record] -> ReaderT SqlBackend m [ Key record] Source #

insertMany_ :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => [record] -> ReaderT SqlBackend m () Source #

insertEntityMany :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => [ Entity record] -> ReaderT SqlBackend m () Source #

insertKey :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => Key record -> record -> ReaderT SqlBackend m () Source #

repsert :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => Key record -> record -> ReaderT SqlBackend m () Source #

repsertMany :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => [( Key record, record)] -> ReaderT SqlBackend m () Source #

replace :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => Key record -> record -> ReaderT SqlBackend m () Source #

delete :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => Key record -> ReaderT SqlBackend m () Source #

update :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => Key record -> [ Update record] -> ReaderT SqlBackend m () Source #

updateGet :: forall record (m :: Type -> Type ). ( MonadIO m, PersistRecordBackend record SqlBackend ) => Key record -> [ Update record] -> ReaderT SqlBackend m record Source #

PersistStoreRead SqlBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PersistCore SqlBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

IsPersistBackend SqlBackend Source #
Instance details

Defined in Database.Persist.SqlBackend.Internal

HasPersistBackend SqlBackend Source #
Instance details

Defined in Database.Persist.SqlBackend.Internal

PersistUniqueWrite SqlBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistUnique

PersistUniqueRead SqlBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistUnique

PersistQueryWrite SqlBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistQuery

PersistQueryRead SqlBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistQuery

BackendCompatible SqlBackend SqlBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

BackendCompatible SqlBackend SqlWriteBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

BackendCompatible SqlBackend SqlReadBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Bounded ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Enum ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Eq ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Integral ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Num ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Ord ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Read ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Real ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Show ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

Generic ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

ToJSON ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

FromJSON ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

ToHttpApiData ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

FromHttpApiData ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PathPiece ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PersistField ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

PersistFieldSql ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

newtype BackendKey SqlBackend Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

type BaseBackend SqlBackend Source #
Instance details

Defined in Database.Persist.SqlBackend.Internal

type Rep ( BackendKey SqlBackend ) Source #
Instance details

Defined in Database.Persist.Sql.Orphan.PersistStore

type Rep ( BackendKey SqlBackend ) = D1 (' MetaData "BackendKey" "Database.Persist.Sql.Orphan.PersistStore" "persistent-2.13.3.5-AzqyBkRvmH2EfWG2peHu6H" ' True ) ( C1 (' MetaCons "SqlBackendKey" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unSqlBackendKey") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int64 )))

type SqlBackendCanRead backend = ( BackendCompatible SqlBackend backend, PersistQueryRead backend, PersistStoreRead backend, PersistUniqueRead backend) Source #

A constraint synonym which witnesses that a backend is SQL and can run read queries.

type SqlBackendCanWrite backend = ( SqlBackendCanRead backend, PersistQueryWrite backend, PersistStoreWrite backend, PersistUniqueWrite backend) Source #

A constraint synonym which witnesses that a backend is SQL and can run read and write queries.

type SqlReadT m a = forall backend. SqlBackendCanRead backend => ReaderT backend m a Source #

Like SqlPersistT but compatible with any SQL backend which can handle read queries.

type SqlWriteT m a = forall backend. SqlBackendCanWrite backend => ReaderT backend m a Source #

Like SqlPersistT but compatible with any SQL backend which can handle read and write queries.

type IsSqlBackend backend = ( IsPersistBackend backend, BaseBackend backend ~ SqlBackend ) Source #

A backend which is a wrapper around SqlBackend .