Show (Future a) Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods showsPrec :: Int -> Future a -> ShowS # show :: Future a -> String # showList :: [Future a] -> ShowS #
Storable (Future a) Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods sizeOf :: Future a -> Int # alignment :: Future a -> Int # peekElemOff :: Ptr (Future a) -> Int -> IO (Future a) # pokeElemOff :: Ptr (Future a) -> Int -> Future a -> IO () # peekByteOff :: Ptr b -> Int -> IO (Future a) # pokeByteOff :: Ptr b -> Int -> Future a -> IO () # peek :: Ptr (Future a) -> IO (Future a) # poke :: Ptr (Future a) -> Future a -> IO () #

futureCancel :: Future a -> IO () Source #

futureDestroy :: Future a -> IO () Source #

futureDestroyPtr :: FunPtr (Ptr a -> IO ()) Source #

futureBlockUntilReady :: Future a -> IO CFDBError Source #

futureIsReady :: Future a -> IO Bool Source #

futureReleaseMemory :: Future a -> IO () Source #

futureGetError :: Future a -> IO CFDBError Source #

futureGetInt64 :: Future Int64 -> IO (CFDBError, Int64) Source #

futureGetKey :: Future ByteString -> IO (Either CFDBError ByteString) Source #

futureGetValue :: Future (Maybe ByteString) -> IO (Either CFDBError (Maybe ByteString)) Source #

futureGetStringArray :: Future [ByteString] -> IO (Either CFDBError [ByteString]) Source #

data FDBKeyValue Source #

Constructors

FDBKeyValue
Fields key :: Ptr () key_length :: Int value :: Ptr () value_length :: Int

Instances

Instances details

Eq FDBKeyValue Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods (==) :: FDBKeyValue -> FDBKeyValue -> Bool # (/=) :: FDBKeyValue -> FDBKeyValue -> Bool #
Show FDBKeyValue Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods showsPrec :: Int -> FDBKeyValue -> ShowS # show :: FDBKeyValue -> String # showList :: [FDBKeyValue] -> ShowS #
Storable FDBKeyValue Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods sizeOf :: FDBKeyValue -> Int # alignment :: FDBKeyValue -> Int # peekElemOff :: Ptr FDBKeyValue -> Int -> IO FDBKeyValue # pokeElemOff :: Ptr FDBKeyValue -> Int -> FDBKeyValue -> IO () # peekByteOff :: Ptr b -> Int -> IO FDBKeyValue # pokeByteOff :: Ptr b -> Int -> FDBKeyValue -> IO () # peek :: Ptr FDBKeyValue -> IO FDBKeyValue # poke :: Ptr FDBKeyValue -> FDBKeyValue -> IO () #

futureGetKeyValueArray :: Future [(ByteString, ByteString)] -> IO (Either CFDBError ([(ByteString, ByteString)], Bool)) Source #

Database

data DatabasePtr Source #

Handle to the underlying C API client state.

Instances

Instances details

Eq DatabasePtr Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods (==) :: DatabasePtr -> DatabasePtr -> Bool # (/=) :: DatabasePtr -> DatabasePtr -> Bool #
Show DatabasePtr Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods showsPrec :: Int -> DatabasePtr -> ShowS # show :: DatabasePtr -> String # showList :: [DatabasePtr] -> ShowS #
Storable DatabasePtr Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods sizeOf :: DatabasePtr -> Int # alignment :: DatabasePtr -> Int # peekElemOff :: Ptr DatabasePtr -> Int -> IO DatabasePtr # pokeElemOff :: Ptr DatabasePtr -> Int -> DatabasePtr -> IO () # peekByteOff :: Ptr b -> Int -> IO DatabasePtr # pokeByteOff :: Ptr b -> Int -> DatabasePtr -> IO () # peek :: Ptr DatabasePtr -> IO DatabasePtr # poke :: Ptr DatabasePtr -> DatabasePtr -> IO () #

createDatabase :: String -> IO (CFDBError, DatabasePtr) Source #

databaseDestroy :: DatabasePtr -> IO () Source #

databaseSetOption :: DatabasePtr -> DatabaseOption -> IO CFDBError Source #

databaseCreateTransaction :: DatabasePtr -> IO (CFDBError, Transaction) Source #

Transaction

newtype Transaction Source #

Constructors

Transaction (Ptr Transaction)

Instances

Instances details

Show Transaction Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods showsPrec :: Int -> Transaction -> ShowS # show :: Transaction -> String # showList :: [Transaction] -> ShowS #
Storable Transaction Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods sizeOf :: Transaction -> Int # alignment :: Transaction -> Int # peekElemOff :: Ptr Transaction -> Int -> IO Transaction # pokeElemOff :: Ptr Transaction -> Int -> Transaction -> IO () # peekByteOff :: Ptr b -> Int -> IO Transaction # pokeByteOff :: Ptr b -> Int -> Transaction -> IO () # peek :: Ptr Transaction -> IO Transaction # poke :: Ptr Transaction -> Transaction -> IO () #

data KeySelector Source #

Specifies a key in the database. See the official docs for more information. These can be supplied to getKey or used to build a Range.

Constructors

LastLessThan ByteString	Selects the lexicographically greatest key less than the specified key.
LastLessOrEq ByteString	Selects the lexicographically greatest less than or equal to the specified key.
FirstGreaterThan ByteString	Selects the lexicographically least key greater than the specified key.
FirstGreaterOrEq ByteString	Selects the lexicographically least key greater than or equal to the specified key.
WithOffset Int KeySelector	offsets a key selector. Using `offset` is preferred, since it handles normalization to prevent nested `WithOffset`s.

Instances

Instances details

Eq KeySelector Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods (==) :: KeySelector -> KeySelector -> Bool # (/=) :: KeySelector -> KeySelector -> Bool #
Ord KeySelector Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods compare :: KeySelector -> KeySelector -> Ordering # (<) :: KeySelector -> KeySelector -> Bool # (<=) :: KeySelector -> KeySelector -> Bool # (>) :: KeySelector -> KeySelector -> Bool # (>=) :: KeySelector -> KeySelector -> Bool # max :: KeySelector -> KeySelector -> KeySelector # min :: KeySelector -> KeySelector -> KeySelector #
Show KeySelector Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods showsPrec :: Int -> KeySelector -> ShowS # show :: KeySelector -> String # showList :: [KeySelector] -> ShowS #

keySelectorBytes :: KeySelector -> ByteString Source #

keySelectorTuple :: KeySelector -> (ByteString, Bool, Int) Source #

Convert a KeySelector to its or_equal, offset settings. Equivalent to the macros FDB_KEYSEL_LAST_LESS_THAN etc.

tupleKeySelector :: (ByteString, Bool, Int) -> KeySelector Source #

Inverse of keySelectorTuple

transactionDestroy :: Transaction -> IO () Source #

transactionDestroyPtr :: FunPtr (Ptr a -> IO ()) Source #

transactionSetOption :: Transaction -> TransactionOption -> IO CFDBError Source #

transactionSetReadVersion :: Transaction -> Int64 -> IO () Source #

transactionGetReadVersion :: Transaction -> IO (Future Int64) Source #

transactionGet :: Transaction -> ByteString -> Bool -> IO (Future (Maybe ByteString)) Source #

transactionGetKey :: Transaction -> ByteString -> Bool -> Int -> Bool -> IO (Future ByteString) Source #

transactionGetAddressesForKey :: Transaction -> ByteString -> IO (Future [ByteString]) Source #

transactionGetRange Source #

Arguments

:: Transaction
-> KeySelector	begin
-> KeySelector	end
-> Int	max number of pairs to return
-> Int	max number of bytes to return
-> FDBStreamingMode
-> Int	if FDBStreamingMode is FdbStreamingModeIterator, start this at 1 and increment by for each successive call reading this range. Otherwise, ignored.
-> Bool	isSnapshotRead
-> Bool	whether to return pairs in reverse order
-> IO (Future [(ByteString, ByteString)])

data FDBStreamingMode Source #

Constructors

StreamingModeWantAll
StreamingModeIterator
StreamingModeExact
StreamingModeSmall
StreamingModeMedium
StreamingModeLarge
StreamingModeSerial

Instances

Instances details

Bounded FDBStreamingMode Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods minBound :: FDBStreamingMode # maxBound :: FDBStreamingMode #
Enum FDBStreamingMode Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods succ :: FDBStreamingMode -> FDBStreamingMode # pred :: FDBStreamingMode -> FDBStreamingMode # toEnum :: Int -> FDBStreamingMode # fromEnum :: FDBStreamingMode -> Int # enumFrom :: FDBStreamingMode -> [FDBStreamingMode] # enumFromThen :: FDBStreamingMode -> FDBStreamingMode -> [FDBStreamingMode] # enumFromTo :: FDBStreamingMode -> FDBStreamingMode -> [FDBStreamingMode] # enumFromThenTo :: FDBStreamingMode -> FDBStreamingMode -> FDBStreamingMode -> [FDBStreamingMode] #
Eq FDBStreamingMode Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods (==) :: FDBStreamingMode -> FDBStreamingMode -> Bool # (/=) :: FDBStreamingMode -> FDBStreamingMode -> Bool #
Ord FDBStreamingMode Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods compare :: FDBStreamingMode -> FDBStreamingMode -> Ordering # (<) :: FDBStreamingMode -> FDBStreamingMode -> Bool # (<=) :: FDBStreamingMode -> FDBStreamingMode -> Bool # (>) :: FDBStreamingMode -> FDBStreamingMode -> Bool # (>=) :: FDBStreamingMode -> FDBStreamingMode -> Bool # max :: FDBStreamingMode -> FDBStreamingMode -> FDBStreamingMode # min :: FDBStreamingMode -> FDBStreamingMode -> FDBStreamingMode #
Show FDBStreamingMode Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods showsPrec :: Int -> FDBStreamingMode -> ShowS # show :: FDBStreamingMode -> String # showList :: [FDBStreamingMode] -> ShowS #

transactionSet :: Transaction -> ByteString -> ByteString -> IO () Source #

transactionClear :: Transaction -> ByteString -> IO () Source #

transactionClearRange :: Transaction -> ByteString -> ByteString -> IO () Source #

transactionAtomicOp Source #

Arguments

:: Transaction
-> ByteString	key
-> MutationType
-> IO ()

transactionCommit :: Transaction -> IO (Future ()) Source #

transactionGetCommittedVersion :: Transaction -> IO (CFDBError, Int) Source #

transactionGetApproximateSize :: Transaction -> IO (Future Int64) Source #

transactionGetVersionstamp :: Transaction -> IO (Future ByteString) Source #

transactionWatch :: Transaction -> ByteString -> IO (Future ()) Source #

transactionOnError :: Transaction -> CFDBError -> IO (Future ()) Source #

transactionReset :: Transaction -> IO () Source #

transactionCancel :: Transaction -> IO () Source #

transactionAddConflictRange :: Transaction -> ByteString -> ByteString -> FDBConflictRangeType -> IO CFDBError Source #

data FDBConflictRangeType Source #

Constructors

ConflictRangeTypeRead
ConflictRangeTypeWrite

Instances

Instances details

Enum FDBConflictRangeType Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods succ :: FDBConflictRangeType -> FDBConflictRangeType # pred :: FDBConflictRangeType -> FDBConflictRangeType # toEnum :: Int -> FDBConflictRangeType # fromEnum :: FDBConflictRangeType -> Int # enumFrom :: FDBConflictRangeType -> [FDBConflictRangeType] # enumFromThen :: FDBConflictRangeType -> FDBConflictRangeType -> [FDBConflictRangeType] # enumFromTo :: FDBConflictRangeType -> FDBConflictRangeType -> [FDBConflictRangeType] # enumFromThenTo :: FDBConflictRangeType -> FDBConflictRangeType -> FDBConflictRangeType -> [FDBConflictRangeType] #
Eq FDBConflictRangeType Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods (==) :: FDBConflictRangeType -> FDBConflictRangeType -> Bool # (/=) :: FDBConflictRangeType -> FDBConflictRangeType -> Bool #
Ord FDBConflictRangeType Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods compare :: FDBConflictRangeType -> FDBConflictRangeType -> Ordering # (<) :: FDBConflictRangeType -> FDBConflictRangeType -> Bool # (<=) :: FDBConflictRangeType -> FDBConflictRangeType -> Bool # (>) :: FDBConflictRangeType -> FDBConflictRangeType -> Bool # (>=) :: FDBConflictRangeType -> FDBConflictRangeType -> Bool # max :: FDBConflictRangeType -> FDBConflictRangeType -> FDBConflictRangeType # min :: FDBConflictRangeType -> FDBConflictRangeType -> FDBConflictRangeType #
Show FDBConflictRangeType Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods showsPrec :: Int -> FDBConflictRangeType -> ShowS # show :: FDBConflictRangeType -> String # showList :: [FDBConflictRangeType] -> ShowS #

Error

newtype CFDBError Source #

Constructors

CFDBError
Fields getCFDBError :: CInt

Instances

Instances details

Eq CFDBError Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods (==) :: CFDBError -> CFDBError -> Bool # (/=) :: CFDBError -> CFDBError -> Bool #
Num CFDBError Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods (+) :: CFDBError -> CFDBError -> CFDBError # (-) :: CFDBError -> CFDBError -> CFDBError # (*) :: CFDBError -> CFDBError -> CFDBError # negate :: CFDBError -> CFDBError # abs :: CFDBError -> CFDBError # signum :: CFDBError -> CFDBError # fromInteger :: Integer -> CFDBError #
Ord CFDBError Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods compare :: CFDBError -> CFDBError -> Ordering # (<) :: CFDBError -> CFDBError -> Bool # (<=) :: CFDBError -> CFDBError -> Bool # (>) :: CFDBError -> CFDBError -> Bool # (>=) :: CFDBError -> CFDBError -> Bool # max :: CFDBError -> CFDBError -> CFDBError # min :: CFDBError -> CFDBError -> CFDBError #
Show CFDBError Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods showsPrec :: Int -> CFDBError -> ShowS # show :: CFDBError -> String # showList :: [CFDBError] -> ShowS #

isError :: CFDBError -> Bool Source #

Return True iff CFDBError value is an error (non-zero).

getError :: CFDBError -> IO String Source #

errorPredicate :: FDBErrorPredicate -> CFDBError -> Bool Source #

data FDBErrorPredicate Source #

Constructors

ErrorPredicateRetryable
ErrorPredicateMaybeCommitted
ErrorPredicateRetryableNotCommitted

Instances

Instances details

Enum FDBErrorPredicate Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods succ :: FDBErrorPredicate -> FDBErrorPredicate # pred :: FDBErrorPredicate -> FDBErrorPredicate # toEnum :: Int -> FDBErrorPredicate # fromEnum :: FDBErrorPredicate -> Int # enumFrom :: FDBErrorPredicate -> [FDBErrorPredicate] # enumFromThen :: FDBErrorPredicate -> FDBErrorPredicate -> [FDBErrorPredicate] # enumFromTo :: FDBErrorPredicate -> FDBErrorPredicate -> [FDBErrorPredicate] # enumFromThenTo :: FDBErrorPredicate -> FDBErrorPredicate -> FDBErrorPredicate -> [FDBErrorPredicate] #
Eq FDBErrorPredicate Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods (==) :: FDBErrorPredicate -> FDBErrorPredicate -> Bool # (/=) :: FDBErrorPredicate -> FDBErrorPredicate -> Bool #
Ord FDBErrorPredicate Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods compare :: FDBErrorPredicate -> FDBErrorPredicate -> Ordering # (<) :: FDBErrorPredicate -> FDBErrorPredicate -> Bool # (<=) :: FDBErrorPredicate -> FDBErrorPredicate -> Bool # (>) :: FDBErrorPredicate -> FDBErrorPredicate -> Bool # (>=) :: FDBErrorPredicate -> FDBErrorPredicate -> Bool # max :: FDBErrorPredicate -> FDBErrorPredicate -> FDBErrorPredicate # min :: FDBErrorPredicate -> FDBErrorPredicate -> FDBErrorPredicate #
Show FDBErrorPredicate Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods showsPrec :: Int -> FDBErrorPredicate -> ShowS # show :: FDBErrorPredicate -> String # showList :: [FDBErrorPredicate] -> ShowS #

data MappedKeyValue Source #

The result of a mapped key value query, containing the parent key and value (i.e., the key and value in the secondary index), and the range of key-value pairs retrieved based on the range query generated from the mapper's operation on the parent key and value.

WARNING: FDB's docs warn that the returned KeySelector fields have not yet been tested. Use them at your own risk!

Constructors

MappedKeyValue
Fields parentKey :: ByteString parentValue :: ByteString mappedKeySelectorBegin :: KeySelector mappedKeySelectorEnd :: KeySelector mappedKeyValues :: [(ByteString, ByteString)]

Instances

Instances details

Eq MappedKeyValue Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods (==) :: MappedKeyValue -> MappedKeyValue -> Bool # (/=) :: MappedKeyValue -> MappedKeyValue -> Bool #
Show MappedKeyValue Source #
Instance details Defined in FoundationDB.Internal.Bindings Methods showsPrec :: Int -> MappedKeyValue -> ShowS # show :: MappedKeyValue -> String # showList :: [MappedKeyValue] -> ShowS #

getMappedRangeResult :: Future [MappedKeyValue] -> IO (Either CFDBError ([MappedKeyValue], Bool)) Source #

Extracts the mappedKeyValue results from the future, along with a bool indicating whether more results are available.

transactionGetMappedRange Source #

Arguments

:: Transaction
-> KeySelector	begin
-> KeySelector	end
-> ByteString	Mapper name
-> Int	max number of pairs to return
-> Int	max number of bytes to return
-> FDBStreamingMode
-> Int	if FDBStreamingMode is FdbStreamingModeIterator, start this at 1 and increment by for each successive call reading this range. Otherwise, ignored.
-> Bool	isSnapshotRead
-> Bool	whether to return pairs in reverse order
-> IO (Future [MappedKeyValue])