Module Contents


DatabaseStoreBackend(table_name, key_columns, fixed_length_key=True, credentials=None, url=None, connection_string=None, engine=None, store_name=None, suppress_store_backend_id=False, manually_initialize_store_backend_id: str = ‘’, **kwargs)

A store backend acts as a key-value store that can accept tuples as keys, to abstract away
class, key_columns, fixed_length_key=True, credentials=None, url=None, connection_string=None, engine=None, store_name=None, suppress_store_backend_id=False, manually_initialize_store_backend_id: str = '', **kwargs)


A store backend acts as a key-value store that can accept tuples as keys, to abstract away reading and writing to a persistence layer.

In general a StoreBackend implementation must provide implementations of:
  • _get

  • _set

  • list_keys

  • _has_key

property store_backend_id(self)

Create a store_backend_id if one does not exist, and return it if it exists Ephemeral store_backend_id for database_store_backend until there is a place to store metadata :returns: store_backend_id which is a UUID(version=4)

_build_engine(self, credentials, **kwargs)

Using a set of given credentials, constructs an Execution Engine , connecting to a database using a URL or a private key path.

_get_sqlalchemy_key_pair_auth_url(self, drivername: str, credentials: dict)

Utilizing a private key path and a passphrase in a given credentials dictionary, attempts to encode the provided values into a private key. If passphrase is incorrect, this will fail and an exception is raised.

  • drivername (str) –

  • credentials (dict) –


a tuple consisting of a url with the serialized key-pair authentication, and a dictionary of engine kwargs.

_get(self, key)
_set(self, key, value, allow_update=True, **kwargs)
abstract _move(self)
get_url_for_key(self, key)
_convert_engine_and_key_to_url(self, key)
_has_key(self, key)
list_keys(self, prefix=())
remove_key(self, key)
property config(self)