fiftyone.factory.repos.execution_store.ExecutionStoreRepo

Modules Classes Names

class documentation

class ExecutionStoreRepo(ABC): (source)

Known subclasses: fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Constructor: ExecutionStoreRepo(dataset_id, is_cache)

View In Hierarchy

Abstract base class for execution store repositories.

Each instance operates in a context: - If a dataset_id is provided, it operates on stores associated with that dataset. - If no dataset_id is provided, it operates on stores not associated with any dataset.

To operate on all stores across all contexts, use the XXX_global() methods that this class provides.

Method	`__init__`	Initialize the execution store repository.
Method	`cleanup`	Delete all stores in the global store collection.
Method	`clear_cache`	Clear all keys with either a `ttl` or `policy="eviction"`.
Method	`count_keys`	Count the number of keys in a store.
Method	`count_stores`	Count the number of stores in the store collection.
Method	`count_stores_global`	Count the number of stores in the global store collection.
Method	`create_store`	Create a store in the store collection.
Method	`delete_key`	Delete a key from a store.
Method	`delete_store`	Delete a store.
Method	`delete_store_global`	Delete a store from the global store collection.
Method	`get_key`	Get a key from a store.
Method	`get_store`	Get a store from the store collection.
Method	`has_key`	Check if a key exists in a store.
Method	`has_store`	Check if a store exists in the store collection.
Method	`has_store_global`	Check if a store exists in the global store collection.
Method	`list_keys`	List all keys in a store.
Method	`list_stores`	List all stores in the store collection.
Method	`list_stores_global`	List all stores in the global store collection.
Method	`set_cache_key`	Set a cache key in a store.
Method	`set_key`	Set a key in a store.
Method	`update_ttl`	Update the TTL of a key.
Instance Variable	`_dataset_id`	Undocumented

def __init__(self, dataset_id: ObjectId | None = None, is_cache=False): (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Initialize the execution store repository.

Parameters
dataset_id:`Optional[ObjectId]`	the dataset ID to operate on
is_cache:`False`	whether the store is a cache store

@abstractmethod
def cleanup(self) -> int: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Delete all stores in the global store collection.

Returns
`int`	the number of documents deleted

@abstractmethod
def clear_cache(self, store_name=None): (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Clear all keys with either a ttl or policy="eviction".

Parameters
store_name:`str`, optional	the name of the store to clear. If None, all stores will be queried for deletion.

@abstractmethod
def count_keys(self, store_name: str) -> int: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Count the number of keys in a store.

Parameters
store_name:`str`	the name of the store to count keys for
Returns
`int`	the number of keys in the store

@abstractmethod
def count_stores(self) -> int: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Count the number of stores in the store collection.

Returns
`int`	the number of stores

@abstractmethod
def count_stores_global(self) -> int: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Count the number of stores in the global store collection.

Returns
`int`	the number of stores

@abstractmethod
def create_store(self, store_name: str, metadata: dict[str, Any] | None = None, policy: str = 'persist') -> StoreDocument: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Create a store in the store collection.

Parameters
store_name:`str`	the name of the store to create
metadata:`Optional[Dict[str`, `Any]]`	the metadata to store with the store
policy:`str`	Undocumented
Returns
`StoreDocument`	the created store document

@abstractmethod
def delete_key(self, store_name: str, key: str) -> bool: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Delete a key from a store.

Parameters
store_name:`str`	the name of the store to delete the key from
key:`str`	the key to delete
Returns
`bool`	True if the key was deleted, False otherwise

@abstractmethod
def delete_store(self, store_name: str) -> int: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Delete a store.

Parameters
store_name:`str`	the name of the store to delete
Returns
`int`	the number of documents deleted

@abstractmethod
def delete_store_global(self, store_name: str) -> int: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Delete a store from the global store collection.

Parameters
store_name:`str`	the name of the store to delete
Returns
`int`	the number of documents deleted

@abstractmethod
def get_key(self, store_name: str, key: str) -> KeyDocument | None: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Get a key from a store.

Parameters
store_name:`str`	the name of the store to get the key from
key:`str`	the key to get
Returns
`Optional[KeyDocument]`	the key document, or None if the key does not exist

@abstractmethod
def get_store(self, store_name: str) -> StoreDocument | None: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Get a store from the store collection.

Parameters
store_name:`str`	the name of the store to get
Returns
`Optional[StoreDocument]`	the store document, or None if the store does not exist

@abstractmethod
def has_key(self, store_name: str, key: str) -> bool: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Check if a key exists in a store.

Parameters
store_name:`str`	the name of the store to check
key:`str`	the key to check
Returns
`bool`	True if the key exists, False otherwise

@abstractmethod
def has_store(self, store_name: str) -> bool: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Check if a store exists in the store collection.

Parameters
store_name:`str`	the name of the store to check
Returns
`bool`	True if the store exists, False otherwise

@abstractmethod
def has_store_global(self, store_name: str) -> bool: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Check if a store exists in the global store collection.

Parameters
store_name:`str`	the name of the store to check
Returns
`bool`	True if the store exists, False otherwise

@abstractmethod
def list_keys(self, store_name: str) -> list[str]: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

List all keys in a store.

Parameters
store_name:`str`	the name of the store to list keys for
Returns
`List[str]`	a list of keys in the store

@abstractmethod
def list_stores(self) -> list[str]: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

List all stores in the store collection.

Returns
`List[str]`	a list of store names

@abstractmethod
def list_stores_global(self) -> list[StoreDocument]: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

List all stores in the global store collection.

Returns
`List[StoreDocument]`	a list of store documents

@abstractmethod
def set_cache_key(self, store_name: str, key: str, value: Any, ttl: int | None = None) -> KeyDocument: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Set a cache key in a store.

Parameters
store_name:`str`	the name of the store to set the cache key in
key:`str`	the cache key to set
value:`Any`	the value to set
ttl:`Optional[int]`	the TTL of the cache key
Returns
`KeyDocument`	the created or updated cache key document

@abstractmethod
def set_key(self, store_name: str, key: str, value: Any, ttl: int | None = None, policy: str = 'persist') -> KeyDocument: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Set a key in a store.

Parameters
store_name:`str`	The name of the store to set the key in.
key:`str`	The key to set.
value:`Any`	The value to associate with the key.
ttl:`Optional[int]`	Optional TTL (in seconds) after which the key will expire and be automatically removed.
policy:`str`	The eviction policy for the key. One of: - `"persist"` (default): Key is persistent until deleted. - `"evict"`: Key is eligible for eviction or cache clearing.
Returns
`KeyDocument`	The created or updated key document.

@abstractmethod
def update_ttl(self, store_name: str, key: str, ttl: int) -> bool: (source) ¶

overridden in fiftyone.factory.repos.execution_store.InMemoryExecutionStoreRepo, fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

Update the TTL of a key.

Parameters
store_name:`str`	the name of the store to update the TTL for
key:`str`	the key to update the TTL for
ttl:`int`	the new TTL
Returns
`bool`	True if the TTL was updated, False otherwise

_dataset_id = (source) ¶

Undocumented