Safe Haskell	Safe-Inferred
Language	Haskell2010

Database.DuckDB.Simple.Internal

Contents

Data constructors (internal use only)
Helpers

Description

This module provides access to the opaque data constructors and helper utilities required by the high-level API. It is not part of the supported public interface; consumers should depend on Simple instead.

Synopsis

newtype Query = Query {
- fromQuery :: Text
}
newtype Connection = Connection {
- connectionState :: IORef ConnectionState
}
data ConnectionState
- = ConnectionClosed
- | ConnectionOpen {
  - connectionDatabase :: DuckDBDatabase
  - connectionHandle :: DuckDBConnection
  }
data Statement = Statement {
}
data StatementState
- = StatementClosed
- | StatementOpen {
  - statementHandle :: DuckDBPreparedStatement
  }
data StatementStreamState
- = StatementStreamIdle
- | StatementStreamActive !StatementStream
data StatementStream = StatementStream {
- statementStreamResult :: Ptr DuckDBResult
- statementStreamColumns :: [StatementStreamColumn]
- statementStreamChunk :: Maybe StatementStreamChunk
}
data StatementStreamColumn = StatementStreamColumn {
- statementStreamColumnIndex :: Int
- statementStreamColumnName :: Text
- statementStreamColumnType :: DuckDBType
}
data StatementStreamChunk = StatementStreamChunk {
- statementStreamChunkPtr :: DuckDBDataChunk
- statementStreamChunkSize :: Int
- statementStreamChunkIndex :: Int
- statementStreamChunkVectors :: [StatementStreamChunkVector]
}
data StatementStreamChunkVector = StatementStreamChunkVector {
- statementStreamChunkVectorHandle :: DuckDBVector
- statementStreamChunkVectorData :: Ptr ()
- statementStreamChunkVectorValidity :: Ptr Word64
}
data SQLError = SQLError {
- sqlErrorMessage :: Text
- sqlErrorType :: Maybe DuckDBErrorType
- sqlErrorQuery :: Maybe Query
}
toSQLError :: Exception e => e -> SQLError
connectionClosedError :: SQLError
statementClosedError :: Statement -> SQLError
withConnectionHandle :: Connection -> (DuckDBConnection -> IO a) -> IO a
withStatementHandle :: Statement -> (DuckDBPreparedStatement -> IO a) -> IO a
withQueryCString :: Query -> (CString -> IO a) -> IO a

Data constructors (internal use only)

newtype Query Source #

Represents a textual SQL query with UTF-8 encoding semantics.

Constructors

Query
Fields fromQuery :: Text Extract the underlying textual representation of the query.

Instances

Instances details

IsString Query Source #
Instance details Defined in Database.DuckDB.Simple.Internal Methods fromString :: String -> Query #
Semigroup Query Source #
Instance details Defined in Database.DuckDB.Simple.Internal Methods (<>) :: Query -> Query -> Query # sconcat :: NonEmpty Query -> Query # stimes :: Integral b => b -> Query -> Query #
Show Query Source #
Instance details Defined in Database.DuckDB.Simple.Internal Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #
Eq Query Source #
Instance details Defined in Database.DuckDB.Simple.Internal Methods (==) :: Query -> Query -> Bool # (/=) :: Query -> Query -> Bool #
Ord Query Source #
Instance details Defined in Database.DuckDB.Simple.Internal Methods compare :: Query -> Query -> Ordering # (<) :: Query -> Query -> Bool # (<=) :: Query -> Query -> Bool # (>) :: Query -> Query -> Bool # (>=) :: Query -> Query -> Bool # max :: Query -> Query -> Query # min :: Query -> Query -> Query #

newtype Connection Source #

Tracks the lifetime of a DuckDB database and connection pair.

Constructors

Connection
Fields connectionState :: IORef ConnectionState

data ConnectionState Source #

Internal connection lifecycle state.

Constructors

ConnectionClosed
ConnectionOpen
Fields connectionDatabase :: DuckDBDatabase connectionHandle :: DuckDBConnection

data Statement Source #

Tracks the lifetime of a prepared statement.

Constructors

Statement
Fields statementState :: IORef StatementState statementConnection :: Connection statementQuery :: Query statementStream :: IORef StatementStreamState

data StatementState Source #

Internal statement lifecycle state.

Constructors

StatementClosed
StatementOpen
Fields statementHandle :: DuckDBPreparedStatement

data StatementStreamState Source #

Streaming execution state for prepared statements.

Constructors

StatementStreamIdle
StatementStreamActive !StatementStream

data StatementStream Source #

Streaming cursor backing an active result set.

Constructors

StatementStream
Fields statementStreamResult :: Ptr DuckDBResult statementStreamColumns :: [StatementStreamColumn] statementStreamChunk :: Maybe StatementStreamChunk

data StatementStreamColumn Source #

Metadata describing a result column surfaced through streaming.

Constructors

StatementStreamColumn
Fields statementStreamColumnIndex :: Int statementStreamColumnName :: Text statementStreamColumnType :: DuckDBType

data StatementStreamChunk Source #

Currently loaded data chunk plus iteration cursor.

Constructors

StatementStreamChunk
Fields statementStreamChunkPtr :: DuckDBDataChunk statementStreamChunkSize :: Int statementStreamChunkIndex :: Int statementStreamChunkVectors :: [StatementStreamChunkVector]

data StatementStreamChunkVector Source #

Raw vector pointers backing a chunk column.

Constructors

StatementStreamChunkVector
Fields statementStreamChunkVectorHandle :: DuckDBVector statementStreamChunkVectorData :: Ptr () statementStreamChunkVectorValidity :: Ptr Word64

data SQLError Source #

Represents an error reported by DuckDB or by duckdb-simple itself.

Constructors

SQLError
Fields sqlErrorMessage :: Text sqlErrorType :: Maybe DuckDBErrorType sqlErrorQuery :: Maybe Query

Instances

Instances details

Exception SQLError Source #
Instance details Defined in Database.DuckDB.Simple.Internal Methods toException :: SQLError -> SomeException # fromException :: SomeException -> Maybe SQLError # displayException :: SQLError -> String #
Show SQLError Source #
Instance details Defined in Database.DuckDB.Simple.Internal Methods showsPrec :: Int -> SQLError -> ShowS # show :: SQLError -> String # showList :: [SQLError] -> ShowS #
Eq SQLError Source #
Instance details Defined in Database.DuckDB.Simple.Internal Methods (==) :: SQLError -> SQLError -> Bool # (/=) :: SQLError -> SQLError -> Bool #

toSQLError :: Exception e => e -> SQLError Source #

Helpers

connectionClosedError :: SQLError Source #

Shared error value used when an operation targets a closed connection.

statementClosedError :: Statement -> SQLError Source #

Shared error value used when an operation targets a closed statement.

withConnectionHandle :: Connection -> (DuckDBConnection -> IO a) -> IO a Source #

Internal helper for safely accessing the underlying connection handle.

withStatementHandle :: Statement -> (DuckDBPreparedStatement -> IO a) -> IO a Source #

Internal helper for safely accessing the underlying prepared statement.

withQueryCString :: Query -> (CString -> IO a) -> IO a Source #

Provide a UTF-8 encoded C string view of the query text.