Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 53 lines (34 sloc) 2.312 kB
a9466d2 @ownport adopt README.rst after migration from Markdown
authored
1 ======
2 kvlite
3 ======
cd8d344 @ownport update README
authored
4
e410e42 @ownport updated README
authored
5 kvlite is small open-source library for storing documents in SQL databases. Only three methods are needed to manipulate documents in database: get(), put(), delete(). At the moment supported MySQL and SQLite databases only. A document can be string, list/tuple or dictionary. Default serialization is based on cPickleSerializer methods but of course it is possible to define own serialization to store data in kvlite databases.
2c3e46e @ownport Initial commit
authored
6
35a1669 @ownport update docs
authored
7 A ``document`` is a string, list/tuple, dictionary or any structure which can be serialized by cPickle, JSON or own serializer.
2a6a8c5 @ownport fix typo in README.rst
authored
8
9 A ``collection`` is a group of documents stored in kvlite. It can be thought of as roughly the equivalent of a table in a relational database.
10
0a62958 @ownport fix typo in README.rst
authored
11 The format of ``uri`` (uniform resource identifier) for databases:
12
db670f7 @ownport fix typo in README.rst
authored
13 * for mysql: 'mysql://username:password@hostname:port/database.collection_name'
14 * for sqlite: 'sqlite://path-to-sqlite-file:collection_name' or 'sqlite://memory:collection_name'
0a62958 @ownport fix typo in README.rst
authored
15
9e5e192 @ownport update README
authored
16 In case when sqlite is in use two variants of collection is possible: store data in file or store data in memory.
6096378 @ownport readme update
authored
17
5168b68 @ownport added notes about access to kvlite data
authored
18 There's two ways how to simplify access to kvlite's data: command line and web interface. Command line:
19
11f9bf4 @ownport fix typo
authored
20 python -mkvlite.cli
5168b68 @ownport added notes about access to kvlite data
authored
21
22 Web interface:
23
24 python -mkvlite.webui
a9466d2 @ownport adopt README.rst after migration from Markdown
authored
25
c46f42e @ownport Installation section moved to separated document
authored
26 Installation
27 ============
28
2d125de @ownport prepare docs for master branch
authored
29 please check installation guideline <https://github.com/ownport/kvlite/blob/master/docs/install.md>
c46f42e @ownport Installation section moved to separated document
authored
30
a59ec25 @ownport update docs
authored
31 Usage
32 =====
845385d @ownport preparation before merge with master
authored
33 - Examples <https://github.com/ownport/kvlite/blob/master/docs/examples.md>
2d125de @ownport prepare docs for master branch
authored
34 - Search criterias <https://github.com/ownport/kvlite/blob/master/docs/search-criterias.md>
a59ec25 @ownport update docs
authored
35
badc22d @ownport update docs
authored
36 Developer interface
37 ===================
2d125de @ownport prepare docs for master branch
authored
38 - Utils <https://github.com/ownport/kvlite/blob/master/docs/api.md#collection-utils>
39 - Collection <https://github.com/ownport/kvlite/blob/master/docs/api.md#collection>
40 - CollectionManager <https://github.com/ownport/kvlite/blob/master/docs/api.md#collectionmanager>
41 - Serializers <https://github.com/ownport/kvlite/blob/master/docs/api.md#serializers>
42 - kvlite diagram <https://raw.github.com/ownport/kvlite/master/docs/kvlite.png>
a59ec25 @ownport update docs
authored
43
44 Articles
45 ========
2d125de @ownport prepare docs for master branch
authored
46 - How FriendFeed uses MySQL to store schema-less data <https://github.com/ownport/kvlite/blob/master/docs/articles/friendfeed-mysql-datastore.md>
badc22d @ownport update docs
authored
47
a59ec25 @ownport update docs
authored
48 Links
49 =====
2d125de @ownport prepare docs for master branch
authored
50 - Links <https://github.com/ownport/kvlite/blob/master/docs/links.md>
ac151af @ownport update docs
authored
51
fb638ca @ownport update README
authored
52
Something went wrong with that request. Please try again.