Safe Haskell	None
Language	Haskell2010

Pqi

Contents

Type classes
Shared types
Connection-independent helpers

Description

A driver-agnostic reproduction of the postgresql-libpq API (version 0.11, the pipelining-capable release).

The connection is reified as a single class IsConnection c parameterised over the connection type. Result accessors live in the independent IsResult r class, and cancellation handles in IsCancel k. IsResult (ResultOf c) and IsCancel (CancelOf c) are superclass constraints of IsConnection c, so callers who have access to a connection get result inspection and cancellation automatically.

Function names, argument order, and semantics mirror the API of the C library binding postgresql-libpq. The only deliberate departures are:

Connection, Result, and Cancel become the class parameter c and the associated types ResultOf c / CancelOf c.
OIDs are a plain Word32 and row/column/parameter indices and LoFds are a plain Int32, rather than the C-specific newtypes of the original.
Ambiguous, rarely-useful helpers (e.g. resStatus) are omitted, libpqVersion is omitted too.
There's no invalidOid constant. It's just 0.
The unescapeBytea helper is bundled in this library and implemented natively without IO.

Synopsis

class (IsResult (ResultOf c), IsCancel (CancelOf c)) => IsConnection c where
- type ResultOf c
- type CancelOf c
- connectdb :: ByteString -> IO c
- connectStart :: ByteString -> IO c
- connectPoll :: c -> IO PollingStatus
- newNullConnection :: IO c
- isNullConnection :: c -> Bool
- finish :: c -> IO ()
- reset :: c -> IO ()
- resetStart :: c -> IO Bool
- resetPoll :: c -> IO PollingStatus
- db :: c -> IO (Maybe ByteString)
- user :: c -> IO (Maybe ByteString)
- pass :: c -> IO (Maybe ByteString)
- host :: c -> IO (Maybe ByteString)
- port :: c -> IO (Maybe ByteString)
- options :: c -> IO (Maybe ByteString)
- status :: c -> IO ConnStatus
- transactionStatus :: c -> IO TransactionStatus
- parameterStatus :: c -> ByteString -> IO (Maybe ByteString)
- protocolVersion :: c -> IO Int
- serverVersion :: c -> IO Int
- errorMessage :: c -> IO (Maybe ByteString)
- socket :: c -> IO (Maybe Fd)
- backendPID :: c -> IO Int32
- connectionNeedsPassword :: c -> IO Bool
- connectionUsedPassword :: c -> IO Bool
- exec :: c -> ByteString -> IO (Maybe (ResultOf c))
- execParams :: c -> ByteString -> [Maybe (Word32, ByteString, Format)] -> Format -> IO (Maybe (ResultOf c))
- prepare :: c -> ByteString -> ByteString -> Maybe [Word32] -> IO (Maybe (ResultOf c))
- execPrepared :: c -> ByteString -> [Maybe (ByteString, Format)] -> Format -> IO (Maybe (ResultOf c))
- describePrepared :: c -> ByteString -> IO (Maybe (ResultOf c))
- describePortal :: c -> ByteString -> IO (Maybe (ResultOf c))
- escapeStringConn :: c -> ByteString -> IO (Maybe ByteString)
- escapeByteaConn :: c -> ByteString -> IO (Maybe ByteString)
- escapeIdentifier :: c -> ByteString -> IO (Maybe ByteString)
- sendQuery :: c -> ByteString -> IO Bool
- sendQueryParams :: c -> ByteString -> [Maybe (Word32, ByteString, Format)] -> Format -> IO Bool
- sendPrepare :: c -> ByteString -> ByteString -> Maybe [Word32] -> IO Bool
- sendQueryPrepared :: c -> ByteString -> [Maybe (ByteString, Format)] -> Format -> IO Bool
- sendDescribePrepared :: c -> ByteString -> IO Bool
- sendDescribePortal :: c -> ByteString -> IO Bool
- getResult :: c -> IO (Maybe (ResultOf c))
- consumeInput :: c -> IO Bool
- isBusy :: c -> IO Bool
- setnonblocking :: c -> Bool -> IO Bool
- isnonblocking :: c -> IO Bool
- setSingleRowMode :: c -> IO Bool
- flush :: c -> IO FlushStatus
- pipelineStatus :: c -> IO PipelineStatus
- enterPipelineMode :: c -> IO Bool
- exitPipelineMode :: c -> IO Bool
- pipelineSync :: c -> IO Bool
- sendFlushRequest :: c -> IO Bool
- getCancel :: c -> IO (Maybe (CancelOf c))
- notifies :: c -> IO (Maybe Notify)
- disableNoticeReporting :: c -> IO ()
- enableNoticeReporting :: c -> IO ()
- getNotice :: c -> IO (Maybe ByteString)
- putCopyData :: c -> ByteString -> IO CopyInResult
- putCopyEnd :: c -> Maybe ByteString -> IO CopyInResult
- getCopyData :: c -> Bool -> IO CopyOutResult
- loCreat :: c -> IO (Maybe Word32)
- loCreate :: c -> Word32 -> IO (Maybe Word32)
- loImport :: c -> FilePath -> IO (Maybe Word32)
- loImportWithOid :: c -> FilePath -> Word32 -> IO (Maybe Word32)
- loExport :: c -> Word32 -> FilePath -> IO (Maybe ())
- loOpen :: c -> Word32 -> IOMode -> IO (Maybe Int32)
- loWrite :: c -> Int32 -> ByteString -> IO (Maybe Int)
- loRead :: c -> Int32 -> Int -> IO (Maybe ByteString)
- loSeek :: c -> Int32 -> SeekMode -> Int -> IO (Maybe Int)
- loTell :: c -> Int32 -> IO (Maybe Int)
- loTruncate :: c -> Int32 -> Int -> IO (Maybe ())
- loClose :: c -> Int32 -> IO (Maybe ())
- loUnlink :: c -> Word32 -> IO (Maybe ())
- clientEncoding :: c -> IO ByteString
- setClientEncoding :: c -> ByteString -> IO Bool
- setErrorVerbosity :: c -> Verbosity -> IO Verbosity
class IsResult r where
- resultStatus :: r -> IO ExecStatus
- resultErrorMessage :: r -> IO (Maybe ByteString)
- resultErrorField :: r -> FieldCode -> IO (Maybe ByteString)
- unsafeFreeResult :: r -> IO ()
- ntuples :: r -> IO Int32
- nfields :: r -> IO Int32
- fname :: r -> Int32 -> IO (Maybe ByteString)
- fnumber :: r -> ByteString -> IO (Maybe Int32)
- ftable :: r -> Int32 -> IO Word32
- ftablecol :: r -> Int32 -> IO Int32
- fformat :: r -> Int32 -> IO Format
- ftype :: r -> Int32 -> IO Word32
- fmod :: r -> Int32 -> IO Int
- fsize :: r -> Int32 -> IO Int
- getvalue :: r -> Int32 -> Int32 -> IO (Maybe ByteString)
- getvalue' :: r -> Int32 -> Int32 -> IO (Maybe ByteString)
- getisnull :: r -> Int32 -> Int32 -> IO Bool
- getlength :: r -> Int32 -> Int32 -> IO Int
- nparams :: r -> IO Int32
- paramtype :: r -> Int32 -> IO Word32
- cmdStatus :: r -> IO (Maybe ByteString)
- cmdTuples :: r -> IO (Maybe ByteString)
class IsCancel k where
- cancel :: k -> IO (Either ByteString ())
data Format
- = Text
- | Binary
data ExecStatus
- = EmptyQuery
- | CommandOk
- | TuplesOk
- | CopyOut
- | CopyIn
- | CopyBoth
- | BadResponse
- | NonfatalError
- | FatalError
- | SingleTuple
- | PipelineSync
- | PipelineAbort
data ConnStatus
data TransactionStatus
- = TransIdle
- | TransActive
- | TransInTrans
- | TransInError
- | TransUnknown
data PollingStatus
- = PollingFailed
- | PollingReading
- | PollingWriting
- | PollingOk
data PipelineStatus
- = PipelineOn
- | PipelineOff
- | PipelineAborted
data FieldCode
- = DiagSeverity
- | DiagSqlstate
- | DiagMessagePrimary
- | DiagMessageDetail
- | DiagMessageHint
- | DiagStatementPosition
- | DiagInternalPosition
- | DiagInternalQuery
- | DiagContext
- | DiagSourceFile
- | DiagSourceLine
- | DiagSourceFunction
data Verbosity
- = ErrorsTerse
- | ErrorsDefault
- | ErrorsVerbose
data FlushStatus
- = FlushOk
- | FlushFailed
- | FlushWriting
data CopyInResult
- = CopyInOk
- | CopyInError
- | CopyInWouldBlock
data CopyOutResult
- = CopyOutRow ByteString
- | CopyOutWouldBlock
- | CopyOutDone
- | CopyOutError
data Notify = Notify {
- relname :: ByteString
- bePid :: Int32
- extra :: ByteString
}
unescapeBytea :: ByteString -> ByteString

Type classes

class (IsResult (ResultOf c), IsCancel (CancelOf c)) => IsConnection c where Source #

The single flat capability class: establishing, closing, inspecting, querying, escaping, async commands, pipelining, cancellation handle creation, notifications, copy, large objects, and control.

See the individual capability-class documentation (now inlined below) for semantics of each method.

Associated Types

type ResultOf c Source #

The result type produced by this connection.

type CancelOf c Source #

The cancellation-handle type produced by this connection.

Methods

connectdb :: ByteString -> IO c Source #

Make a new (blocking) connection from a conninfo string.

connectStart :: ByteString -> IO c Source #

Begin establishing a connection asynchronously.

connectPoll :: c -> IO PollingStatus Source #

Drive an asynchronous connection attempt forward.

newNullConnection :: IO c Source #

A sentinel "null" connection.

isNullConnection :: c -> Bool Source #

Whether a connection is the null sentinel.

finish :: c -> IO () Source #

Close the connection and release its resources.

reset :: c -> IO () Source #

Reset the communication channel to the server (blocking).

resetStart :: c -> IO Bool Source #

Begin resetting the connection asynchronously.

resetPoll :: c -> IO PollingStatus Source #

Drive an asynchronous reset forward.

db :: c -> IO (Maybe ByteString) Source #

The database name of the connection.

user :: c -> IO (Maybe ByteString) Source #

The user name of the connection.

pass :: c -> IO (Maybe ByteString) Source #

The password of the connection.

host :: c -> IO (Maybe ByteString) Source #

The server host name of the connection.

port :: c -> IO (Maybe ByteString) Source #

The port of the connection.

options :: c -> IO (Maybe ByteString) Source #

The command-line options passed in the connection request.

status :: c -> IO ConnStatus Source #

Current connection status.

transactionStatus :: c -> IO TransactionStatus Source #

Current in-transaction status of the server.

parameterStatus :: c -> ByteString -> IO (Maybe ByteString) Source #

Look up a current parameter setting reported by the server.

protocolVersion :: c -> IO Int Source #

The frontend/backend protocol version.

serverVersion :: c -> IO Int Source #

The server version, as an integer of the form MMmmpp.

errorMessage :: c -> IO (Maybe ByteString) Source #

The most recent error message, if any.

Note: unlike the structured fields available via resultErrorField, the flat message text is formatted locally by the driver, so adapters are not expected to produce byte-identical strings.

socket :: c -> IO (Maybe Fd) Source #

The file descriptor of the connection socket.

backendPID :: c -> IO Int32 Source #

The process ID of the backend serving this connection.

connectionNeedsPassword :: c -> IO Bool Source #

Whether the connection authentication method required a password but none was available.

connectionUsedPassword :: c -> IO Bool Source #

Whether the connection authentication used a password.

exec :: c -> ByteString -> IO (Maybe (ResultOf c)) Source #

Submit a command and wait for the result.

execParams :: c -> ByteString -> [Maybe (Word32, ByteString, Format)] -> Format -> IO (Maybe (ResultOf c)) Source #

Submit a parameterized command. Each parameter is given as (type oid, value, format), or Nothing for SQL NULL. The final Format selects the result format.

prepare :: c -> ByteString -> ByteString -> Maybe [Word32] -> IO (Maybe (ResultOf c)) Source #

Prepare a named statement. The OID list, when supplied, fixes parameter types; Nothing leaves them to be inferred.

execPrepared :: c -> ByteString -> [Maybe (ByteString, Format)] -> Format -> IO (Maybe (ResultOf c)) Source #

Execute a previously prepared statement. Each parameter is (value, format), or Nothing for SQL NULL.

describePrepared :: c -> ByteString -> IO (Maybe (ResultOf c)) Source #

Describe a prepared statement.

describePortal :: c -> ByteString -> IO (Maybe (ResultOf c)) Source #

Describe a portal.

escapeStringConn :: c -> ByteString -> IO (Maybe ByteString) Source #

Escape a string for safe inclusion in an SQL literal.

escapeByteaConn :: c -> ByteString -> IO (Maybe ByteString) Source #

Escape binary data for use within a bytea literal.

escapeIdentifier :: c -> ByteString -> IO (Maybe ByteString) Source #

Escape a string for use as an SQL identifier (e.g. a table or column name), including the surrounding double quotes.

sendQuery :: c -> ByteString -> IO Bool Source #

Submit a command without waiting for the result.

sendQueryParams :: c -> ByteString -> [Maybe (Word32, ByteString, Format)] -> Format -> IO Bool Source #

Asynchronous execParams.

sendPrepare :: c -> ByteString -> ByteString -> Maybe [Word32] -> IO Bool Source #

Asynchronous prepare.

sendQueryPrepared :: c -> ByteString -> [Maybe (ByteString, Format)] -> Format -> IO Bool Source #

Asynchronous execPrepared.

sendDescribePrepared :: c -> ByteString -> IO Bool Source #

Asynchronous describePrepared.

sendDescribePortal :: c -> ByteString -> IO Bool Source #

Asynchronous describePortal.

getResult :: c -> IO (Maybe (ResultOf c)) Source #

Collect the next result from an asynchronous command.

consumeInput :: c -> IO Bool Source #

Read input from the server into the driver's buffer.

isBusy :: c -> IO Bool Source #

Whether a command is busy (a getResult would block).

setnonblocking :: c -> Bool -> IO Bool Source #

Set the non-blocking flag of the connection.

isnonblocking :: c -> IO Bool Source #

Whether the connection is in non-blocking mode.

setSingleRowMode :: c -> IO Bool Source #

Select single-row mode for the currently executing query.

flush :: c -> IO FlushStatus Source #

Flush queued output data to the server.

pipelineStatus :: c -> IO PipelineStatus Source #

Current pipeline-mode status.

enterPipelineMode :: c -> IO Bool Source #

Enter pipeline mode.

exitPipelineMode :: c -> IO Bool Source #

Leave pipeline mode.

pipelineSync :: c -> IO Bool Source #

Mark a synchronization point in a pipeline.

sendFlushRequest :: c -> IO Bool Source #

Request the server to flush its output buffer in pipeline mode.

getCancel :: c -> IO (Maybe (CancelOf c)) Source #

Obtain a cancellation handle for the connection.

notifies :: c -> IO (Maybe Notify) Source #

Return the next notification from the queue, if any.

disableNoticeReporting :: c -> IO () Source #

Stop accumulating notices for retrieval via getNotice.

enableNoticeReporting :: c -> IO () Source #

Start accumulating notices for retrieval via getNotice.

getNotice :: c -> IO (Maybe ByteString) Source #

Retrieve the next accumulated notice, if any.

putCopyData :: c -> ByteString -> IO CopyInResult Source #

Send data on a COPY FROM STDIN connection.

putCopyEnd :: c -> Maybe ByteString -> IO CopyInResult Source #

Signal the end of COPY FROM STDIN; Just aborts with the given error.

getCopyData :: c -> Bool -> IO CopyOutResult Source #

Receive data on a COPY TO STDOUT connection. The Bool selects non-blocking mode.

loCreat :: c -> IO (Maybe Word32) Source #

Create a new large object.

loCreate :: c -> Word32 -> IO (Maybe Word32) Source #

Create a new large object with the given OID.

loImport :: c -> FilePath -> IO (Maybe Word32) Source #

Import a file as a new large object.

loImportWithOid :: c -> FilePath -> Word32 -> IO (Maybe Word32) Source #

Import a file as a new large object with the given OID.

loExport :: c -> Word32 -> FilePath -> IO (Maybe ()) Source #

Export a large object to a file.

loOpen :: c -> Word32 -> IOMode -> IO (Maybe Int32) Source #

Open a large object.

loWrite :: c -> Int32 -> ByteString -> IO (Maybe Int) Source #

Write to an open large object.

loRead :: c -> Int32 -> Int -> IO (Maybe ByteString) Source #

Read from an open large object.

loSeek :: c -> Int32 -> SeekMode -> Int -> IO (Maybe Int) Source #

Seek within an open large object.

loTell :: c -> Int32 -> IO (Maybe Int) Source #

Report the current seek position of an open large object.

loTruncate :: c -> Int32 -> Int -> IO (Maybe ()) Source #

Truncate an open large object.

loClose :: c -> Int32 -> IO (Maybe ()) Source #

Close an open large object.

loUnlink :: c -> Word32 -> IO (Maybe ()) Source #

Remove a large object.

clientEncoding :: c -> IO ByteString Source #

The current client encoding name.

setClientEncoding :: c -> ByteString -> IO Bool Source #

Set the client encoding.

setErrorVerbosity :: c -> Verbosity -> IO Verbosity Source #

Set error verbosity, returning the previous setting.

class IsResult r where Source #

Result-accessor methods, independent of the connection type that produced the result. This allows row decoders and projection functions (such as observeResult in pqi-conformance) to operate on any result type without knowing the originating connection.

Minimal complete definition

resultStatus, resultErrorMessage, resultErrorField, unsafeFreeResult, ntuples, nfields, fname, fnumber, ftable, ftablecol, fformat, ftype, fmod, fsize, getvalue', getisnull, getlength, nparams, paramtype, cmdStatus, cmdTuples

Methods

resultStatus :: r -> IO ExecStatus Source #

The status of the result.

resultErrorMessage :: r -> IO (Maybe ByteString) Source #

The flat error message associated with the result, if any. Best-effort; see the note on errorMessage.

resultErrorField :: r -> FieldCode -> IO (Maybe ByteString) Source #

A single structured field of the result's error report.

unsafeFreeResult :: r -> IO () Source #

Free the result. Adapters that manage results with the garbage collector may implement this as a no-op; for the C-backed adapter it frees the underlying PGresult, after which the result must not be used.

ntuples :: r -> IO Int32 Source #

Number of rows (tuples) in the result.

nfields :: r -> IO Int32 Source #

Number of columns (fields) in the result.

fname :: r -> Int32 -> IO (Maybe ByteString) Source #

Name of the column at the given index.

fnumber :: r -> ByteString -> IO (Maybe Int32) Source #

Index of the column with the given name, if present.

ftable :: r -> Int32 -> IO Word32 Source #

OID of the table the given column was fetched from, or 0.

ftablecol :: r -> Int32 -> IO Int32 Source #

Column number (within its table) that the given result column was fetched from, or 0.

fformat :: r -> Int32 -> IO Format Source #

Format (text or binary) of the given column.

ftype :: r -> Int32 -> IO Word32 Source #

Data type OID of the given column.

fmod :: r -> Int32 -> IO Int Source #

Type modifier of the given column.

fsize :: r -> Int32 -> IO Int Source #

Server-side storage size of the given column's type, or a negative value for variable size.

getvalue :: r -> Int32 -> Int32 -> IO (Maybe ByteString) Source #

Value at (row, column), or Nothing for SQL NULL. Delegates to getvalue' by default in case the adapter provides a copying variant.

getvalue' :: r -> Int32 -> Int32 -> IO (Maybe ByteString) Source #

Like getvalue, but always returns a copy that remains valid after the result is freed.

getisnull :: r -> Int32 -> Int32 -> IO Bool Source #

Whether the value at (row, column) is SQL NULL.

getlength :: r -> Int32 -> Int32 -> IO Int Source #

Length in bytes of the value at (row, column).

nparams :: r -> IO Int32 Source #

Number of parameters of a prepared statement (for a describePrepared result).

paramtype :: r -> Int32 -> IO Word32 Source #

Data type OID of the given prepared-statement parameter.

cmdStatus :: r -> IO (Maybe ByteString) Source #

The command status tag of the result (e.g. "INSERT 0 1").

cmdTuples :: r -> IO (Maybe ByteString) Source #

The number of rows affected by the command, as text.

class IsCancel k where Source #

Cancellation of in-progress commands, isolated from the connection type.

Methods

cancel :: k -> IO (Either ByteString ()) Source #

Request cancellation of the in-progress command via the handle.

Shared types

data Format Source #

Format of a parameter or result column: textual or binary.

Constructors

Text
Binary

Instances

Instances details

Eq Format Source #
Instance details Defined in Pqi Methods (==) :: Format -> Format -> Bool # (/=) :: Format -> Format -> Bool #
Ord Format Source #
Instance details Defined in Pqi Methods compare :: Format -> Format -> Ordering # (<) :: Format -> Format -> Bool # (<=) :: Format -> Format -> Bool # (>) :: Format -> Format -> Bool # (>=) :: Format -> Format -> Bool # max :: Format -> Format -> Format # min :: Format -> Format -> Format #
Bounded Format Source #
Instance details Defined in Pqi Methods minBound :: Format # maxBound :: Format #
Enum Format Source #
Instance details Defined in Pqi Methods succ :: Format -> Format # pred :: Format -> Format # toEnum :: Int -> Format # fromEnum :: Format -> Int # enumFrom :: Format -> [Format] # enumFromThen :: Format -> Format -> [Format] # enumFromTo :: Format -> Format -> [Format] # enumFromThenTo :: Format -> Format -> Format -> [Format] #
Show Format Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> Format -> ShowS # show :: Format -> String # showList :: [Format] -> ShowS #

data ExecStatus Source #

Status of a command result, as reported by PQresultStatus.

Constructors

EmptyQuery	The string sent to the server was empty.
CommandOk	Successful completion of a command returning no data.
TuplesOk	Successful completion of a command returning data (such as a `SELECT` or `SHOW`).
CopyOut	Copy Out (from server) data transfer started.
CopyIn	Copy In (to server) data transfer started.
CopyBoth	Copy In/Out data transfer started.
BadResponse	The server's response was not understood.
NonfatalError	A nonfatal error (a notice or warning) occurred.
FatalError	A fatal error occurred.
SingleTuple	The `ResultOf` contains a single result tuple from the current command. This status occurs only when single-row mode has been selected for the query.
PipelineSync	The `ResultOf` represents a synchronization point in pipeline mode, requested by `pipelineSync`. This status occurs only in pipeline mode.
PipelineAbort	The `ResultOf` represents a pipeline that has received an error from the server. `getResult` must be called repeatedly, and each time it will return this status code until the end of the current pipeline, at which point it will return `PipelineSync` and normal processing can resume.

Instances

Instances details

Eq ExecStatus Source #
Instance details Defined in Pqi Methods (==) :: ExecStatus -> ExecStatus -> Bool # (/=) :: ExecStatus -> ExecStatus -> Bool #
Ord ExecStatus Source #
Instance details Defined in Pqi Methods compare :: ExecStatus -> ExecStatus -> Ordering # (<) :: ExecStatus -> ExecStatus -> Bool # (<=) :: ExecStatus -> ExecStatus -> Bool # (>) :: ExecStatus -> ExecStatus -> Bool # (>=) :: ExecStatus -> ExecStatus -> Bool # max :: ExecStatus -> ExecStatus -> ExecStatus # min :: ExecStatus -> ExecStatus -> ExecStatus #
Bounded ExecStatus Source #
Instance details Defined in Pqi Methods minBound :: ExecStatus # maxBound :: ExecStatus #
Enum ExecStatus Source #
Instance details Defined in Pqi Methods succ :: ExecStatus -> ExecStatus # pred :: ExecStatus -> ExecStatus # toEnum :: Int -> ExecStatus # fromEnum :: ExecStatus -> Int # enumFrom :: ExecStatus -> [ExecStatus] # enumFromThen :: ExecStatus -> ExecStatus -> [ExecStatus] # enumFromTo :: ExecStatus -> ExecStatus -> [ExecStatus] # enumFromThenTo :: ExecStatus -> ExecStatus -> ExecStatus -> [ExecStatus] #
Show ExecStatus Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> ExecStatus -> ShowS # show :: ExecStatus -> String # showList :: [ExecStatus] -> ShowS #

data ConnStatus Source #

Status of a connection, as reported by PQstatus.

Constructors

ConnectionOk	The connection is ready.
ConnectionBad	The connection procedure has failed.
ConnectionStarted	Waiting for connection to be made.
ConnectionMade	Connection OK; waiting to send.
ConnectionAwaitingResponse	Waiting for a response from the server.
ConnectionAuthOk	Received authentication; waiting for backend start-up to finish.
ConnectionSetEnv	Negotiating environment-driven parameter settings.
ConnectionSSLStartup	Negotiating SSL encryption.

Instances

Instances details

Eq ConnStatus Source #
Instance details Defined in Pqi Methods (==) :: ConnStatus -> ConnStatus -> Bool # (/=) :: ConnStatus -> ConnStatus -> Bool #
Ord ConnStatus Source #
Instance details Defined in Pqi Methods compare :: ConnStatus -> ConnStatus -> Ordering # (<) :: ConnStatus -> ConnStatus -> Bool # (<=) :: ConnStatus -> ConnStatus -> Bool # (>) :: ConnStatus -> ConnStatus -> Bool # (>=) :: ConnStatus -> ConnStatus -> Bool # max :: ConnStatus -> ConnStatus -> ConnStatus # min :: ConnStatus -> ConnStatus -> ConnStatus #
Bounded ConnStatus Source #
Instance details Defined in Pqi Methods minBound :: ConnStatus # maxBound :: ConnStatus #
Enum ConnStatus Source #
Instance details Defined in Pqi Methods succ :: ConnStatus -> ConnStatus # pred :: ConnStatus -> ConnStatus # toEnum :: Int -> ConnStatus # fromEnum :: ConnStatus -> Int # enumFrom :: ConnStatus -> [ConnStatus] # enumFromThen :: ConnStatus -> ConnStatus -> [ConnStatus] # enumFromTo :: ConnStatus -> ConnStatus -> [ConnStatus] # enumFromThenTo :: ConnStatus -> ConnStatus -> ConnStatus -> [ConnStatus] #
Show ConnStatus Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> ConnStatus -> ShowS # show :: ConnStatus -> String # showList :: [ConnStatus] -> ShowS #

data TransactionStatus Source #

Current in-transaction status of the server, as reported by PQtransactionStatus.

Constructors

TransIdle	Currently idle.
TransActive	A command is in progress.
TransInTrans	Idle, within a transaction block.
TransInError	Idle, within a failed transaction.
TransUnknown	Connection is bad.

Instances

Instances details

Eq TransactionStatus Source #
Instance details Defined in Pqi Methods (==) :: TransactionStatus -> TransactionStatus -> Bool # (/=) :: TransactionStatus -> TransactionStatus -> Bool #
Ord TransactionStatus Source #
Instance details Defined in Pqi Methods compare :: TransactionStatus -> TransactionStatus -> Ordering # (<) :: TransactionStatus -> TransactionStatus -> Bool # (<=) :: TransactionStatus -> TransactionStatus -> Bool # (>) :: TransactionStatus -> TransactionStatus -> Bool # (>=) :: TransactionStatus -> TransactionStatus -> Bool # max :: TransactionStatus -> TransactionStatus -> TransactionStatus # min :: TransactionStatus -> TransactionStatus -> TransactionStatus #
Bounded TransactionStatus Source #
Instance details Defined in Pqi Methods minBound :: TransactionStatus # maxBound :: TransactionStatus #
Enum TransactionStatus Source #
Instance details Defined in Pqi Methods succ :: TransactionStatus -> TransactionStatus # pred :: TransactionStatus -> TransactionStatus # toEnum :: Int -> TransactionStatus # fromEnum :: TransactionStatus -> Int # enumFrom :: TransactionStatus -> [TransactionStatus] # enumFromThen :: TransactionStatus -> TransactionStatus -> [TransactionStatus] # enumFromTo :: TransactionStatus -> TransactionStatus -> [TransactionStatus] # enumFromThenTo :: TransactionStatus -> TransactionStatus -> TransactionStatus -> [TransactionStatus] #
Show TransactionStatus Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> TransactionStatus -> ShowS # show :: TransactionStatus -> String # showList :: [TransactionStatus] -> ShowS #

data PollingStatus Source #

Result of a non-blocking connection-polling step.

Constructors

PollingFailed
PollingReading
PollingWriting
PollingOk

Instances

Instances details

Eq PollingStatus Source #
Instance details Defined in Pqi Methods (==) :: PollingStatus -> PollingStatus -> Bool # (/=) :: PollingStatus -> PollingStatus -> Bool #
Ord PollingStatus Source #
Instance details Defined in Pqi Methods compare :: PollingStatus -> PollingStatus -> Ordering # (<) :: PollingStatus -> PollingStatus -> Bool # (<=) :: PollingStatus -> PollingStatus -> Bool # (>) :: PollingStatus -> PollingStatus -> Bool # (>=) :: PollingStatus -> PollingStatus -> Bool # max :: PollingStatus -> PollingStatus -> PollingStatus # min :: PollingStatus -> PollingStatus -> PollingStatus #
Bounded PollingStatus Source #
Instance details Defined in Pqi Methods minBound :: PollingStatus # maxBound :: PollingStatus #
Enum PollingStatus Source #
Instance details Defined in Pqi Methods succ :: PollingStatus -> PollingStatus # pred :: PollingStatus -> PollingStatus # toEnum :: Int -> PollingStatus # fromEnum :: PollingStatus -> Int # enumFrom :: PollingStatus -> [PollingStatus] # enumFromThen :: PollingStatus -> PollingStatus -> [PollingStatus] # enumFromTo :: PollingStatus -> PollingStatus -> [PollingStatus] # enumFromThenTo :: PollingStatus -> PollingStatus -> PollingStatus -> [PollingStatus] #
Show PollingStatus Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> PollingStatus -> ShowS # show :: PollingStatus -> String # showList :: [PollingStatus] -> ShowS #

data PipelineStatus Source #

Pipeline-mode status of a connection, as reported by PQpipelineStatus.

Constructors

PipelineOn	The connection is in pipeline mode.
PipelineOff	The connection is not in pipeline mode.
PipelineAborted	The connection is in pipeline mode and an error occurred while processing the current pipeline.

Instances

Instances details

Eq PipelineStatus Source #
Instance details Defined in Pqi Methods (==) :: PipelineStatus -> PipelineStatus -> Bool # (/=) :: PipelineStatus -> PipelineStatus -> Bool #
Ord PipelineStatus Source #
Instance details Defined in Pqi Methods compare :: PipelineStatus -> PipelineStatus -> Ordering # (<) :: PipelineStatus -> PipelineStatus -> Bool # (<=) :: PipelineStatus -> PipelineStatus -> Bool # (>) :: PipelineStatus -> PipelineStatus -> Bool # (>=) :: PipelineStatus -> PipelineStatus -> Bool # max :: PipelineStatus -> PipelineStatus -> PipelineStatus # min :: PipelineStatus -> PipelineStatus -> PipelineStatus #
Bounded PipelineStatus Source #
Instance details Defined in Pqi Methods minBound :: PipelineStatus # maxBound :: PipelineStatus #
Enum PipelineStatus Source #
Instance details Defined in Pqi Methods succ :: PipelineStatus -> PipelineStatus # pred :: PipelineStatus -> PipelineStatus # toEnum :: Int -> PipelineStatus # fromEnum :: PipelineStatus -> Int # enumFrom :: PipelineStatus -> [PipelineStatus] # enumFromThen :: PipelineStatus -> PipelineStatus -> [PipelineStatus] # enumFromTo :: PipelineStatus -> PipelineStatus -> [PipelineStatus] # enumFromThenTo :: PipelineStatus -> PipelineStatus -> PipelineStatus -> [PipelineStatus] #
Show PipelineStatus Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> PipelineStatus -> ShowS # show :: PipelineStatus -> String # showList :: [PipelineStatus] -> ShowS #

data FieldCode Source #

Field identifier for the structured fields of an error report, as accepted by PQresultErrorField.

Constructors

DiagSeverity
DiagSqlstate
DiagMessagePrimary
DiagMessageDetail
DiagMessageHint
DiagStatementPosition
DiagInternalPosition
DiagInternalQuery
DiagContext
DiagSourceFile
DiagSourceLine
DiagSourceFunction

Instances

Instances details

Eq FieldCode Source #
Instance details Defined in Pqi Methods (==) :: FieldCode -> FieldCode -> Bool # (/=) :: FieldCode -> FieldCode -> Bool #
Ord FieldCode Source #
Instance details Defined in Pqi Methods compare :: FieldCode -> FieldCode -> Ordering # (<) :: FieldCode -> FieldCode -> Bool # (<=) :: FieldCode -> FieldCode -> Bool # (>) :: FieldCode -> FieldCode -> Bool # (>=) :: FieldCode -> FieldCode -> Bool # max :: FieldCode -> FieldCode -> FieldCode # min :: FieldCode -> FieldCode -> FieldCode #
Bounded FieldCode Source #
Instance details Defined in Pqi Methods minBound :: FieldCode # maxBound :: FieldCode #
Enum FieldCode Source #
Instance details Defined in Pqi Methods succ :: FieldCode -> FieldCode # pred :: FieldCode -> FieldCode # toEnum :: Int -> FieldCode # fromEnum :: FieldCode -> Int # enumFrom :: FieldCode -> [FieldCode] # enumFromThen :: FieldCode -> FieldCode -> [FieldCode] # enumFromTo :: FieldCode -> FieldCode -> [FieldCode] # enumFromThenTo :: FieldCode -> FieldCode -> FieldCode -> [FieldCode] #
Show FieldCode Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> FieldCode -> ShowS # show :: FieldCode -> String # showList :: [FieldCode] -> ShowS #

data Verbosity Source #

Verbosity of error reporting, as set by PQsetErrorVerbosity.

Constructors

ErrorsTerse
ErrorsDefault
ErrorsVerbose

Instances

Instances details

Eq Verbosity Source #
Instance details Defined in Pqi Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Ord Verbosity Source #
Instance details Defined in Pqi Methods compare :: Verbosity -> Verbosity -> Ordering # (<) :: Verbosity -> Verbosity -> Bool # (<=) :: Verbosity -> Verbosity -> Bool # (>) :: Verbosity -> Verbosity -> Bool # (>=) :: Verbosity -> Verbosity -> Bool # max :: Verbosity -> Verbosity -> Verbosity # min :: Verbosity -> Verbosity -> Verbosity #
Bounded Verbosity Source #
Instance details Defined in Pqi Methods minBound :: Verbosity # maxBound :: Verbosity #
Enum Verbosity Source #
Instance details Defined in Pqi Methods succ :: Verbosity -> Verbosity # pred :: Verbosity -> Verbosity # toEnum :: Int -> Verbosity # fromEnum :: Verbosity -> Int # enumFrom :: Verbosity -> [Verbosity] # enumFromThen :: Verbosity -> Verbosity -> [Verbosity] # enumFromTo :: Verbosity -> Verbosity -> [Verbosity] # enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity] #
Show Verbosity Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #

data FlushStatus Source #

Result of attempting to flush the output buffer in non-blocking mode.

Constructors

FlushOk
FlushFailed
FlushWriting

Instances

Instances details

Eq FlushStatus Source #
Instance details Defined in Pqi Methods (==) :: FlushStatus -> FlushStatus -> Bool # (/=) :: FlushStatus -> FlushStatus -> Bool #
Ord FlushStatus Source #
Instance details Defined in Pqi Methods compare :: FlushStatus -> FlushStatus -> Ordering # (<) :: FlushStatus -> FlushStatus -> Bool # (<=) :: FlushStatus -> FlushStatus -> Bool # (>) :: FlushStatus -> FlushStatus -> Bool # (>=) :: FlushStatus -> FlushStatus -> Bool # max :: FlushStatus -> FlushStatus -> FlushStatus # min :: FlushStatus -> FlushStatus -> FlushStatus #
Bounded FlushStatus Source #
Instance details Defined in Pqi Methods minBound :: FlushStatus # maxBound :: FlushStatus #
Enum FlushStatus Source #
Instance details Defined in Pqi Methods succ :: FlushStatus -> FlushStatus # pred :: FlushStatus -> FlushStatus # toEnum :: Int -> FlushStatus # fromEnum :: FlushStatus -> Int # enumFrom :: FlushStatus -> [FlushStatus] # enumFromThen :: FlushStatus -> FlushStatus -> [FlushStatus] # enumFromTo :: FlushStatus -> FlushStatus -> [FlushStatus] # enumFromThenTo :: FlushStatus -> FlushStatus -> FlushStatus -> [FlushStatus] #
Show FlushStatus Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> FlushStatus -> ShowS # show :: FlushStatus -> String # showList :: [FlushStatus] -> ShowS #

data CopyInResult Source #

Result of PQputCopyData/PQputCopyEnd.

Constructors

CopyInOk
CopyInError
CopyInWouldBlock

Instances

Instances details

Eq CopyInResult Source #
Instance details Defined in Pqi Methods (==) :: CopyInResult -> CopyInResult -> Bool # (/=) :: CopyInResult -> CopyInResult -> Bool #
Ord CopyInResult Source #
Instance details Defined in Pqi Methods compare :: CopyInResult -> CopyInResult -> Ordering # (<) :: CopyInResult -> CopyInResult -> Bool # (<=) :: CopyInResult -> CopyInResult -> Bool # (>) :: CopyInResult -> CopyInResult -> Bool # (>=) :: CopyInResult -> CopyInResult -> Bool # max :: CopyInResult -> CopyInResult -> CopyInResult # min :: CopyInResult -> CopyInResult -> CopyInResult #
Bounded CopyInResult Source #
Instance details Defined in Pqi Methods minBound :: CopyInResult # maxBound :: CopyInResult #
Enum CopyInResult Source #
Instance details Defined in Pqi Methods succ :: CopyInResult -> CopyInResult # pred :: CopyInResult -> CopyInResult # toEnum :: Int -> CopyInResult # fromEnum :: CopyInResult -> Int # enumFrom :: CopyInResult -> [CopyInResult] # enumFromThen :: CopyInResult -> CopyInResult -> [CopyInResult] # enumFromTo :: CopyInResult -> CopyInResult -> [CopyInResult] # enumFromThenTo :: CopyInResult -> CopyInResult -> CopyInResult -> [CopyInResult] #
Show CopyInResult Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> CopyInResult -> ShowS # show :: CopyInResult -> String # showList :: [CopyInResult] -> ShowS #

data CopyOutResult Source #

Result of PQgetCopyData.

Constructors

CopyOutRow ByteString
CopyOutWouldBlock
CopyOutDone
CopyOutError

Instances

Instances details

Eq CopyOutResult Source #
Instance details Defined in Pqi Methods (==) :: CopyOutResult -> CopyOutResult -> Bool # (/=) :: CopyOutResult -> CopyOutResult -> Bool #
Ord CopyOutResult Source #
Instance details Defined in Pqi Methods compare :: CopyOutResult -> CopyOutResult -> Ordering # (<) :: CopyOutResult -> CopyOutResult -> Bool # (<=) :: CopyOutResult -> CopyOutResult -> Bool # (>) :: CopyOutResult -> CopyOutResult -> Bool # (>=) :: CopyOutResult -> CopyOutResult -> Bool # max :: CopyOutResult -> CopyOutResult -> CopyOutResult # min :: CopyOutResult -> CopyOutResult -> CopyOutResult #
Show CopyOutResult Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> CopyOutResult -> ShowS # show :: CopyOutResult -> String # showList :: [CopyOutResult] -> ShowS #

data Notify Source #

An asynchronous notification, as returned by notifies.

Constructors

Notify
Fields relname :: ByteString bePid :: Int32 extra :: ByteString

Instances

Instances details

Eq Notify Source #
Instance details Defined in Pqi Methods (==) :: Notify -> Notify -> Bool # (/=) :: Notify -> Notify -> Bool #
Ord Notify Source #
Instance details Defined in Pqi Methods compare :: Notify -> Notify -> Ordering # (<) :: Notify -> Notify -> Bool # (<=) :: Notify -> Notify -> Bool # (>) :: Notify -> Notify -> Bool # (>=) :: Notify -> Notify -> Bool # max :: Notify -> Notify -> Notify # min :: Notify -> Notify -> Notify #
Show Notify Source #
Instance details Defined in Pqi Methods showsPrec :: Int -> Notify -> ShowS # show :: Notify -> String # showList :: [Notify] -> ShowS #

Connection-independent helpers

unescapeBytea :: ByteString -> ByteString Source #

Convert the textual representation of a bytea value, as produced by the server, back into raw bytes. Both the modern \x hex format (lowercase x only) and the legacy escape format are accepted.

Malformed input is tolerated exactly the way PQunescapeBytea tolerates it: in hex format, characters that are not hex digits (including whitespace) are silently skipped, and a hex digit whose pair character is invalid is dropped; in escape format, an invalid escape simply drops the backslash, and an octal escape must start with 0..3. Input is treated as a C string: the first NUL byte terminates processing.