tinydb

Links rápidos

• Código de exemplo
• Versões Python suportadas
• Documentação
• Registro de alterações
• Extensões
• Contribuindo

Introdução

TinyDB é um banco de dados leve orientado a documentos otimizado para sua felicidade :) Ele é escrito em Python puro e não possui dependências externas. O alvo são pequenos aplicativos que seriam destruídos por um banco de dados SQL ou um servidor de banco de dados externo.

TinyDB é:

• minúsculo: O código-fonte atual possui 1.800 linhas de código (com cerca de 40% de documentação) e 1.600 linhas de testes.
• orientado a documentos: como o MongoDB, você pode armazenar qualquer documento (representado como dict ) no TinyDB.
• otimizado para sua felicidade: TinyDB foi projetado para ser simples e divertido de usar, fornecendo uma API simples e limpa.
• escrito em Python puro: TinyDB não precisa de um servidor externo (como por exemplo PyMongo) nem de quaisquer dependências do PyPI.
• funciona em Python 3.8+ e PyPy3: TinyDB funciona em todas as versões modernas de Python e PyPy.
• poderosamente extensível: você pode estender facilmente o TinyDB escrevendo novos armazenamentos ou modificando o comportamento dos armazenamentos com Middlewares.
• Cobertura de teste de 100%: Nenhuma explicação necessária.

Para mergulhar direto em todos os detalhes, acesse a documentação do TinyDB. Você também pode discutir tudo relacionado ao TinyDB, como desenvolvimento geral, extensões ou mostrar seus projetos baseados em TinyDB no fórum de discussão.

Versões Python suportadas

TinyDB foi testado com Python 3.8 - 3.13 e PyPy3.

Status do projeto

Este projeto está em modo de manutenção. Atingiu um estado maduro e estável onde não são planeados novos recursos significativos ou alterações arquitetónicas. Dito isto, ainda haverá lançamentos para correções de bugs ou recursos contribuídos pela comunidade. Leia mais sobre o que isso significa em particular aqui.

Código de exemplo

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

Linguagem de consulta

 > >> 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)

Tabelas

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

Usando Middlewares

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

Contribuindo

Seja relatando bugs, discutindo melhorias e novas ideias ou escrevendo extensões: Contribuições para o TinyDB são bem-vindas! Veja como começar:

1. Verifique se há problemas em aberto ou abra um novo problema para iniciar uma discussão sobre uma ideia de recurso ou um bug
2. Bifurque o repositório no Github, crie um novo branch a partir do branch master e comece a fazer suas alterações (conhecido como GitHub Flow)
3. Escreva um teste que mostre que o bug foi corrigido ou que o recurso funciona conforme o esperado
4. Envie uma solicitação pull e buge o mantenedor até que seja mesclado e publicado ☺