Fields

• name :: Text

  A short identifier for the adapter (e.g. "pqi-ffi"), for use in test descriptions, logs, and error messages.

• connectdb :: ByteString -> IO Connection

  Connect to a database, as PQconnectdb.

• connectStart :: ByteString -> IO Connection

  Begin connecting to a database asynchronously, as PQconnectStart.

• newNullConnection :: IO Connection

  The null-sentinel connection, as PQnewNullConnection.

• unescapeBytea :: ByteString -> IO (Maybe ByteString)

  Convert the textual representation of a bytea value, as produced by the server, back into raw bytes, as PQunescapeBytea.

Fields

• connectPoll :: IO PollingStatus

  Drive an asynchronous connection attempt forward.

• isNullConnection :: Bool

  Whether the connection is the null sentinel.

• finish :: IO ()

  Close the connection and release its resources.

• reset :: IO ()

  Reset the communication channel to the server (blocking).

• resetStart :: IO Bool

  Begin resetting the connection asynchronously.

• resetPoll :: IO PollingStatus

  Drive an asynchronous reset forward.

• db :: IO (Maybe ByteString)

  The database name of the connection.

• user :: IO (Maybe ByteString)

  The user name of the connection.

• pass :: IO (Maybe ByteString)

  The password of the connection.

• host :: IO (Maybe ByteString)

  The server host name of the connection.

• port :: IO (Maybe ByteString)

  The port of the connection.

• options :: IO (Maybe ByteString)

  The command-line options passed in the connection request.

• status :: IO ConnStatus

  Current connection status.

• transactionStatus :: IO TransactionStatus

  Current in-transaction status of the server.

• parameterStatus :: ByteString -> IO (Maybe ByteString)

  Look up a current parameter setting reported by the server.

• protocolVersion :: IO Int

  The frontend/backend protocol version.

• serverVersion :: IO Int

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

• errorMessage :: IO (Maybe ByteString)

  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 :: IO (Maybe Fd)

  The file descriptor of the connection socket.

• backendPID :: IO Int32

  The process ID of the backend serving this connection.

• connectionNeedsPassword :: IO Bool

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

• connectionUsedPassword :: IO Bool

  Whether the connection authentication used a password.

• exec :: ByteString -> IO (Maybe Result)

  Submit a command and wait for the result.

• execParams :: ByteString -> [Maybe (Word32, ByteString, Format)] -> Format -> IO (Maybe Result)

  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 :: ByteString -> ByteString -> Maybe [Word32] -> IO (Maybe Result)

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

• execPrepared :: ByteString -> [Maybe (ByteString, Format)] -> Format -> IO (Maybe Result)

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

• describePrepared :: ByteString -> IO (Maybe Result)

  Describe a prepared statement.

• describePortal :: ByteString -> IO (Maybe Result)

  Describe a portal.

• escapeStringConn :: ByteString -> IO (Maybe ByteString)

  Escape a string for safe inclusion in an SQL literal.

• escapeByteaConn :: ByteString -> IO (Maybe ByteString)

  Escape binary data for use within a bytea literal.

• escapeIdentifier :: ByteString -> IO (Maybe ByteString)

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

• sendQuery :: ByteString -> IO Bool

  Submit a command without waiting for the result.

• sendQueryParams :: ByteString -> [Maybe (Word32, ByteString, Format)] -> Format -> IO Bool

  Asynchronous execParams.

• sendPrepare :: ByteString -> ByteString -> Maybe [Word32] -> IO Bool

  Asynchronous prepare.

• sendQueryPrepared :: ByteString -> [Maybe (ByteString, Format)] -> Format -> IO Bool

  Asynchronous execPrepared.

• sendDescribePrepared :: ByteString -> IO Bool

  Asynchronous describePrepared.

• sendDescribePortal :: ByteString -> IO Bool

  Asynchronous describePortal.

• getResult :: IO (Maybe Result)

  Collect the next result from an asynchronous command.

• consumeInput :: IO Bool

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

• isBusy :: IO Bool

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

• setnonblocking :: Bool -> IO Bool

  Set the non-blocking flag of the connection.

• isnonblocking :: IO Bool

  Whether the connection is in non-blocking mode.

• setSingleRowMode :: IO Bool

  Select single-row mode for the currently executing query.

• flush :: IO FlushStatus

  Flush queued output data to the server.

• pipelineStatus :: IO PipelineStatus

  Current pipeline-mode status.

• enterPipelineMode :: IO Bool

  Enter pipeline mode.

• exitPipelineMode :: IO Bool

  Leave pipeline mode.

• pipelineSync :: IO Bool

  Mark a synchronization point in a pipeline.

• sendFlushRequest :: IO Bool

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

• getCancel :: IO (Maybe Cancel)

  Obtain a cancellation handle for the connection.

• notifies :: IO (Maybe Notify)

  Return the next notification from the queue, if any.

• disableNoticeReporting :: IO ()

  Stop accumulating notices for retrieval via getNotice.

• enableNoticeReporting :: IO ()

  Start accumulating notices for retrieval via getNotice.

• getNotice :: IO (Maybe ByteString)

  Retrieve the next accumulated notice, if any.

• putCopyData :: ByteString -> IO CopyInResult

  Send data on a COPY FROM STDIN connection.

• putCopyEnd :: Maybe ByteString -> IO CopyInResult

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

• getCopyData :: Bool -> IO CopyOutResult

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

• loCreat :: IO (Maybe Word32)

  Create a new large object.

• loCreate :: Word32 -> IO (Maybe Word32)

  Create a new large object with the given OID.

• loImport :: FilePath -> IO (Maybe Word32)

  Import a file as a new large object.

• loImportWithOid :: FilePath -> Word32 -> IO (Maybe Word32)

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

• loExport :: Word32 -> FilePath -> IO (Maybe ())

  Export a large object to a file.

• loOpen :: Word32 -> IOMode -> IO (Maybe Int32)

  Open a large object.

• loWrite :: Int32 -> ByteString -> IO (Maybe Int)

  Write to an open large object.

• loRead :: Int32 -> Int -> IO (Maybe ByteString)

  Read from an open large object.

• loSeek :: Int32 -> SeekMode -> Int -> IO (Maybe Int)

  Seek within an open large object.

• loTell :: Int32 -> IO (Maybe Int)

  Report the current seek position of an open large object.

• loTruncate :: Int32 -> Int -> IO (Maybe ())

  Truncate an open large object.

• loClose :: Int32 -> IO (Maybe ())

  Close an open large object.

• loUnlink :: Word32 -> IO (Maybe ())

  Remove a large object.

• clientEncoding :: IO ByteString

  The current client encoding name.

• setClientEncoding :: ByteString -> IO Bool

  Set the client encoding.

• setErrorVerbosity :: Verbosity -> IO Verbosity

  Set error verbosity, returning the previous setting.

Fields

• resultStatus :: IO ExecStatus

  The status of the result.

• resultErrorMessage :: IO (Maybe ByteString)

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

• resultErrorField :: FieldCode -> IO (Maybe ByteString)

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

• unsafeFreeResult :: IO ()

  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 :: IO Int32

  Number of rows (tuples) in the result.

• nfields :: IO Int32

  Number of columns (fields) in the result.

• fname :: Int32 -> IO (Maybe ByteString)

  Name of the column at the given index.

• fnumber :: ByteString -> IO (Maybe Int32)

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

• ftable :: Int32 -> IO Word32

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

• ftablecol :: Int32 -> IO Int32

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

• fformat :: Int32 -> IO Format

  Format (text or binary) of the given column.

• ftype :: Int32 -> IO Word32

  Data type OID of the given column.

• fmod :: Int32 -> IO Int

  Type modifier of the given column.

• fsize :: Int32 -> IO Int

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

• getvalue :: Int32 -> Int32 -> IO (Maybe ByteString)

  Value at (row, column), or Nothing for SQL NULL. In the old class-based API this delegated to getvalue' by default; since a record has no notion of default methods, adapters that want that behaviour should set this field to the same closure as getvalue' when constructing the Result.

• getvalue' :: Int32 -> Int32 -> IO (Maybe ByteString)

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

• getisnull :: Int32 -> Int32 -> IO Bool

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

• getlength :: Int32 -> Int32 -> IO Int

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

• nparams :: IO Int32

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

• paramtype :: Int32 -> IO Word32

  Data type OID of the given prepared-statement parameter.

• cmdStatus :: IO (Maybe ByteString)

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

• cmdTuples :: IO (Maybe ByteString)

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

Fields

• cancel :: IO (Either ByteString ())

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

Fields

• relname :: ByteString
   
• bePid :: Int32
   
• extra :: ByteString