Added Large objects (LOB) functionality (#51)

* Fixed getServerVersion function

* Improved haddock documentation #11

* Pushing haddock coverage to 100%

* Added support for large objects

* Added FromField Instances and removed LOB type

* Applied formolu

* Added withLOB function

* Added haddock documentation for LOB

* Added test cases for LOB

oracle-simple.cabal

@@ -41,6 +41,7 @@ library
       Database.Oracle.Simple.Transaction
       Database.Oracle.Simple.Queue
       Database.Oracle.Simple.Object
+      Database.Oracle.Simple.LOB
   hs-source-dirs:
       src
   c-sources:

src/Database/Oracle/Simple.hs

@@ -57,6 +57,7 @@ module Database.Oracle.Simple
 
     -- * Miscellaneous
   , module Export
+  , module LOB
   ) where
 
 import Database.Oracle.Simple.Execute as Execute
@@ -108,6 +109,7 @@ import Database.Oracle.Simple.Queue as Queue
 import Database.Oracle.Simple.ToField as ToField
 import Database.Oracle.Simple.ToRow as ToRow
 import Database.Oracle.Simple.Transaction as Transaction
+import Database.Oracle.Simple.LOB as LOB
 
 -- $use
 -- This library provides a 'Query' type and a parameter substitution
@@ -182,4 +184,4 @@ import Database.Oracle.Simple.Transaction as Transaction
 -- >   
 -- >   print mPayload
 -- >   queueRelease queue
---
+--

src/Database/Oracle/Simple/FromField.hs

@@ -15,6 +15,7 @@ module Database.Oracle.Simple.FromField
     getString,
     getBool,
     getTimestamp,
+    getLOB_,
   )
 where
 
@@ -94,6 +95,17 @@ instance FromField Time.UTCTime where
   fromDPINativeType _ = DPI_NATIVE_TYPE_TIMESTAMP
   fromField = dpiTimeStampToUTCTime <$> fromField
 
+instance FromField DPILob where
+  fromDPINativeType _ = DPI_NATIVE_TYPE_LOB
+  fromField = FieldParser getLOB_
+
+-- Question: For large object should the type be lazy bytestring
+foreign import ccall "dpiData_getLOB"
+  dpiData_getLOB :: Ptr (DPIData ReadBuffer) -> IO DPILob
+
+getLOB_ :: ReadDPIBuffer DPILob
+getLOB_ = dpiData_getLOB 
+
 -- | Converts a 'DPITimestamp' to a 'Time.UTCTime'.
 -- This function is useful for working with timestamps in Haskell's time library.
 dpiTimeStampToUTCTime :: DPITimestamp -> Time.UTCTime

src/Database/Oracle/Simple/Internal.hs

@@ -29,6 +29,7 @@ module Database.Oracle.Simple.Internal
     DPIModeExec (..),
     DPIConn (..),
     DPIContext (..),
+    DPILob (..),
     DPITimestamp (..),
     DPIOracleType (..),
     DPICommonCreateParams (..),
@@ -78,6 +79,7 @@ module Database.Oracle.Simple.Internal
     dpiConn_close_finalizer,
     dpiConn_release_finalizer,
     dpiNativeTypeToUInt,
+    dpiOracleTypeToUInt,
   )
 where
 
@@ -133,6 +135,10 @@ newtype DPIShardingKeyColumn = DPIShardingKeyColumn (Ptr DPIShardingKeyColumn)
   deriving (Show, Eq)
   deriving newtype (Storable)
 
+newtype DPILob = DPILob (Ptr DPILob)
+  deriving (Show, Eq)
+  deriving newtype (Storable)
+
 -- | Represents additional parameters for creating a connection pool.
 -- The 'AdditionalConnectionParams' data type includes settings such as session counts,
 -- timeouts, and modes.