mysql-tab

Tabla de contenidos

• Install
• Introduccion
• Uso

install

mysql-tab es un modulo de Node.js valido registrado en npm registry.

Para instalar use npm install command:

$ npm install mysql-tab

introduccion

mysql-tab es una interface de alto nivel para generar consultas en mysql Escrito en JavaScript

uso

Para usar este modulo solo es nesesario conocer un poco el api de mysql los parametros del constructor de mysqlTable son los mismos que se usarian en la funcion createConnection de mysql, usando el metodo tabla(tabla) se obtiene un objeto dbTabla que representa a la tabla con el nombre del parametro en la base de datos.

Mas documentacion sobre dbTabla..

// file ./index.js
const mysql=require("mysql-tab")
let connect= new mysql({/* params mysql */})
let test1=connect.tabla("test1")
// insert([1,"un texto","otro texto"]) tabien se acepta un objeto  
test1.insert(1,"un texto","otro texto") 
    .then(ok=>
    {
        console.log(ok)
    }).catch(e=>
    {
        console.log(e)
    })

En este caso si la tabla test1 no existe lanzara un error en catch para resolver esto podemos crear un modelo para la tabla test1 y cargarlo esto ara que se verifique la existencia y si no existe la tabla sea creada e inicializada automaticamente para esto podemos crear un diretorio que contendra los modelos por ejemplo ./model/ y crear los modelos nesesarios para el proyecto

// file ./model/test1.js 
const model=require("tabla-model")
const test2=new model("test2",[
    {
        name:"id",
        type:"int",
        primary:true,
        autoincrement:true
    },
    {
        name:"row1",
        type:"text"
    },
    {
        name:"row2",
        type:"int",
    },
    {
        name:"row3",
        type:"date",
    }
])
test2.foreingKey({ // se agrega las claves foraneas 
    key:"row2",
    reference:"test4",
    keyReference:"id_key2",
    onUpdate:'CASCADE',
    onDelete:'NO ACTION',
    // match: ' '
})
test2.insert(1,"hola",14,"2018/10/23")// datos de inicializacion 
// el parametro tabla recibira el objeto de la tabla 
// y el segundo el objeto de conexion
// y el resto los parametros pasados en la llamada
test2.method("miMetodo",(tabla,connect,...params)=>
{
    //tu codigo para el metodo del modelo 
    //tabla.select()
    //tabla.insert()
    //tabla.update()
    //tabla.delete()
})
module.exports=test2

Luego en para usarlo

// file ./index.js
const mysql=require("mysql-tab")
const path=require("path")

let connect= new mysql({/* params mysql */})

connect.pathModels(path.dirname(__filename)+"/model")

let test2=connect.tabla("test2")
// insert([1,"un texto","otro texto"]) tabien se acepta un objeto  
test2.insert(1,"un texto","otro texto") 
    .then(ok=>
    {
        console.log(ok)
    }).catch(e=>
    {
        console.log(e)
    })
test2.miMetodo("hola")

Mas documentacion sobre tabla-model..

Realizando ingenieria inversa a una base de datos ya creada

Si ya se tiene una base de datos creada con mysql-tab tambien puedes crear los modelos a partir de la misma, para esto debe ejecutar en la linea de comandos. Esta funcionalidad acepta los siguientes argumentos

• --host: (opcional) host de mysql por defecto es localhost
• --port: (opcional) puerto mysql por defecto es 3600
• --user: usuario de mysql
• --password: contraseña del usuario
• --database: base de datos a utilizar
• --path: directorio donde seran creados los modelos
• --inicializar: (opcional) si esta presente creara los datos de inicializacion del modelo con los datos octenidos de cada tabla, si solo se desea inicializar una o mas tablas concretas solo se debe agregar al valor los nombres de las tablas separadas por una coma ,
• --tablas: (opcional) lista de tablas separadas por coma , si este argumento no esta presente se tomaran todas las tablas de la base de datos

Ejemplo:

$ ./node_modules/.bin/mysql-tab   --user root --password 1233456 --database test --path ./modelos 

Esto creara los modelos en el directorio ./modelos a partir de las tablas encontradas en la base de datos test

mysqlTable#constructor(config)

Constructor de mysqlTable

• config {object}: configuracion para mysql, tambien se puede pasar un objeto obtenido de la funcion createConnection de mysql

const mysql=require("mysql-tab")
let connect= new mysql({
    host     : 'localhost',
    user     : 'root',
    database :'test_mysql_tab'
})

const mysqlTable=require("mysql-tab")
const mysql=require("mysql")
let db = mysql.createConnection({
    host     : 'localhost',
    user     : 'root',
    database :'test_mysql_tab'
})
let connect= new mysqlTable(db)

mysqlTable#tabla(tabla,[callback,[verify]])

Factoriza y retorna un objeto dbTabla que representara a la tabla con el nombre del primer parametro

• tabla {string}: Nombre de la tabla en la base de metadatos
• callback {function} (opcional): Funcion que sera ejecutada cuando se verifique la existencia de la tabla, esta funcion recibira un parametro que sera el objeto dbTabla creado y si la tabla no es encontrada el parametro sera null
• verify {boolean} (opcional): indica si la verificacion se realizara al instante o se esperara a la primera consulta

mysqlTable#model(tabla)

Verifica si un modelo existe y lo retorna si no existe retorna false

• tabla {string}: Nombre del modelo

mysqlTable#addModel(model)

Agrega un modelo

• model {sqlModel|object|string}: Si es un objeto instanceado de tabla-model se agregara a la lista de modelos, si es un objeto pero no de tabla-model se tomara como los datos para factorizar un modelo deberia tener el formato {tabla:String, campos:Array, foreingKey:Array} y su es un string deberia ser una clausula sql CREATE TABLE de la cual se factorizara el modelo

//ejemplo 1
const mysql=require("mysql-tab")
const model=require("tabla-model")
let connect= new mysql({
    host     : 'localhost',
    user     : 'root',
    database :'test_mysql_tab'
})
const test2=new model("test2",{
    campos:[
        {
            name:"id",
            type:"int",
            primary:true,
			autoincrement:true
        },
        {
            name:"row1",
            type:"text"
        },
        {
            name:"row2",
            type:"int",
        },
        {
            name:"row3",
            type:"date",
        }
    ]
})
 connect.addModel(test2)

//ejemplo 2
const mysql=require("mysql-tab")
let connect= new mysql({
    host     : 'localhost',
    user     : 'root',
    database :'test_mysql_tab'
})
connect.addModel({
    tabla:"test2",
    campos:[
        {
            name:"id",
            type:"int",
            primary:true,
			autoincrement:true
        },
        {
            name:"row1",
            type:"text"
        },
        {
            name:"row2",
            type:"int",
        },
        {
            name:"row3",
            type:"date",
        }
    ]
})

//ejemplo 3
const mysql=require("mysql-tab")
let connect= new mysql({
    host     : 'localhost',
    user     : 'root',
    database :'test_mysql_tab'
})
connect.addModel(`CREATE TABLE test2 (
    id int AUTO_INCREMENT,
    row1 text,
    row2 int,
    row3 date,
    primary key (id)
)`)

mysqlTable#pathModels(path)

Cargar todos los modelos existentes en el directorio path

• path {string}: directorio de modelos

mysqlTable#query(sql,[config])

Ejecuta una consulta sql en la base de datos y retorna una promesa

• sql {string}: consulta sql
• config {object}: configuracion para la consulta mysql

mysqlTable#beginTransaction(config={})

Inicia una transaccion mysql y retorna una promesa

• config {object}: Configuracion para la query mysql

Ejemplo de uso:

const mysql=require("mysql-tab")
let connect= new mysql({
    host     : 'localhost',
    user     : 'root',
    database :'test_mysql_tab'
})
mysql.pathModels(path.dirname(__filename)+"/modelo")
let test3=mysql.tabla("test3"),
test4=mysql.tabla("test4")
mysql.beginTransaction().then(async()=>
{
    let ok4=await test4.insert(null,"commit",12,"text2")
    if(ok4.error)
        throw ok4
    let ok3=await test3.insert(null,"commit",ok4.insertId,"text2")
    if(ok3.error)
        throw ok3
    await mysql.commit()
}).catch(e=>
{
    mysql.rollback()
})

mysqlTable#commit(config={})

guarda los cambios realizados en la trasaccion y retorna una promesa

• config {object}: Configuracion para la query mysql

mysqlTable#rollback(config={})

revierte los cambios realizados en la trasaccion y retorna una promesa

• config {object}: Configuracion para la query mysql

mysqlTable#end()

Termina la conexion con la base de datos