Callbacks

	CacheForeachFunc (cache, uid, revision, object, offline_state, column_names, column_values, *user_data)
	CacheKeysForeachFunc (self, key, value, ref_count, *user_data)
	CacheSelectFunc (cache, column_names, column_values, *user_data)
	CacheUpdateFunc (cache, uid, revision, object, offline_state, column_names, column_values, *user_data)

Details

EBackend.CacheForeachFunc(cache, uid, revision, object, offline_state, column_names, column_values, *user_data)

Parameters:

• cache (EBackend.Cache) – an EBackend.Cache

• uid (str) – a unique object identifier

• revision (str) – the object revision

• object (str) – the object itself

• offline_state (EBackend.OfflineState) – objects offline state, one of EBackend.OfflineState

• column_names ([str]) – column names

• column_values ([str]) – column values

• user_data (object or None) – user data, as used in EBackend.Cache.foreach()

Returns:

True to continue, False to stop walk through.

Return type:

bool

A callback called for each object row when using EBackend.Cache.foreach() function.

New in version 3.26.

EBackend.CacheKeysForeachFunc(self, key, value, ref_count, *user_data)

Parameters:

• self (EBackend.CacheKeys) – an EBackend.CacheKeys

• key (str) – the key

• value (str) – the value

• ref_count (int) – the reference count for the key

• user_data (object or None) – user data, as used in EBackend.CacheKeys.foreach_sync()

Returns:

True to continue, False to stop walk through.

Return type:

bool

A callback called for each row of the self table when using EBackend.CacheKeys.foreach_sync() function.

New in version 3.48.

EBackend.CacheSelectFunc(cache, column_names, column_values, *user_data)

Parameters:

• cache (EBackend.Cache) – an EBackend.Cache

• column_names ([str]) – column names

• column_values ([str]) – column values

• user_data (object or None) – user data, as used in EBackend.Cache.sqlite_select()

Returns:

True to continue, False to stop walk through.

Return type:

bool

A callback called for each row of a SELECT statement executed with EBackend.Cache.sqlite_select() function.

New in version 3.26.

EBackend.CacheUpdateFunc(cache, uid, revision, object, offline_state, column_names, column_values, *user_data)

Parameters:

• cache (EBackend.Cache) – an EBackend.Cache

• uid (str) – a unique object identifier

• revision (str) – the object revision

• object (str) – the object itself

• offline_state (EBackend.OfflineState) – objects offline state, one of EBackend.OfflineState

• column_names ([str]) – column names

• column_values ([str]) – column values

• user_data (object or None) – user data, as used in EBackend.Cache.foreach_update()

Returns:

True to continue, False to stop walk through.

out_revision:

the new object revision to set; keep it untouched to not change

out_object:

the new object to set; keep it untouched to not change

out_offline_state:

the offline state to set; the default is the same as offline_state

out_other_columns:

an EBackend.CacheColumnValues with other columns to set; keep it untouched to not change any

Return type:

(bool, out_revision: str, out_object: str, out_offline_state: EBackend.OfflineState, out_other_columns: EBackend.CacheColumnValues)

A callback called for each object row when using EBackend.Cache.foreach_update() function. When all out parameters are left untouched, then the row is not changed.

New in version 3.26.