Safe Haskell	Safe-Inferred
Language	Haskell2010

Database.PostgreSQL.Query.SqlBuilder.Builder

Contents

Running
Building
- Unsafe

Synopsis

newtype SqlBuilder = SqlBuilder {
- sqlBuild :: Connection -> LogMasker -> IO SqlBuilderResult
}
runSqlBuilder :: Connection -> LogMasker -> SqlBuilder -> IO (Query, ByteString)
emptyB :: SqlBuilder
mkValue :: ToField a => a -> SqlBuilder
mkMaskedValue :: ToField a => a -> SqlBuilder
sqlBuilderFromField :: ToField a => FieldOption -> a -> SqlBuilder
sqlBuilderPure :: Builder -> SqlBuilder
sqlBuilderFromByteString :: ByteString -> SqlBuilder

Documentation

newtype SqlBuilder Source #

Builder wich can be effectively concatenated. Requires Connection inside for string quoting implemented in libpq. Builds two strings: query string and log string which may differ.

Constructors

SqlBuilder
Fields sqlBuild :: Connection -> LogMasker -> IO SqlBuilderResult

Instances

Instances details

IsString SqlBuilder Source #
Instance details Defined in Database.PostgreSQL.Query.SqlBuilder.Builder Methods fromString :: String -> SqlBuilder #
Monoid SqlBuilder Source #
Instance details Defined in Database.PostgreSQL.Query.SqlBuilder.Builder Methods mempty :: SqlBuilder # mappend :: SqlBuilder -> SqlBuilder -> SqlBuilder # mconcat :: [SqlBuilder] -> SqlBuilder #
Semigroup SqlBuilder Source #
Instance details Defined in Database.PostgreSQL.Query.SqlBuilder.Builder Methods (<>) :: SqlBuilder -> SqlBuilder -> SqlBuilder # sconcat :: NonEmpty SqlBuilder -> SqlBuilder # stimes :: Integral b => b -> SqlBuilder -> SqlBuilder #
Generic SqlBuilder Source #
Instance details Defined in Database.PostgreSQL.Query.SqlBuilder.Builder Associated Types type Rep SqlBuilder :: Type -> Type # Methods from :: SqlBuilder -> Rep SqlBuilder x # to :: Rep SqlBuilder x -> SqlBuilder #
ToSqlBuilder SqlBuilder Source #
Instance details Defined in Database.PostgreSQL.Query.SqlBuilder.Class Methods toSqlBuilder :: SqlBuilder -> SqlBuilder Source #
type Rep SqlBuilder Source #
Instance details Defined in Database.PostgreSQL.Query.SqlBuilder.Builder type Rep SqlBuilder = D1 ('MetaData "SqlBuilder" "Database.PostgreSQL.Query.SqlBuilder.Builder" "postgresql-query-3.10.0-HqZ8vBAT9kAL74IiVyVZTe" 'True) (C1 ('MetaCons "SqlBuilder" 'PrefixI 'True) (S1 ('MetaSel ('Just "sqlBuild") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Connection -> LogMasker -> IO SqlBuilderResult))))

Running

runSqlBuilder :: Connection -> LogMasker -> SqlBuilder -> IO (Query, ByteString) Source #

Returns query string with log bytestring

Building

emptyB :: SqlBuilder Source #

Typed synonym of mempty

mkValue :: ToField a => a -> SqlBuilder Source #

Shorthand function to convert single field value to builder

mkMaskedValue :: ToField a => a -> SqlBuilder Source #

Shorthand function to convert single masked field value (which should not be shown in log)

sqlBuilderFromField :: ToField a => FieldOption -> a -> SqlBuilder Source #

Unsafe

sqlBuilderPure :: Builder -> SqlBuilder Source #

Lift pure bytestring builder to SqlBuilder. This is unsafe to use directly in your code.

sqlBuilderFromByteString :: ByteString -> SqlBuilder Source #

Unsafe function to make SqlBuilder from arbitrary ByteString. Does not perform any checks. Dont use it directly in your code unless you know what you are doing.