tinydb

快速連結

• 範例程式碼
• 支援的 Python 版本
• 文件
• 變更日誌
• 擴充
• 貢獻

介紹

TinyDB 是一個輕量級的文件導向的資料庫，專為您的幸福而最佳化:) 它是用純 Python 編寫的，沒有外部依賴項。目標是會被 SQL-DB 或外部資料庫伺服器破壞的小型應用程式。

TinyDB 是：

• tiny：目前原始程式碼有 1800 行程式碼（約 40% 文件）和 1600 行測試。
• 面向文件：與 MongoDB 一樣，您可以在 TinyDB 中儲存任何文件（表示為dict ）。
• 為您的幸福而最佳化： TinyDB 透過提供簡單乾淨的 API 來設計得簡單且使用起來有趣。
• 用純 Python 編寫： TinyDB 既不需要外部伺服器（例如 PyMongo），也不需要 PyPI 的任何依賴項。
• 適用於 Python 3.8+ 和 PyPy3： TinyDB 適用於所有現代版本的 Python 和 PyPy。
• 強大的可擴充性：您可以透過編寫新儲存空間或使用中間件修改儲存的行為來輕鬆擴充TinyDB。
• 100% 測試覆蓋率：無需解釋。

若要直接了解所有細節，請造訪 TinyDB 文件。您也可以在討論論壇上討論與 TinyDB 相關的所有內容，例如一般開發、擴充或展示您基於 TinyDB 的專案。

支援的 Python 版本

TinyDB 已使用 Python 3.8 - 3.13 和 PyPy3 進行了測試。

項目狀況

該項目正處於維護模式。它已經達到了成熟、穩定的狀態，沒有規劃重大的新功能或架構變更。也就是說，仍然會發布針對社群貢獻的錯誤修復或功能的版本。詳細了解這意味著什麼，特別是在這裡。

範例程式碼

 > >> from tinydb import TinyDB , Query
> >> db = TinyDB ( '/path/to/db.json' )
> >> db . insert ({ 'int' : 1 , 'char' : 'a' })
> >> db . insert ({ 'int' : 1 , 'char' : 'b' })

查詢語言

 > >> User = Query ()
> >> # Search for a field value
>> > db . search ( User . name == 'John' )
[{ 'name' : 'John' , 'age' : 22 }, { 'name' : 'John' , 'age' : 37 }]

> >> # Combine two queries with logical and
>> > db . search (( User . name == 'John' ) & ( User . age <= 30 ))
[{ 'name' : 'John' , 'age' : 22 }]

> >> # Combine two queries with logical or
>> > db . search (( User . name == 'John' ) | ( User . name == 'Bob' ))
[{ 'name' : 'John' , 'age' : 22 }, { 'name' : 'John' , 'age' : 37 }, { 'name' : 'Bob' , 'age' : 42 }]

> >> # Negate a query with logical not
>> > db . search ( ~ ( User . name == 'John' ))
[{ 'name' : 'Megan' , 'age' : 27 }, { 'name' : 'Bob' , 'age' : 42 }]

> >> # Apply transformation to field with `map`
>> > db . search (( User . age . map ( lambda x : x + x ) == 44 ))
> >> [{ 'name' : 'John' , 'age' : 22 }]

> >> # More possible comparisons:  !=  <  >  <=  >=
>> > # More possible checks: where(...).matches(regex), where(...).test(your_test_func)

表格

 > >> table = db . table ( 'name' )
> >> table . insert ({ 'value' : True })
> >> table . all ()
[{ 'value' : True }]

使用中介軟體

 > >> from tinydb . storages import JSONStorage
> >> from tinydb . middlewares import CachingMiddleware
> >> db = TinyDB ( '/path/to/db.json' , storage = CachingMiddleware ( JSONStorage ))

貢獻

無論是報告錯誤、討論改進和新想法還是編寫擴充功能：歡迎為 TinyDB 做出貢獻！以下是如何開始：

1. 檢查未解決的問題或開啟新問題以圍繞功能想法或錯誤開始討論
2. 在 Github 上分叉儲存庫，在 master 分支上建立新分支並開始進行變更（稱為 GitHub Flow）
3. 編寫一個測試，顯示錯誤已修復或功能按預期工作
4. 發送拉取請求並向維護者發出錯誤，直到它被合併並發布 ☺