Documentation

Hale.Hasql.Database.PostgreSQL.LibPQ

source
@[extern hale_pg_connect]
opaque Database.PostgreSQL.LibPQ.connect (conninfo : String) :
IO PgConn

Connect to a PostgreSQL database using a connection string. $$\text{connect} : \text{String} \to \text{IO}\ \text{PgConn}$$ The connection string follows libpq format: "host=localhost port=5432 dbname=mydb user=myuser" or a URI "postgresql://user:pass@host/db".

source
def Database.PostgreSQL.LibPQ.status (conn : PgConn) :
IO ConnStatus

Return the status of the connection. $$\text{status} : \text{PgConn} \to \text{IO}\ \text{ConnStatus}$$

Equations
Instances For
    source
    @[extern hale_pg_error_message]
    opaque Database.PostgreSQL.LibPQ.errorMessage (conn : PgConn) :
    IO String

    Return the error message most recently generated by a connection operation.

    source
    @[extern hale_pg_close]
    opaque Database.PostgreSQL.LibPQ.close (conn : PgConn) :
    IO Unit

    Close the connection immediately (before GC would finalize it).

    source
    @[extern hale_pg_exec]
    opaque Database.PostgreSQL.LibPQ.exec (conn : PgConn) (query : String) :
    IO PgResult

    Execute a simple SQL command (no parameters). $$\text{exec} : \text{PgConn} \to \text{String} \to \text{IO}\ \text{PgResult}$$

    source
    @[extern hale_pg_exec_params]
    opaque Database.PostgreSQL.LibPQ.execParams (conn : PgConn) (query : String) (params : Array (Option String)) :
    IO PgResult

    Execute a parameterized query. Parameters are passed as an array of optional strings (None = SQL NULL). $$\text{execParams} : \text{PgConn} \to \text{String} \to \text{Array}\ (\text{Option String}) \to \text{IO}\ \text{PgResult}$$

    source
    @[extern hale_pg_prepare]
    opaque Database.PostgreSQL.LibPQ.prepare (conn : PgConn) (stmtName query : String) :
    IO PgResult

    Prepare a named statement for later execution. $$\text{prepare} : \text{PgConn} \to \text{String} \to \text{String} \to \text{IO}\ \text{PgResult}$$

    source
    @[extern hale_pg_exec_prepared]
    opaque Database.PostgreSQL.LibPQ.execPrepared (conn : PgConn) (stmtName : String) (params : Array (Option String)) :
    IO PgResult

    Execute a previously prepared statement with the given parameters.

    source
    def Database.PostgreSQL.LibPQ.resultStatus (result : PgResult) :
    IO ExecStatus

    Return the result status of a query.

    Equations
    Instances For
      source
      @[extern hale_pg_result_error_message]
      opaque Database.PostgreSQL.LibPQ.resultErrorMessage (result : PgResult) :
      IO String

      Return the error message associated with a result, or empty string.

      source
      @[extern hale_pg_ntuples]
      opaque Database.PostgreSQL.LibPQ.ntuples (result : PgResult) :
      IO UInt32

      Return the number of rows in the result set.

      source
      @[extern hale_pg_nfields]
      opaque Database.PostgreSQL.LibPQ.nfields (result : PgResult) :
      IO UInt32

      Return the number of columns in the result set.

      source
      @[extern hale_pg_getvalue]
      opaque Database.PostgreSQL.LibPQ.getvalue (result : PgResult) (row col : UInt32) :
      IO String

      Return the value at the given row and column as a string.

      source
      @[extern hale_pg_getisnull]
      opaque Database.PostgreSQL.LibPQ.getIsNull (result : PgResult) (row col : UInt32) :
      IO Bool

      Return whether the value at the given position is NULL.

      source
      @[extern hale_pg_fname]
      opaque Database.PostgreSQL.LibPQ.fname (result : PgResult) (col : UInt32) :
      IO String

      Return the column name at the given index.

      source
      @[extern hale_pg_ftype]
      opaque Database.PostgreSQL.LibPQ.ftype (result : PgResult) (col : UInt32) :
      IO UInt32

      Return the OID of the column type at the given index.

      source
      @[extern hale_pg_cmd_tuples]
      opaque Database.PostgreSQL.LibPQ.cmdTuples (result : PgResult) :
      IO String

      Return the number of rows affected by the command (as a string).

      source
      @[extern hale_pg_escape_literal]
      opaque Database.PostgreSQL.LibPQ.escapeLiteral (conn : PgConn) (str : String) :
      IO String

      Escape a string for use as an SQL literal (adds quotes). $$\text{escapeLiteral} : \text{PgConn} \to \text{String} \to \text{IO}\ \text{String}$$

      source
      @[extern hale_pg_escape_identifier]
      opaque Database.PostgreSQL.LibPQ.escapeIdentifier (conn : PgConn) (str : String) :
      IO String

      Escape a string for use as an SQL identifier (adds double-quotes).

      source
      @[extern hale_pg_consume_input]
      opaque Database.PostgreSQL.LibPQ.consumeInput (conn : PgConn) :
      IO Bool

      Consume any available input from the server (non-blocking). Returns true if no error occurred.

      source
      @[extern hale_pg_notifies]
      opaque Database.PostgreSQL.LibPQ.notifies (conn : PgConn) :
      IO (Option PgNotification)

      Return the next notification from the server, if any.

      source
      def Database.PostgreSQL.LibPQ.transactionStatus (conn : PgConn) :
      IO TransactionStatus

      Return the current in-transaction status of the server.

      Equations
      Instances For
        source
        def Database.PostgreSQL.LibPQ.execCheck (conn : PgConn) (query : String) :
        IO PgResult

        Execute a query and check the result status. Throws IO.userError if the result indicates an error.

        Equations
        • One or more equations did not get rendered due to their size.
        Instances For
          source
          def Database.PostgreSQL.LibPQ.connectCheck (conninfo : String) :
          IO PgConn

          Connect and verify the connection is OK. Throws IO.userError if the connection failed.

          Equations
          • One or more equations did not get rendered due to their size.
          Instances For