Learn how to use the CookieDB database with the complete documentation.
This document has the documentation for version 3.0.0
of CookieDB, check the file CHANGELOG.md to see all changes to the project.
WARNING: This version of
CookieDB
is just a package for python, it still doesn’t work as a command line program.
See here a tutorial on how to use CookieDB in an easy and objective way.
As of this version (3.0.0) the autocommit argument and the
commit
method of theCookieDB
class have been removed.
To manipulate the database, you must instantiate the CookieDB
class passing (or not) some arguments, such as:
key
: a 32-character base64 encoded key. If not specified, a default key will be used (unsafe if your database is exposed);database_local
: directory where the database will be or is, if nothing is past, the current directory will be used;
Deprecated:
autocommit
argument.
from cookiedb import CookieDB
cookiedb = CookieDB()
After that, you can perform any operation.
To create a database, use the CookieDB.create_database
method, passing (or not) some arguments:
database_name
: name of the database;if_not_exists
: optional parameter, if the database does not exist, no error
It will be released.from cookiedb import CookieDB
cookiedb = CookieDB()
cookiedb.create_database('MyDatabase')
It is only possible to open a database if it exists, otherwise a exception will be thrown. There is no secret to open, just use the CookieDB.open
method:
from cookiedb import CookieDB
cookiedb = CookieDB()
cookiedb.open('MyDatabase')
All CookieDB database files (from version 1.0.0
) have a .cookiedb
extension, when opening a database, CookieDB will look for the database name along with the .cookiedb
extension (e.g. MyDatabase.cookiedb
).
If no database is open, and write or read operations,
NoOpenDatabaseError
exception will be thrown.
If you want to know which database it is in, use the CookieDB.checkout
method:
from cookiedb import CookieDB
cookiedb = CookieDB()
cookiedb.open('MyDatabase')
cookiedb.checkout() # output: MyDatabase
If no database are open, None
will be returned.
An “item” is an object in the database, which can be a dictionary, list, string, integer or float. The path can be just a string or an integer.
To create an item, we use the CookieDB.add
method, which has the following parameters:
path
: path of the item (where its value will be stored);value
: item value.from cookiedb import CookieDB
cookiedb = CookieDB()
cookiedb.open('MyDatabase')
cookiedb.add('languages', {
'python': {
'extension': '.py',
'creator': 'Guido van Rossum'
},
'cpp': {
'extension': '.cpp',
'creator': 'Bjarne Stroustrup'
}
})
Each path, separated by “/” (slash), is a key in the JSON
file, creating an organized structure, see the example:
path = 'languages/python'
# equivalent to:
json = {
'languages': {
'python': {}
}
}
To get an item, use the CookieDB.get
method passing the argument path
with the path of the item:
from cookiedb import CookieDB
cookiedb = CookieDB()
cookiedb.open('MyDatabase')
languages = cookiedb.get('languages')
print(languages)
# or, get an item inside that item
python_info = cookiedb.get('languages/python')
print(python_info)
That is, you can get data through the path as long as the content is a dictionary (key and value).
To delete an item, use the CookieDB.delete
method passing the path that will be deleted:
from cookiedb import CookieDB
cookiedb = CookieDB()
cookiedb.open('MyDatabase')
languages = cookiedb.get('languages')
print(languages)
# delete item
cookiedb.delete('languages/python')
# updated items
languages = cookiedb.get('languages')
print(languages)
With that, just specify the path and you can delete whatever you want.