Documentation

Fields

• runStmt :: Text -> [Param] -> IO (Int, [[SqlValue]])

  Execute an SQL statement.

• runStmtWithPK :: Text -> [Param] -> IO Int

  Execute an SQL statement and return the last inserted primary key, where the primary key is auto-incrementing. Backends must take special care to make this thread-safe.

• prepareStmt :: StmtID -> [SqlTypeRep] -> Text -> IO Dynamic

  Prepare a statement using the given statement identifier.

• runPrepared :: Dynamic -> [Param] -> IO (Int, [[SqlValue]])

  Execute a prepared statement.

• getTableInfo :: TableName -> IO TableInfo

  Get a list of all columns in the given table, with the type and any modifiers for each column. Return an empty list if the given table does not exist.

• ppConfig :: PPConfig

  SQL pretty-printer configuration.

• closeConnection :: SeldaConnection b -> IO ()

  Close the currently open connection.

• backendId :: BackendID

  Unique identifier for this backend.

• disableForeignKeys :: Bool -> IO ()

  Turn on or off foreign key checking, and initiate/commit a transaction.

  When implementing this function, it is safe to assume that disableForeignKeys True will always be called exactly once before each disableForeignKeys False.

Fields

• connBackend :: !(SeldaBackend b)

  The backend used by the current connection.

• connDbId :: Text

  A string uniquely identifying the database used by this connection. This could be, for instance, a PostgreSQL connection string or the absolute path to an SQLite file.

• connStmts :: !(IORef (IntMap SeldaStmt))

  All statements prepared for this connection.

• connClosed :: !(IORef Bool)

  Is the connection closed?

• connLock :: !(MVar ())

  Lock to prevent this connection from being used concurrently by multiple invocations of runSeldaT.

Fields

• stmtHandle :: !Dynamic

  Backend-specific handle to the prepared statement.

• stmtText :: !Text

  The SQL code for the statement.

• stmtParams :: ![Either Int Param]

  All parameters to be passed to the prepared statement. Parameters that are unique to each invocation are specified as indices starting at 0. Backends implementing runPrepared should probably ignore this field.

Fields

• unS :: StateT (SeldaConnection b) m a
   

Fields

• ppType :: SqlTypeRep -> Text

  The SQL type name of the given type.

  This function should be used everywhere a type is needed to be printed but in primary keys position. This is due to the fact that some backends might have a special representation of primary keys (using sequences are such). If you have such a need, please use the ppTypePK record instead.

• ppTypeHook :: SqlTypeRep -> [ColAttr] -> (SqlTypeRep -> Text) -> Text

  Hook that allows you to modify ppType output.

• ppTypePK :: SqlTypeRep -> Text

  The SQL type name of the given type for primary keys uses.

• ppPlaceholder :: Int -> Text

  Parameter placeholder for the nth parameter.

• ppColAttrs :: [ColAttr] -> Text

  List of column attributes.

• ppColAttrsHook :: SqlTypeRep -> [ColAttr] -> ([ColAttr] -> Text) -> Text

  Hook that allows you to modify ppColAttrs output.

• ppAutoIncInsert :: Text

  The value used for the next value for an auto-incrementing column. For instance, DEFAULT for PostgreSQL, and NULL for SQLite.

• ppMaxInsertParams :: Maybe Int

  Insert queries may have at most this many parameters; if an insertion has more parameters than this, it will be chunked.

  Note that only insertions of multiple rows are chunked. If your table has more than this many columns, you should really rethink your database design.

• ppIndexMethodHook :: IndexMethod -> Text

  CREATE INDEX suffix to indicate that the index should use the given index method.

Fields

• tableColumnInfos :: [ColumnInfo]

  Ordered information about each table column.

• tableUniqueGroups :: [[ColName]]

  Unordered list of all (non-PK) uniqueness constraints on this table.

• tablePrimaryKey :: [ColName]

  Unordered list of all primary key constraints on this table.

Fields

• colName :: ColName

  Name of the column.

• colType :: Either Text SqlTypeRep

  Selda type of the column, or the type name given by the database if Selda couldn't make sense of the type.

• colIsAutoPrimary :: Bool

  Is the given column auto-incrementing?

• colIsNullable :: Bool

  Can the column be NULL?

• colHasIndex :: Bool

  Is the column explicitly indexed (i.e. using indexed)?

• colFKs :: [(TableName, ColName)]

  Any foreign key (table, column) pairs referenced by this column.