kv-deta 0.1.16a0

Key-Value Model for Detabase

Key-Value Model for Detabase

API

constructor

class KVModel(dict)

example:

from kv_deta import KVModel 

class Example(KVModel):
  class Config:
    deta_key = DETA_BASE_KEY
    # or
    deta = Deta(DETA_BASE_KEY)

    table_name = "my_kv_table"	# optional

	hash = my_hash_function		# default lambda x: hashlib.sha256(str(x).encode('utf8')).hexdigest()

kv = Example({"key":"value"})

update

kv.update({"k2":42})

like for dictionary

save

kv.save()

commit all data to detabase

get

mixed dict.get(key), deta.get(key), dict.setdefault(key, default)

kv.get(key="some key"[, default="newer data"])

returns value from deta.get(key) or update it by default if deta.get() returned None

incr, decr

based on Deta.Base.Util.incremental()

kv.incr(key="counter"[, quantity=1])

returns incremented value for key. if detabase have not specific key, creates it and value=quantity

query

kv.query(param=criteria, limit=1000, last=None) -> Dict

• return dict(key:value)
• query param see also https://deta.space/docs/en/build/reference/deta-base/queries
• update current model: kv.update(kv.query(criteria)) (??? refactoring required?)

keys

kv.keys(param=None) -> List

return list(key)

Table Struct

field	description
key	hash(key)
path	origin key
value	data

News

• v0.1.16 query(), keys()
• v0.1.15 rename()
• v0.1.13 backward compatibility broken
• v0.1.12 incr() rewritten with Deta.Base.Util.incremental()
• v0.1.11 incr(key: str, quantity=1), decr(key: str, quantity=1): return incr(key, -quantity)
• v0.1.8 get() fix
• get(key, default)
• save()

License

• It's opensource and free software, see the LICENSE for more details

similar projects

• csv-deta
• sql-deta

TODO

• keys() get keys list
• save() refactor
• set, get, del
• rename(key, new_key)
• query() return dict
• TTL
• incr(), decr()
• get(key)