Storage systems for TiddlyWeb.
The base Class and Interface for Classes used to get and put data into a storage system.
Bases: object
A Store is a collection of methods that either store an object or retrieve an object.
The interface is fairly simple: For the data entities that exist in the TiddlyWeb system there (optionally) exists <entity>_put, <entity>_get and <entity>_delete methods in each Store.
There are also five supporting methods, list_recipes(), list_bags(), list_users(), list_bag_tiddlers(), and list_tiddler_revisions() that provide methods for getting a collection.
It is useful to understand the classes in the tiddlyweb.model package when implementing new StorageInterface classes.
If a method is not implemented by the StorageInterface a StoreMethodNotImplemented exception is raised and the calling code is expected to handle that intelligently.
Remove the bag from the store, including the tiddlers within the bag.
Get a bag from the store, returning a populated bag object.
Put a bag into the store.
Retrieve a list of all tiddler objects in the named bag.
Retrieve a list of all bag objects in the system.
Retrieve a list of all recipe objects in the system.
Retrieve a list of all the revision identifiers for one tiddler.
Retrieve a list of all the user objects in the system.
Remove the recipe from the store, with no impact on the tiddlers.
Get a recipe from the store, returning a populated recipe object.
Put a recipe into the store.
Search the entire tiddler store for search_query.
Delete a tiddler from the store.
Get a tiddler from the store, returning a populated tiddler object. tiddler.creator and tiddler.created are based on the modifier and modified of the first revision of a tiddler.
Put a tiddler into the store.
Delete a user from the store.
Get a user from the store, returning a populated user object.
Put a user into the store.
A text-based StorageInterface that stores entities in the filesystem.
Bases: tiddlyweb.stores.StorageInterface
A StorageInterface which stores text-based representations in a collection of directories and files.
Delete a bag AND THE TIDDLERS WITHIN from the system.
Read a bag from the store.
Put a bag into the store, writing its name, description and policy.
List all the tiddlers in the provided bag.
List all the bags in the store.
List all the recipes in the store.
List all the revisions of one tiddler, returning a list of ints.
List all the users in the store.
Remove a recipe, irrevocably, from the system. No impact on tiddlers.
Read a recipe from the store.
Put a recipe into the store.
Search in the store for tiddlers that match search_query. This is intentionally simple, slow and broken to encourage overriding.
Irrevocably remove a tiddler and its directory.
Get a tiddler as string from a bag and deserialize it into object.
Write a tiddler into the store. We only write if the bag already exists. Bag creation is a separate action from writing to a bag.
Delete a user from the store.
Read a user from the store.
Put a user data into the store. The user’s information is store as JSON, for ease.