Class KeyValueStore

python/database.py:30–118

``class KeyValueStore`` maintains access to the raw data stored in Snapshots and various other Database-related structures.

class KeyValueStore:
	"""
    ``class KeyValueStore`` maintains access to the raw data stored in Snapshots and various
    other Database-related structures.
    """
	def __init__(self, buffer: Optional[databuffer.DataBuffer] = None, handle=None):
		if handle is not None:
			self.handle = core.handle_of_type(handle, core.BNKeyValueStore)
		else:
			if buffer is None:
				_handle = core.BNCreateKeyValueStore()
			else:
				_handle = core.BNCreateKeyValueStoreFromDataBuffer(buffer.handle)
			assert _handle is not None
			self.handle = _handle

	def __del__(self):
		core.BNFreeKeyValueStore(self.handle)

	def __getitem__(self, item: str) -> databuffer.DataBuffer:
		return self.get_value(item)

	def __setitem__(self, key: str, value: databuffer.DataBuffer):
		return self.set_value(key, value)

	@property
	def keys(self):
		"""Get a list of all keys stored in the kvs (read-only)"""
		count = ctypes.c_ulonglong(0)
		value = core.BNGetKeyValueStoreKeys(self.handle, count)
		assert value is not None

		result = []
		try:
			for i in range(0, count.value):
				result.append(value[i])
			return result
		finally:
			core.BNFreeStringList(value, count)

	def get_value(self, key: str) -> databuffer.DataBuffer:
		"""Get the value for a single key"""
		handle = core.BNGetKeyValueStoreBuffer(self.handle, key)
		assert handle is not None
		return databuffer.DataBuffer(handle=handle)

	def set_value(self, key: str, value: databuffer.DataBuffer):
		"""Set the value for a single key"""
		core.BNSetKeyValueStoreBuffer(self.handle, key, value.handle)

	@property
	def serialized_data(self) -> databuffer.DataBuffer:
		"""Get the stored representation of the kvs (read-only)"""
		handle = core.BNGetKeyValueStoreSerializedData(self.handle)
		assert handle is not None
		return databuffer.DataBuffer(handle=handle)

	def begin_namespace(self, name: str):