io.randomseed.utils.db — io.randomseed/utils 1.2.33

Random utils, database helper functions.

braced-? clj

(braced-? coll)

braced-join-? clj

(braced-join-? ids)

braced-join-col-names clj

(braced-join-col-names cols)

braced-join-col-names-no-conv clj

(braced-join-col-names-no-conv cols)

cache-create clj

(cache-create ttl)

(cache-create ttl queue-size)

(cache-create ttl queue-size initial-map)

Creates a cache object of the given TTL and/or queue size. Optionally it can get an initial map of entries. Returns cache object encapsulated in an atom.

cache-evict! clj

(cache-evict! cache-atom entry)

(cache-evict! cache-atom entry & more)

Removes entry or entries from the cache. Returns the updated cache from the atom.

cache-id+ clj

(cache-id+ f)

Returns metadata value associated with :io.randomseed.utils.db/cache key for the function f.

cache-lookup clj

(cache-lookup cache id)

(cache-lookup cache id & ids)

Looks for the entry of the given ID in a cache which should be a cache object encapsulated in an atom. For multiple IDs, calls cache-lookup-coll. If the entry was not found, returns :io.randomseed.utils.db/not-found.

cache-lookup-coll clj

(cache-lookup-coll cache ids)

Looks for a collection of entries identified by the given ID in a cache which should be a cache object encapsulated in an atom. Returns a map with identifiers as keys and values for all found entries. Entries which are missing in the cache are grouped under the :io.randomseed.utils.db/not-found key as a list.

cache-prepare clj

(cache-prepare ttl)

(cache-prepare ttl queue-size)

(cache-prepare ttl queue-size initial-map)

Prepares a cache object of the given TTL and/or queue size. Optionally it can get an initial map of entries. Returns a cache object.

cached-setting-del clj

(cached-setting-del cache deleter db entity-id)

(cached-setting-del cache deleter db entity-id setting-id)

(cached-setting-del cache deleter db entity-id setting-id & pairs)

Deletes the cached result of calling the given setting deleter. Purges cache entry after operation succeeded.

cached-setting-get clj

(cached-setting-get cache getter db entity-id setting-id)

(cached-setting-get cache getter db entity-id setting-id & setting-ids)

Gets the cached result of calling the given setting getter. Updates cache when necessary.

cached-setting-set clj

(cached-setting-set cache setter db entity-id setting-id value)

(cached-setting-set cache setter db entity-id setting-id value & pairs)

Sets the cached result of calling the given setting setter. Purges cache entry after operation succeeded.

cwr-lookup clj

(cwr-lookup cache id)

Performs a cache lookup of id on cache and returns the hit. If there is no element found, returns the keyword :io.randomseed.utils.db/not-found.

dash clj

data-source? clj

(data-source? v)

for-insert-multi-or clj

(for-insert-multi-or table cols rows opts)

Given a table name, a vector of column names, and a vector of row values (each row is a vector of its values), return a vector of the full INSERT SQL string and its parameters. Applies any :table-fn / :column-fn supplied in the options. If :suffix is provided in opts, that string is appended to the INSERT IGNORE ... statement. The IGNORE part can be replaced by supplying :alt-clause option key.

for-insert-or clj

(for-insert-or table key-map opts)

Given a table name and a hash map of column names and their values, return a vector of the full INSERT OR IGNORE SQL string and its parameters. Applies any :table-fn / :column-fn supplied in the options. If :suffix is provided in opts, that string is appended to the INSERT ... statement. If :alt-clause is provided in opts, it will replace the default IGNORE string.

for-replace clj

(for-replace table key-map opts)

Given a table name and a hash map of column names and their values, return a vector of the full REPLACE SQL string and its parameters. Applies any :table-fn / :column-fn supplied in the options. If :suffix is provided in opts, that string is appended to the INSERT ... statement.

for-replace-multi clj

(for-replace-multi table cols rows opts)

Given a table name, a vector of column names, and a vector of row values (each row is a vector of its values), return a vector of the full REPLACE SQL string and its parameters. Applies any :table-fn / :column-fn supplied in the options. If :suffix is provided in opts, that string is appended to the REPLACE ... statement.

get-cached clj

(get-cached cache db-getter db id)

(get-cached cache table db id)

(get-cached cache table db-getter db id)

(get-cached cache db-getter db id & more)

(get-cached cache table db id & more)

(get-cached cache table db-getter db id & more)

Returns a (possibly cached) sequence of maps requested using db-getter for the given IDs. A database connection and a table name can be passed to be used with the standard get-id getter function instead. When multiple IDs are given, calls get-cached-coll.

get-cached-coll clj

(get-cached-coll cache db-getter db ids)

(get-cached-coll cache table db ids)

(get-cached-coll cache table db-getter db ids)

Returns a (possibly cached) sequence of maps requested using db-getter for the given IDs. When called with a table name it will be passed as a second argument to the given getter function. When no getter is given the standard one (get-ids) is used. Use make-getter-coll to create getter (with or without predefined table name).

get-cached-coll-prop clj

(get-cached-coll-prop cache db-getter db property ids)

(get-cached-coll-prop cache table db property ids)

(get-cached-coll-prop cache table db-getter db property ids)

Uses get-cached-coll to retrieve a map with keys being IDs and values being requested properties. If there is no data for the given ID, corresponding entry is not added to the resulting map. If the property does not exist, nil is added.

get-cached-prop clj

(get-cached-prop cache db-getter db property id)

(get-cached-prop cache table db property id)

(get-cached-prop cache table db-getter db property id)

(get-cached-prop cache db-getter db property id & more)

(get-cached-prop cache table db property id & more)

(get-cached-prop cache table db-getter db property id & more)

Same as get-cached but retrieves a single property from the result by using the get function. When multiple IDs are given it calls get-cached-coll-prop to handle it.

get-cached-prop-or-default clj

(get-cached-prop-or-default cache db-getter db property default id)

(get-cached-prop-or-default cache table db property default id)

(get-cached-prop-or-default cache table db-getter db property default id)

(get-cached-prop-or-default cache db-getter db property default id & more)

(get-cached-prop-or-default cache table db property default id & more)

(get-cached-prop-or-default cache table db-getter db property default id & more)

Same as get-cached-prop but when there is no entry for the given ID, it returns the given default value.

get-failed? clj

(get-failed? v)

Returns true if getting from a database failed in post-processing phase (e.g. de-serialization) and the data were broken.

get-id clj

(get-id db table id)

(get-id db table id & more)

Gets properties of the given ID from a database table. For multiple IDs, calls get-ids.

get-ids clj

(get-ids db table ids)

Gets a map of ID-to-properties from a database for the given IDs and a table. Assumes each result will be related to a single, unique ID.

id-as-str clj

(id-as-str v)

Tries to convert the given argument to a string identifier.

id-from-db clj

(id-from-db v)

Converts the given ID retrieved from a database to a value suitable to be used in Clojure programs. If v is a number or a keyword, it is returned as is. Otherwise it is converted to a keyword.

id-to-db clj

(id-to-db v)

Converts the given ID to a value suitable to be stored in a database. If v is a number, it is passed as is. Otherwise it is converted to a string.

init-cache clj

(init-cache {:keys [size ttl seed]})

Initializes single cache by parsing TTL and queue size.

init-caches clj

(init-caches config)

Initializes in-memory caches by resetting atoms associated with cache parameters.

insert-multi-or! clj

(insert-multi-or! connectable table cols rows)

(insert-multi-or! connectable table cols rows opts)

Syntactic sugar over execute! to make inserting columns/rows easier. Same as insert-or! but supports multiple rows to be inserted at once.

insert-or! clj

(insert-or! connectable table key-map)

(insert-or! connectable table key-map opts)

Syntactic sugar over execute-one! to make inserting hash maps easier. Given a connectable object, a table name, and a data hash map, inserts the data as a single row in the database and attempts to return a map of generated keys. By default it uses INSERT OR IGNORE but the IGNORE can be changed to anything by supplying :alt-clause option in opts map.

insert-or-ignore! clj

(insert-or-ignore! connectable table key-map)

(insert-or-ignore! connectable table key-map opts)

Syntactic sugar over execute-one! to make inserting hash maps easier. Given a connectable object, a table name, and a data hash map, inserts the data as a single row in the database and attempts to return a map of generated keys.

insert-or-ignore-multi! clj

(insert-or-ignore-multi! connectable table cols rows)

(insert-or-ignore-multi! connectable table cols rows opts)

Syntactic sugar over execute! to make inserting columns/rows easier. Same as insert-multi! but supports :alt-clause option key.

insert-or-replace! clj

(insert-or-replace! connectable table key-map)

(insert-or-replace! connectable table key-map opts)

Syntactic sugar over execute-one! to make inserting hash maps easier. Given a connectable object, a table name, and a data hash map, inserts the data as a single row in the database and attempts to return a map of generated keys.

insert-or-replace-multi! clj

(insert-or-replace-multi! connectable table cols rows)

(insert-or-replace-multi! connectable table cols rows opts)

Syntactic sugar over execute! to make inserting columns/rows easier. Same as insert-multi! but supports :alt-clause option key.

invalidate! clj

(invalidate! f)

(invalidate! f key-params)

Invalidates cache associated with memoized function f. If key-params are given it should be a cache key sequence or other structure (usually function arguments). If only function is given, it clears the whole cache.

invalidate+! clj

(invalidate+! f)

(invalidate+! f key-params)

Invalidates cache associated with memoized function f. If key-params are given it should be a cache key sequence or other structure (usually function arguments), internally transformed to vector. If only function is given, it clears the whole cache. Supports functions memoized with memoize+.

invalidator clj

(invalidator f)

Generates invalidation function for the given memoized function f. The invalidation function takes arguments in the same way as memoized function. If they match a value in the associated cache, the entry is evicted. Supports functions memoized with memoize and memoize+.

join-? clj

(join-? ids)

join-col-names clj

(join-col-names cols)

join-v=? clj

(join-v=? ids)

listed-nil clj

make-deleter clj

(make-deleter id-col)

(make-deleter table id-col)

make-getter clj

(make-getter id-col cols)

(make-getter table id-col cols)

(make-getter table id-col cols getter-coll-fn)

make-getter-coll clj

(make-getter-coll id-col)

(make-getter-coll id-col cols)

(make-getter-coll table id-col cols)

Creates a database getter suitable for use with get-cached-coll- family of functions. The returned function should accept an argument containing multiple identifiers.

make-setter clj

(make-setter id-col)

(make-setter table id-col)

make-setting-deleter clj

(make-setting-deleter table entity-column)

Creates a setting deleter on a basis of the given table and entity column.

make-setting-getter clj

(make-setting-getter table entity-column)

Returns a function which gets a setting for the given entity and de-serializes it to a Clojure data structure. Table name and entity column name must be quoted if needed before passing to this function.

make-setting-setter clj

(make-setting-setter table entity-column)

Returns a function which stores one or more settings for a given entity in a database. Max. object size is 32 KB. Table name and entity column name must be quoted if needed before passing to this function.

memoize clj

(memoize f)

(memoize f queue-size)

(memoize f queue-size ttl)

Creates memoized version of a database accessing or other function. With only 1 argument defaults to a FIFO cache with length of 256 and TTL cache with expiration of 150 seconds. When 2 arguments are given it only creates FIFO cache of the given length, without TTL. When queue-size is nil or <= 0, the FIFO cache will not be created. When ttl is nil or <= 0, the TTL cache will not be created.

memoize+ clj

(memoize+ f)

(memoize+ f size)

(memoize+ f level1-size level2-size)

Wrapper around clojure.core.memoize/fifo which uses fast, map-based memoization for cache size up to level1-size size, and then switches to slower memoization based on FIFO cache of level2-size size. The first level of cache is never purged automatically; once an element is there, it stays.

If only one size is given (size), the level-1 cache size will be set to 70% of it, and level-2 cache to 30% of it.

If no size is given, the level-1 cache will have a size of 89000 elements and level-2 cache will have a size of 39000 elements; both having a size of 128000 elements in total.

Be aware that caching key in level-1 cache is a vector of all arguments unless the argument count is greater than 8. In such case all extra arguments (expressed with native Clojure structure used for variadic function arguments) are grouped as 9th element of this vector.

To control caches associated with original function, use a metadata of the returned function object.

memoized+? clj

(memoized+? f)

Returns true if the given function f is memoized using memoize+. If not, returns false.

memoizer clj

(memoizer config)

(memoizer f config)

Creates a memoized functions with predefined TTL and queue size taken from config. If the function is not given it will try to dereference symbol present in the config under the :memoizer key. Uses io.randomseed.utils.db/memoize to initialize caches.

not-found clj

not-found? clj

(not-found? e)

Returns true when the given value equals to :io.randomseed.utils.db/not-found.

opts-map clj

opts-simple-map clj

opts-simple-vec clj

opts-slashed-map clj

opts-slashed-vec clj

opts-vec clj

print-caches clj

(print-caches caches)

remove-caches clj

(remove-caches config)

Removes cache structures.

replace! clj

(replace! connectable table key-map)

(replace! connectable table key-map opts)

Syntactic sugar over execute-one! to make inserting hash maps easier. Given a connectable object, a table name, and a data hash map, inserts the data as a single row in the database and attempts to return a map of generated keys. By default it uses REPLACE.

replace-multi! clj

(replace-multi! connectable table cols rows)

(replace-multi! connectable table cols rows opts)

Syntactic sugar over execute! to make inserting columns/rows easier. Same as replace! but supports multiple rows to be inserted at once.

to-lisp clj

to-lisp-simple clj

to-lisp-slashed clj

to-snake clj

to-snake-simple clj

to-snake-slashed clj

underscore clj

values-? clj

(values-? coll)