devbase v0.0.10

Devbase Database

Devbase es una base de datos en tiempo real, rápida, simple e intuitiva creada bajo nodejs, por lo que es un paquete más que instalar. Lo primero seria instalar el paquete devbase desde npm al proyecto.

npm install devbase

Para manejar la base de datos de devbase luego de la instalación, se utiliza el paquete de nodejs que se instala junto al cliente.

Puedes leer la documentación completa en la wiki del repositorio en github.com.

Lo primero para empezar a utilizar la colección creada es importar el paquete devbase y crear una instancia del mismo especificando la colección que se desea acceder.

const devbase = require('devbase')
const usuarios = new devbase('usuarios')

En caso de que la colección no exista, Devbase creará una.

Devbase permite utilizar archivos json ya existentes, por lo que en vez de especifiar el nombre de la colección se especifca la ruta donde se encuentra el archivo json.

const devbase = require('devbase')
const usuarios = new devbase('./datos.json')

Documentos

Crear un documento

Con la función set se agrega un documento a la colección y toma por parametro la información a agregar y retorna un objeto javascript con los datos ingresados como data y el identificador uid asignado aleatoriamente.

const { uid } = usuarios.add({ nombre: 'andrés celis', edad: 16 })
uid // 1h9dgv4va3x0zh6x

Si desea establecer el identificador, utilice la función set que toma por parametros el identificador y la información del nuevo documento.

usuarios.set('adwher', { nombre: 'andrés celis', edad: 17 })

Obtener un documento

La función doc toma por parametro el identificador uid y retorna el contenido del documento en ese momento, no en tiempo real.

usuarios.doc('1h9dgv4va3x0zh6x').edad // 17

La función permite navegar por el documento en caso de que este contenga un objeto, permitiendo el libre desplazamiento por los datos del documento.

usuarios.doc('1h9dgv4va3x0zh6x.edad') // 17

La función de acceso directo no permite encontrar dentro de arreglos o matrices

Actualizar un documento

Con el metodo update se actualiza los datos de un documento, tomando por parametros el identificador uid y el nuevo conjunto de datos, esto retorna la nueva información en data y el identificador uid.

usuarios.update('1h9dgv4va3x0zh6x', { edad: 18 })
usuarios.doc('1h9dgv4va3x0zh6x.edad') // 18

Se sobre escribe los elementos que contengan las mismas características, en caso de que el documento sea un objeto de varios elementos, solo se va a actualizar los que se desean.

En caso de necesitar sobre escribir los datos en una cierta colección, utilice la función set con el identificador del documento y el nuevo dato

Buscar un documento

Una colección puede tener n documentos con uid que no se pueden recordar, para buscar un documento dentro de una colección, sea aplica la función where de la colección. La función toma por parametro un callback a modo de condicción, esto retorna un arreglo con el contenido los documentos que cumplan la condicción y junto a el identificador.

usuarios.where(usuario => usuario.edad < 19)

Eliminar un documento

Para eliminar un documento de la colección, se utiliza la función remove que toma por parametro el identificador uid del documento.

usuarios.remove('1h9dgv4va3x0zh6x') // el documento fue eliminado

Puedes leer la documentación oficial de Devbase, donde encontraras material extra como eventos y portabilidad.

LICENSE MIT - Andrés Celis / Adwher