1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
.. _api_docs:
API Documentation
=================
``tinydb.database``
-------------------
.. autoclass:: tinydb.database.TinyDB
:members:
:private-members:
:member-order: bysource
.. _table_api:
``tinydb.table``
----------------
.. autoclass:: tinydb.table.Table
:members:
:special-members:
:exclude-members: __dict__, __weakref__
:member-order: bysource
.. autoclass:: tinydb.table.Document
:members:
:special-members:
:exclude-members: __dict__, __weakref__
:member-order: bysource
.. py:attribute:: doc_id
The document's id
``tinydb.queries``
------------------
.. autoclass:: tinydb.queries.Query
:members:
:special-members:
:exclude-members: __weakref__
:member-order: bysource
.. autoclass:: tinydb.queries.QueryInstance
:members:
:special-members:
:exclude-members: __weakref__
:member-order: bysource
``tinydb.operations``
---------------------
.. automodule:: tinydb.operations
:members:
:special-members:
:exclude-members: __weakref__
:member-order: bysource
``tinydb.storage``
------------------
.. automodule:: tinydb.storages
:members: JSONStorage, MemoryStorage
:special-members:
:exclude-members: __weakref__
.. class:: Storage
The abstract base class for all Storages.
A Storage (de)serializes the current state of the database and stores
it in some place (memory, file on disk, ...).
.. method:: read()
Read the last stored state.
.. method:: write(data)
Write the current state of the database to the storage.
.. method:: close()
Optional: Close open file handles, etc.
``tinydb.middlewares``
----------------------
.. automodule:: tinydb.middlewares
:members: CachingMiddleware
:special-members:
:exclude-members: __weakref__
.. class:: Middleware
The base class for all Middlewares.
Middlewares hook into the read/write process of TinyDB allowing you to
extend the behaviour by adding caching, logging, ...
If ``read()`` or ``write()`` are not overloaded, they will be forwarded
directly to the storage instance.
.. attribute:: storage
:type: :class:`.Storage`
Access to the underlying storage instance.
.. method:: read()
Read the last stored state.
.. method:: write(data)
Write the current state of the database to the storage.
.. method:: close()
Optional: Close open file handles, etc.
``tinydb.utils``
----------------
.. autoclass:: tinydb.utils.LRUCache
:members:
:special-members:
|
