API Documentation

PickleDB()

PickleDB(path) → Initialize a PickleDB instance with the specified path.

• path: The path to the database file.

PickleDB Class Methods

set(key, value) → Add or update a key-value pair in the database.

• key: The key to set. Converted to string if not already.
• value: The value to associate with the key. This can be any JSON serializable Python data type.
• Returns: True.

get(key) → Retrieve the value associated with a key.

• key: The key to retrieve.
• Returns: The value associated with the key, or None if the key does not exist.

remove(key) → Delete a key and its value from the database.

• key: The key to delete.
• Returns: True if the key was deleted, or False if the key does not exist.

all() → Retrieve a list of all keys in the database.

• Returns: A list of keys.

purge() → Clear all keys and values from the database.

• Returns: True.

save(option) → Save the current state of the database to the file.

• option: OPTIONAL argument to pass `orjson.OPT_*` flags to configure serialization behavior.
• Returns: True if the operation succeeds, or False otherwise.

AsyncPickleDB(PickleDB)

AsyncPickleDB(path) → Initialize an AsyncPickleDB instance with the specified path.

• path: The path to the database file.

AsyncPickleDB Class Methods

aset(key, value) → Asynchronously add or update a key-value pair in the database.

• key: The key to set. Converted to string if not already.
• value: The value to associate with the key. This can be any JSON serializable Python data type.
• Returns: True.

aget(key) → Asynchronously retrieve the value associated with a key.

• key: The key to retrieve.
• Returns: The value associated with the key, or None if the key does not exist.

aremove(key) → Asynchronously delete a key and its value from the database.

• key: The key to delete.
• Returns: True if the key was deleted, or False if the key does not exist.

aall() → Asynchronously retrieve a list of all keys in the database.

• Returns: A list of keys.

apurge() → Asynchronously clear all keys and values from the database.

• Returns: True.

asave() → Asynchronously save the current state of the database to the file.

• Returns: True if the operation succeeds, or False otherwise.

Suggestions

If you would like to suggest an improvement or report an issue, please create an issue on GitHub.