nat.plugins.mysql.mysql_object_store

Attributes

logger

Classes

MySQLObjectStore

Implementation of ObjectStore that stores objects in a MySQL database.

Module Contents

logger

class MySQLObjectStore(

*,

bucket_name: str,

host: str,

port: int,

username: str | None,

password: str | None,

)

Bases: nat.object_store.interfaces.ObjectStore

Implementation of ObjectStore that stores objects in a MySQL database.

_bucket_name

_host

_port

_username

_password

_conn_pool: aiomysql.pool.Pool | None = None

property _schema: str

async put_object(key: str, item: nat.object_store.models.ObjectStoreItem)

Save an ObjectStoreItem in the object store with the given key. If the key already exists, raise an error.

Args:

key (str): The key to save the item under. item (ObjectStoreItem): The item to save.

Raises:

KeyAlreadyExistsError: If the key already exists.

async upsert_object(key: str, item: nat.object_store.models.ObjectStoreItem)

Save an ObjectStoreItem in the object store with the given key. If the key already exists, update the item.

Args:

key (str): The key to save the item under. item (ObjectStoreItem): The item to save.

async get_object(key: str) → nat.object_store.models.ObjectStoreItem

Get an ObjectStoreItem from the object store by key.

Args:

key (str): The key to get the item from.

Returns:

ObjectStoreItem: The item retrieved from the object store.

Raises:

NoSuchKeyError: If the item does not exist.

async delete_object(key: str)

Delete an ObjectStoreItem from the object store by key.

Args:

key (str): The key to delete the item from.

Raises:

NoSuchKeyError: If the item does not exist.