aboutsummaryrefslogtreecommitdiff
path: root/python/pickleshare/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/pickleshare/README')
-rw-r--r--python/pickleshare/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/python/pickleshare/README b/python/pickleshare/README
new file mode 100644
index 0000000000000..c7c034a911541
--- /dev/null
+++ b/python/pickleshare/README
@@ -0,0 +1,9 @@
+PickleShare is a small shelve-like datastore with concurrency support.
+
+Like shelve, a PickleShareDB object acts like a normal dictionary. Unlike
+shelve, many processes can access the database simultaneously. Changing a value
+in database is immediately visible to other processes accessing the same
+database.
+
+Concurrency is possible because the values are stored in separate files. Hence
+the "database" is a directory where all files are governed by PickleShare.