Skip to content

Commit 1642289

Browse files
committed
Docs: Add unreleased features
1 parent a254a3d commit 1642289

2 files changed

Lines changed: 138 additions & 126 deletions

File tree

README.rst

Lines changed: 69 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -163,61 +163,67 @@ extensions: Contributions to TinyDB are welcome! Here's how to get started:
163163
Changelog
164164
*********
165165

166-
**v3.5.0** (2017-08-30)
167-
=======================
166+
*unreleased*
167+
============
168+
169+
- Allow updating all documents using ``db.update(fields)`` (see
170+
`issue #157 <https://github.com/msiemens/tinydb/issues/157>`_).
171+
172+
v3.5.0 (2017-08-30)
173+
===================
168174

169175
- Expose the table name via ``table.name`` (see
170-
`issue #148 <https://github.com/msiemens/tinydb/issues/147>`_).
176+
`issue #147 <https://github.com/msiemens/tinydb/issues/147>`_).
171177
- Allow better subclassing of the ``TinyDB`` class
172178
(see `pull request #150 <https://github.com/msiemens/tinydb/pull/150>`_).
173179

174-
**v3.4.1** (2017-08-23)
175-
=======================
180+
v3.4.1 (2017-08-23)
181+
===================
176182

177183
- Expose TinyDB version via ``import tinyb; tinydb.__version__`` (see
178184
`issue #148 <https://github.com/msiemens/tinydb/issues/148>`_).
179185

180-
**v3.4.0** (2017-08-08)
181-
=======================
186+
v3.4.0 (2017-08-08)
187+
===================
182188

183189
- Add new update operations: ``add(key, value)``, ``substract(key, value)``,
184190
and ``set(key, value)``
185191
(see `pull request #145 <https://github.com/msiemens/tinydb/pull/145>`_).
186192

187-
**v3.3.1** (2017-06-27)
188-
=======================
193+
v3.3.1 (2017-06-27)
194+
===================
189195

190196
- Use relative imports to allow vendoring TinyDB in other packages
191197
(see `pull request #142 <https://github.com/msiemens/tinydb/pull/142>`_).
192198

193-
**v3.3.0** (2017-06-05)
194-
=======================
199+
v3.3.0 (2017-06-05)
200+
===================
195201

196202
- Allow iterating over a database or table yielding all elements
197203
(see `pull request #139 <https://github.com/msiemens/tinydb/pull/139>`_).
198204

199-
**v3.2.3** (2017-04-22)
200-
=======================
205+
v3.2.3 (2017-04-22)
206+
===================
201207

202208
- Fix bug with accidental modifications to the query cache when modifying
203209
the list of search results (see `issue #132 <https://github.com/msiemens/tinydb/issues/132>`_).
204210

205-
**v3.2.2** (2017-01-16)
206-
=======================
211+
v3.2.2 (2017-01-16)
212+
===================
207213

208214
- Fix the ``Query`` constructor to prevent wrong usage
209215
(see `issue #117 <https://github.com/msiemens/tinydb/issues/117>`_).
210216

211-
**v3.2.1** (2016-06-29)
212-
=======================
217+
v3.2.1 (2016-06-29)
218+
===================
213219

214220
- Fix a bug with queries on elements that have a ``path`` key
215221
(see `pull request #107 <https://github.com/msiemens/tinydb/pull/107>`_).
216222
- Don't write to the database file needlessly when opening the database
217223
(see `pull request #104 <https://github.com/msiemens/tinydb/pull/104>`_).
218224

219-
**v3.2.0** (2016-04-25)
220-
=======================
225+
v3.2.0 (2016-04-25)
226+
===================
221227

222228
- Add a way to specify the default table name via `default_table <http://tinydb.readthedocs.io/en/v3.2.0/usage.html#default-table>`_
223229
(see `pull request #98 <https://github.com/msiemens/tinydb/pull/98>`_).
@@ -228,38 +234,38 @@ Changelog
228234

229235
- Extend API documentation (see `issue #96 <https://github.com/msiemens/tinydb/issues/96>`_).
230236

231-
**v3.1.3** (2016-02-14)
232-
=======================
237+
v3.1.3 (2016-02-14)
238+
===================
233239

234240
- Fix a bug when that breaks the JSONStorage when the ``TinyDB`` instance gets garbagge collected
235241
(see `issue #92 <https://github.com/msiemens/tinydb/issues/92>`_).
236242

237-
**v3.1.2** (2016-01-30)
238-
=======================
243+
v3.1.2 (2016-01-30)
244+
===================
239245

240246
- Fix a bug when using unhashable elements (lists, dicts) with
241247
``Query.any`` or ``Query.all`` queries
242248
(see `a forum post by karibul <https://forum.m-siemens.de/d/4-error-with-any-and-all-queries>`_).
243249

244-
**v3.1.1** (2016-01-23)
245-
=======================
250+
v3.1.1 (2016-01-23)
251+
===================
246252

247253
- Inserting a dictionary with data that is not JSON serializable doesn't
248254
lead to corrupt files anymore (see `issue #89 <https://github.com/msiemens/tinydb/issues/89>`_).
249255
- Fix a bug in the LRU cache that may lead to an invalid query cache
250256
(see `issue #87 <https://github.com/msiemens/tinydb/issues/87>`_).
251257

252-
**v3.1.0** (2015-12-31)
253-
=======================
258+
v3.1.0 (2015-12-31)
259+
===================
254260

255261
- ``db.update(...)`` and ``db.remove(...)`` now return affected element IDs
256262
(see `issue #83 <https://github.com/msiemens/tinydb/issues/83>`_).
257263
- Inserting an invalid element (i.e. not a ``dict``) now raises an error
258264
instead of corrupting the database (see
259265
`issue #74 <https://github.com/msiemens/tinydb/issues/74>`_).
260266

261-
**v3.0.0** (2015-11-13)
262-
=======================
267+
v3.0.0 (2015-11-13)
268+
===================
263269

264270
- Overhauled Query model:
265271

@@ -287,15 +293,15 @@ Changelog
287293
.. _msiemens/tinydb-smartcache: https://github.com/msiemens/tinydb-smartcache
288294
.. _msiemens/tinydb-serialization: https://github.com/msiemens/tinydb-serialization
289295

290-
**v2.4.0** (2015-08-14)
291-
=======================
296+
v2.4.0 (2015-08-14)
297+
===================
292298

293299
- Allow custom parameters for custom test functions
294300
(see `issue #63 <https://github.com/msiemens/tinydb/issues/63>`_ and
295301
`pull request #64 <https://github.com/msiemens/tinydb/pull/64>`_).
296302

297-
**v2.3.2** (2015-05-20)
298-
=======================
303+
v2.3.2 (2015-05-20)
304+
===================
299305

300306
- Fix a forgotten debug output in the ``SerializationMiddleware``
301307
(see `issue #55 <https://github.com/msiemens/tinydb/issues/55>`_).
@@ -304,14 +310,14 @@ Changelog
304310
- Fix a problem with symlinks when checking out TinyDB on OSX Yosemite
305311
(see `issue #52 <https://github.com/msiemens/tinydb/issues/52>`_).
306312

307-
**v2.3.1** (2015-04-30)
308-
=======================
313+
v2.3.1 (2015-04-30)
314+
===================
309315

310316
- Hopefully fix a problem with using TinyDB as a dependency in a ``setup.py`` script
311317
(see `issue #51 <https://github.com/msiemens/tinydb/issues/51>`_).
312318

313-
**v2.3.0** (2015-04-08)
314-
=======================
319+
v2.3.0 (2015-04-08)
320+
===================
315321

316322
- Added support for custom serialization. That way, you can teach TinyDB
317323
to store ``datetime`` objects in a JSON file :)
@@ -321,20 +327,20 @@ Changelog
321327
(see `issue #49 <https://github.com/msiemens/tinydb/issues/49>`_)
322328
- Internal code has been cleaned up
323329

324-
**v2.2.2** (2015-02-12)
325-
=======================
330+
v2.2.2 (2015-02-12)
331+
===================
326332

327333
- Fixed a data loss when using ``CachingMiddleware`` together with ``JSONStorage``
328334
(see `issue #47 <https://github.com/msiemens/tinydb/issues/47>`_)
329335

330-
**v2.2.1** (2015-01-09)
331-
=======================
336+
v2.2.1 (2015-01-09)
337+
===================
332338

333339
- Fixed handling of IDs with the JSON backend that converted integers
334340
to strings (see `issue #45 <https://github.com/msiemens/tinydb/issues/45>`_)
335341

336-
**v2.2.0** (2014-11-10)
337-
=======================
342+
v2.2.0 (2014-11-10)
343+
===================
338344

339345
- Extended ``any`` and ``all`` queries to take lists as conditions
340346
(see `pull request #38 <https://github.com/msiemens/tinydb/pull/38>`_)
@@ -343,22 +349,22 @@ Changelog
343349
- Fixed some issues with ``CachingMiddleware`` in combination with
344350
``JSONStorage`` (see `pull request #39 <https://github.com/msiemens/tinydb/pull/39>`_)
345351

346-
**v2.1.0** (2014-10-14)
347-
=======================
352+
v2.1.0 (2014-10-14)
353+
===================
348354

349355
- Added ``where(...).contains(regex)``
350356
(see `issue #32 <https://github.com/msiemens/tinydb/issues/32>`_)
351357
- Fixed a bug that corrupted data after reopening a database
352358
(see `issue #34 <https://github.com/msiemens/tinydb/issues/34>`_)
353359

354-
**v2.0.1** (2014-09-22)
355-
=======================
360+
v2.0.1 (2014-09-22)
361+
===================
356362

357363
- Fixed handling of Unicode data in Python 2
358364
(see `issue #28 <https://github.com/msiemens/tinydb/issues/28>`_).
359365

360-
**v2.0.0** (2014-09-05)
361-
=======================
366+
v2.0.0 (2014-09-05)
367+
===================
362368

363369
`Upgrade Notes <http://tinydb.readthedocs.io/en/v2.0/upgrade.html#upgrade-v2-0>`_
364370

@@ -377,46 +383,46 @@ for details.
377383
- Added optional `smart query caching <http://tinydb.readthedocs.io/en/v2.0.0/usage.html#smart-query-cache>`_.
378384
- The query cache is now a `fixed size LRU cache <http://tinydb.readthedocs.io/en/v2.0.0/usage.html#query-caching>`_.
379385

380-
**v1.4.0** (2014-07-22)
381-
=======================
386+
v1.4.0 (2014-07-22)
387+
===================
382388

383389
- Added ``insert_multiple`` function
384390
(see `issue #8 <https://github.com/msiemens/tinydb/issues/8>`_).
385391

386-
**v1.3.0** (2014-07-02)
387-
=======================
392+
v1.3.0 (2014-07-02)
393+
===================
388394

389395
- Fixed `bug #7 <https://github.com/msiemens/tinydb/issues/7>`_: IDs not unique.
390396
- Extended the API: ``db.count(where(...))`` and ``db.contains(where(...))``.
391397
- The syntax ``query in db`` is now **deprecated** and replaced
392398
by ``db.contains``.
393399

394-
**v1.2.0** (2014-06-19)
395-
=======================
400+
v1.2.0 (2014-06-19)
401+
===================
396402

397403
- Added ``update`` method
398404
(see `issue #6 <https://github.com/msiemens/tinydb/issues/6>`_).
399405

400-
**v1.1.1** (2014-06-14)
401-
=======================
406+
v1.1.1 (2014-06-14)
407+
===================
402408

403409
- Merged `PR #5 <https://github.com/msiemens/tinydb/pull/5>`_: Fix minor
404410
documentation typos and style issues.
405411

406-
**v1.1.0** (2014-05-06)
407-
=======================
412+
v1.1.0 (2014-05-06)
413+
===================
408414

409415
- Improved the docs and fixed some typos.
410416
- Refactored some internal code.
411417
- Fixed a bug with multiple ``TinyDB?`` instances.
412418

413-
**v1.0.1** (2014-04-26)
414-
=======================
419+
v1.0.1 (2014-04-26)
420+
===================
415421

416422
- Fixed a bug in ``JSONStorage`` that broke the database when removing entries.
417423

418-
**v1.0.0** (2013-07-20)
419-
=======================
424+
v1.0.0 (2013-07-20)
425+
===================
420426

421427
- First official release – consider TinyDB stable now.
422428

0 commit comments

Comments
 (0)