8ff5d93097268d11ff17b9094b687fbf77f85127
[tiramisu.git] / doc / storage.txt
1 Storage
2 =======
3
4 Config's informations are, by default, volatiles. This means, all values and
5 settings changes will be lost.
6
7 The storage is the system Tiramisu uses to communicate with various DB.
8 You can specified a persistent storage.
9
10 .. image:: storage.png
11
12 .. automodule:: tiramisu.storage
13
14 .. automethod:: tiramisu.storage.set_storage
15
16 Dictionary
17 ~~~~~~~~~~
18
19 .. automodule:: tiramisu.storage.dictionary
20
21 Dictionary settings:
22
23 .. automethod:: tiramisu.storage.dictionary.storage.Setting
24
25 Sqlite3
26 ~~~~~~~
27
28 .. automodule:: tiramisu.storage.sqlite3
29
30 Sqlite3 settings:
31
32 .. automethod:: tiramisu.storage.sqlite3.storage.Setting
33
34 Example
35 ~~~~~~~
36
37 >>> from tiramisu.option import StrOption, OptionDescription
38 >>> from tiramisu.config import Config
39 >>> from tiramisu.storage import set_storage
40 >>> set_storage('sqlite3', dir_database='/tmp/tiramisu')
41 >>> s = StrOption('str', '')
42 >>> o = OptionDescription('od', '', [s])
43 >>> c1 = Config(o, persistent=True, session_id='xxxx')
44 >>> c1.str
45 >>> c1.str = 'yes'
46 >>> c1.str
47 'yes'
48 >>> del(c1)
49 >>> c2 = Config(o, persistent=True, session_id='xxxx')
50 >>> c2.str
51 'yes'
52