Commit5778fa8

committed

Added documentation for iterability

1 parent4b12fcd commit5778fa8Copy full SHA for 5778fa8

File tree

+12

-0

lines changed

+12

-0

lines changed

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,13 @@ Now you can get all elements stored in the database by running:`
`40`	`40`	`>>>db.all()`
`41`	`41`	`[{'count': 7, 'type': 'apple'}, {'count': 3, 'type': 'peach'}]`
`42`	`42`
	`43`	`+You can also iter over stored elements:`
	`44`	`+`
	`45`	`+>>>for itemin db:`
	`46`	`+>>>print(item)`
	`47`	`+{'count': 7, 'type': 'apple'}`
	`48`	`+{'count': 3, 'type': 'peach'}`
	`49`	`+`
`43`	`50`	`Of course you'll also want to search for specific elements. Let's try:`
`44`	`51`
`45`	`52`	`>>>Fruit= Query()`
`@@ -83,6 +90,8 @@ Before we dive deeper, let's recapitulate the basics:`
`83`	`90`	`+-------------------------------+---------------------------------------------------------------+`
`84`	`91`	\| ``db.all()``\| Get all elements\|
`85`	`92`	`+-------------------------------+---------------------------------------------------------------+`
	`93`	+\| ``iter(db)``\| Iter over all elements\|
	`94`	`++-------------------------------+---------------------------------------------------------------+`
`86`	`95`	\| ``db.search(query)``\| Get a list of elements matching the query\|
`87`	`96`	`+-------------------------------+---------------------------------------------------------------+`
`88`	`97`	`\| Updating\|`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -339,6 +339,9 @@ the ``TinyDB`` class. To create and use a table, use ``db.table(name)``.
`339`	`339`	`>>>table.insert({'value':True})`
`340`	`340`	`>>>table.all()`
`341`	`341`	`[{'value': True}]`
	`342`	`+>>>for rowin table:`
	`343`	`+>>>print(row)`
	`344`	`+{'value': True}`
`342`	`345`
`343`	`346`	`To remove a table from a database, use:`
`344`	`347`

Comments

(0)