Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

KV

The `kv` collection of Sylphx Data.

The kv collection of Sylphx Data — served at https://api.data.sylphx.com.

Service Sylphx Data · served at https://api.data.sylphx.com

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
PUTputWrites a value. Without ttl_seconds the namespace default applies; zero means no expiry.
GETgetReads a value.
GETlistLists a namespace's values in key order.
DELETEdeleteDeletes a value.
POSTincrementAdds delta (default 1) to an integer value, creating it at zero.
POSTget_manyReads up to 1000 keys at once (MGET). Answers one entry per key, in order; an absent or expired key keeps its key and has no value.
POSThash_setSets fields of a hash (HSET), creating it.
POSThash_getReads one field of a hash (HGET); an absent field has no value.
POSThash_get_allReads every field of a hash (HGETALL).
POSThash_get_manyReads several fields of a hash (HMGET), one per field, in order; an absent field has no value.
POSTlist_pushPushes values onto the head of a list (LPUSH), creating it.
POSTlist_rangeReads a range of a list (LRANGE); negative indexes count from the end.
POSTlist_popPops values from the head of a list (LPOP); an emptied list is removed.
POSTlist_lengthReads the length of a list (LLEN); an absent key has length zero.
POSTzset_addAdds members to a sorted set or updates their scores (ZADD), creating it.
POSTzset_rangeReads a range of a sorted set by rank, lowest score first (ZRANGE); negative indexes count from the end.
POSTzset_scoreReads a member's score (ZSCORE); an absent member has no score.
POSTzset_lengthReads the size of a sorted set (ZCARD); an absent key has size zero.
POSTscanWalks a namespace's keys that match a glob (SCAN). Call again with the returned cursor until it is empty.
POSTexpireSets a key's time to live (EXPIRE) without rewriting its value; zero makes it persistent.

#put

Writes a value. Without ttl_seconds the namespace default applies; zero means no expiry.

PUT https://api.data.sylphx.com/v1/kv/namespace-id/key · scope data:write · effect write · Request, response and examples

#get

Reads a value.

GET https://api.data.sylphx.com/v1/kv/namespace-id/key · scope data:read · effect read · Request, response and examples

#list

Lists a namespace's values in key order.

GET https://api.data.sylphx.com/v1/kv/namespace-id · scope data:read · effect read · Request, response and examples

#delete

Deletes a value.

DELETE https://api.data.sylphx.com/v1/kv/namespace-id/key · scope data:write · effect destructive · Request, response and examples

#increment

Adds delta (default 1) to an integer value, creating it at zero.

POST https://api.data.sylphx.com/v1/kv-increments · scope data:write · effect write · Request, response and examples

#get_many

Reads up to 1000 keys at once (MGET). Answers one entry per key, in order; an absent or expired key keeps its key and has no value.

POST https://api.data.sylphx.com/v1/kv-mget · scope data:read · effect read · Request, response and examples

#hash_set

Sets fields of a hash (HSET), creating it.

POST https://api.data.sylphx.com/v1/kv-hashes · scope data:write · effect write · Request, response and examples

#hash_get

Reads one field of a hash (HGET); an absent field has no value.

POST https://api.data.sylphx.com/v1/kv-hash-gets · scope data:read · effect read · Request, response and examples

#hash_get_all

Reads every field of a hash (HGETALL).

POST https://api.data.sylphx.com/v1/kv-hash-getall · scope data:read · effect read · Request, response and examples

#hash_get_many

Reads several fields of a hash (HMGET), one per field, in order; an absent field has no value.

POST https://api.data.sylphx.com/v1/kv-hash-mget · scope data:read · effect read · Request, response and examples

#list_push

Pushes values onto the head of a list (LPUSH), creating it.

POST https://api.data.sylphx.com/v1/kv-list-pushes · scope data:write · effect write · Request, response and examples

#list_range

Reads a range of a list (LRANGE); negative indexes count from the end.

POST https://api.data.sylphx.com/v1/kv-list-ranges · scope data:read · effect read · Request, response and examples

#list_pop

Pops values from the head of a list (LPOP); an emptied list is removed.

POST https://api.data.sylphx.com/v1/kv-list-pops · scope data:write · effect write · Request, response and examples

#list_length

Reads the length of a list (LLEN); an absent key has length zero.

POST https://api.data.sylphx.com/v1/kv-list-lens · scope data:read · effect read · Request, response and examples

#zset_add

Adds members to a sorted set or updates their scores (ZADD), creating it.

POST https://api.data.sylphx.com/v1/kv-zsets · scope data:write · effect write · Request, response and examples

#zset_range

Reads a range of a sorted set by rank, lowest score first (ZRANGE); negative indexes count from the end.

POST https://api.data.sylphx.com/v1/kv-zset-ranges · scope data:read · effect read · Request, response and examples

#zset_score

Reads a member's score (ZSCORE); an absent member has no score.

POST https://api.data.sylphx.com/v1/kv-zset-scores · scope data:read · effect read · Request, response and examples

#zset_length

Reads the size of a sorted set (ZCARD); an absent key has size zero.

POST https://api.data.sylphx.com/v1/kv-zset-lens · scope data:read · effect read · Request, response and examples

#scan

Walks a namespace's keys that match a glob (SCAN). Call again with the returned cursor until it is empty.

POST https://api.data.sylphx.com/v1/kv-scans · scope data:read · effect read · Request, response and examples

#expire

Sets a key's time to live (EXPIRE) without rewriting its value; zero makes it persistent.

POST https://api.data.sylphx.com/v1/kv-expiries · scope data:write · effect write · Request, response and examples