Functions: Streams DPS Toolkit

Streams DPS Toolkit > Functions

Functions

dlAcquireLock(uint64, float64, float64, uint64)
Acquire lock, with an explicit lease time in seconds and a maximum time to wait to acquire the lock.
dlAcquireLock(uint64, uint64)
This function can be called to acquire a distributed lock.
dlCreateOrGetLock(rstring, uint64)
Create a new distributed lock with a given name or get it if it already exists.
dlGetLastDistributedLockErrorCode()
Get the error code of the last DL error
dlGetLastDistributedLockErrorString()
Get the description of the error that occurred on the most recently executed operation in the DL API, if any.
dlGetPidForLock(rstring, uint64)
Get the process id that is currently holding a given lock.
dlReleaseLock(uint64, uint64)
Release the given distributed lock id.
dlRemoveLock(uint64, uint64)
Remove the distributed lock with the given id.
dpsBase64Decode(rstring, rstring)
Base64 decode a given string.
dpsBase64Encode(rstring, rstring)
Base64 encode a given string.
dpsBeginIteration(uint64, uint64)
This function gets a store iterator that can be used to iterate over all the key-value pairs in a given store id.
dpsClear(uint64, uint64)
Clear the given store.
dpsCreateOrGetStore(rstring, T1, T2, uint64)
Create a new process store with a given name or simply return its handle it already exists.
dpsCreateStore(rstring, T1, T2, uint64)
Create a new process store with a given name.
dpsDeserialize(uint64, blob, T1, T2, uint64)
This function deserializes a given blob containing one or more serialized key-value pairs.
dpsEndIteration(uint64, uint64, uint64)
This function must be called once all iteration is complete.
dpsFindStore(rstring, uint64)
Find a process store given its name.
dpsGet(uint64, T1, T2, uint64)
Given a key, retrieves its value from the given store.
dpsGetDetailsAboutThisMachine(rstring, rstring, rstring)
Get details of the client machine where this operator is running.
dpsGetKVPairs(uint64, list<T1>, list<T2>, int32, int32, uint64)
This function can be called to get i.e. read/fetch multiple Key/Value (KV) pairs present in a given store.
dpsGetKeys(uint64, list<T1>, int32, int32, rstring, rstring, uint64)
This function can be called to get i.e. read/fetch multiple keys present in a given store.
dpsGetLastErrorCodeTTL()
Get the error code of the last error occurred involving data that was stored with a Time To Live (TTL).
dpsGetLastErrorStringTTL()
Get the description of the last error that occurred involving data stored with a Time To Live (TTL).
dpsGetLastStoreErrorCode()
Get the error code of the last store error.
dpsGetLastStoreErrorString()
Get the description of the last store error.
dpsGetNext(uint64, uint64, T1, T2, uint64)
This function is used to get the next key and value of given types in the given store when iterating over all the items in the store.
dpsGetNoSqlDbProductName()
Get the name of the NoSQL database product being used.
dpsGetSafe(uint64, T1, T2, uint64)
Given a key, retrieve its value from the given store.
dpsGetSplTypeNameForKey(uint64)
Get the SPL type name for the key of a given store id.
dpsGetSplTypeNameForValue(uint64)
Get the SPL type name for the value of a given store id.
dpsGetStoreName(uint64)
Get the store name for a given store id.
dpsGetTTL(T1, T2, uint64)
Get an item that was stored with a TTL (Time To Live in seconds) value.
dpsGetTTL(T1, T2, uint64, boolean, boolean)
Get an item that was stored with a TTL (Time To Live in seconds) value.
dpsGetValues(uint64, list<T1>, list<boolean>, list<T2>, uint64)
This function can be called to get i.e. read/fetch values for a given list of multiple keys present in a given store.
dpsHas(uint64, T1, uint64)
Check if an item exists in the given store.
dpsHasKeys(uint64, list<T1>, list<boolean>, uint64)
This function can be called to check for the existence of a given list of keys in a given store.
dpsHasTTL(T1, uint64)
Check if an item exists that was stored with a TTL (Time To Live in seconds) value.
dpsHasTTL(T1, uint64, boolean)
Check if an item exists that was stored with a TTL (Time To Live in seconds) value.
dpsIsConnected()
It allows to check the connection status of the back-end data store.
dpsPersist(uint64)
Persist any operations involving stores used in this application to disk.
dpsPut(uint64, T1, T2, uint64)
Put a new key-value pair into a store.
dpsPutKVPairs(uint64, list<T1>, list<T2>, uint64)
This function can be called to put i.e. write/save multiple Key/Value (KV) pairs to a given store. Note: You must make sure that the intended store exists before you use this function. If not, you will end up creating bulk K/V pairs in an unmanageable fashion in the backend data store which will make it less useful.
dpsPutSafe(uint64, T1, T2, uint64)
Put an item into the given store.
dpsPutTTL(T1, T2, uint32, uint64)
Put an key-value pair with in a TTL (Time To Live in seconds) value into the global area of the back-end data store.
dpsPutTTL(T1, T2, uint32, uint64, boolean, boolean)
Put a key-value pair with in a TTL (Time To Live in seconds) value into the global area of the back-end data store.
dpsPutTTL(T1, T2, uint32, uint64, uint32, uint32, boolean, boolean)
Put a key-value pair with in a TTL (Time To Live in seconds) value into the global area of the back-end data store.
dpsReconnect()
It allows to reconnect to the back-end data store.
dpsRemove(uint64, T1, uint64)
Remove an item from the given store.
dpsRemoveKeys(uint64, list<T1>, int32, uint64)
This function can be called to remove a given list of keys from a given store.
dpsRemoveStore(uint64, uint64)
Remove a process store given its handle.
dpsRemoveTTL(T1, uint64)
Remove an item that was stored with a TTL (Time To Live in seconds) value.
dpsRemoveTTL(T1, uint64, boolean)
Remove an item that was stored with a TTL (Time To Live in seconds) value.
dpsRunDataStoreCommand(list<rstring>, rstring, uint64)
This is a Redis specific API using which any aribitrary Redis command can be executed by providing the different parts of that Redis command inside a list of strings.
dpsRunDataStoreCommand(rstring, uint64)
This function can be used to execute simple arbitrary back-end data store (fire and forget) native commands.
dpsRunDataStoreCommand(uint32, rstring, rstring, rstring, rstring, rstring, rstring, uint64)
This is an advanced function that can be used to execute arbitrary back-end data store two way native commands for database technologies that work with cURL.
dpsSerialize(uint64, blob, T1, T2, uint64)
This function serializes all the key-value pairs in a given store id into a blob.
dpsSetConfigFile(rstring)
Allows for setting a path to the configuration file.
dpsSize(uint64, uint64)
Get the total number of key-value pairs in the given store.
initializeDpsNoException()
Allows you to initialize the connection to DPS without throwing an exception on failure.