tinydb

Enlaces rápidos

• Código de ejemplo
• Versiones de Python compatibles
• Documentación
• Registro de cambios
• Extensiones
• Contribuyendo

Introducción

TinyDB es una base de datos liviana orientada a documentos optimizada para tu felicidad :) Está escrita en Python puro y no tiene dependencias externas. El objetivo son aplicaciones pequeñas que quedarían impresionadas por un SQL-DB o un servidor de base de datos externo.

TinyDB es:

• minúsculo: El código fuente actual tiene 1800 líneas de código (con aproximadamente un 40% de documentación) y 1600 líneas de prueba.
• orientado a documentos: al igual que MongoDB, puede almacenar cualquier documento (representado como dict ) en TinyDB.
• optimizado para su felicidad: TinyDB está diseñado para ser simple y divertido de usar al proporcionar una API simple y limpia.
• Escrito en Python puro: TinyDB no necesita un servidor externo (como, por ejemplo, PyMongo) ni ninguna dependencia de PyPI.
• funciona en Python 3.8+ y PyPy3: TinyDB funciona en todas las versiones modernas de Python y PyPy.
• poderosamente extensible: puede extender fácilmente TinyDB escribiendo nuevos almacenamientos o modificando el comportamiento de los almacenamientos con Middlewares.
• Cobertura de prueba del 100%: no se necesitan explicaciones.

Para profundizar directamente en todos los detalles, diríjase a los documentos de TinyDB. También puede discutir todo lo relacionado con TinyDB, como desarrollo general, extensiones o mostrar sus proyectos basados ​​en TinyDB en el foro de discusión.

Versiones de Python compatibles

TinyDB ha sido probado con Python 3.8 - 3.13 y PyPy3.

Estado del proyecto

Este proyecto está en modo de mantenimiento. Ha alcanzado un estado maduro y estable donde no se planean nuevas características significativas o cambios arquitectónicos. Dicho esto, todavía habrá lanzamientos para correcciones de errores o funciones aportadas por la comunidad. Lea más sobre lo que esto significa en particular aquí.

Código de ejemplo

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

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

Mesas

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

Usando software intermedio

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

Contribuyendo

Ya sea reportando errores, discutiendo mejoras y nuevas ideas o escribiendo extensiones: ¡Las contribuciones a TinyDB son bienvenidas! A continuación le indicamos cómo empezar:

1. Busque problemas abiertos o abra un problema nuevo para iniciar una discusión sobre una idea de característica o un error.
2. Bifurca el repositorio en Github, crea una nueva rama a partir de la rama maestra y comienza a realizar tus cambios (conocido como GitHub Flow).
3. Escriba una prueba que demuestre que el error se solucionó o que la función funciona como se esperaba.
4. Envía una solicitud de extracción y molesta al mantenedor hasta que se fusione y se publique ☺