¿Como generar el diccionario de datos de una Base de Datos en MySQL con Workbench?

Pues bueno, después de muchos días sin agregar alguna entrada a mi blog, aquí estoy de nuevo para mostrar como generar un diccionario de datos de una forma fácil y sencilla con la ayuda de Workbench.

Hace algunos meses necesitaba generar el diccionario de datos de una BD de MySQL. La verdad no pensaba realizarlo en Word. Así que busque información en la red si existía un programa para realizarlo. Para mi fortuna encontré un script hecho por tmsanchez (http://tmsanchezdev.blogspot.mx/2010/07/reporte-en-html-de-un-modelo-en.html) para obtener el diccionario de datos para Workbench. Aunque seguí las indicaciones que indicaba en su blog no logre añadir el script al Workbench, ni siquiera con su segunda versión (http://tmsanchezdev.blogspot.mx/2011/07/nueva-version-para-generar-reporte-en.html). Pero lo bueno que en la informática casi siempre existirá alguien más que tenga el mismo problema que tu y lo resolverá, y así fue, Carlos Acuña publico un comentario donde pone un script el cual si me funciono (http://dl.dropbox.com/u/38625994/db_doc_plugin.lua) y pude así obtener mi preciado diccionario de datos.

Mi aportación, que muestro en esta entrada, es agregar un formato amigable a las tablas, agregue los comentarios de cada campo y añadí la información de las vistas en la BD.

Y pues comenzare mostrando el codigo del script:

-- CakeSchema Export -- Based on DoctrinExport (http://code.google.com/p/mysql-workbench-doctrine-plugin/) -- -- Testing -- catalog= grtV.getGlobal("/wb/doc/physicalModels/0/catalog") -- CakeSchema:writeToClipboard(catalog) -- -- standard module/plugin functions -- -- this function is called first by MySQL Workbench core to determine number of plugins in this module and basic plugin info -- see the comments in the function body and adjust the parameters as appropriate function getModuleInfo() return { name= "DBdoc", -- put your module name here; must be a valid identifier unique among -- all other plugin names author= "SEO", -- put your company name here version= "1.0", -- put module version string in form major.minor implements= "PluginInterface", -- don't change this functions= { "getPluginInfo:l<o@app.Plugin>:", -- don't change this "writeDBdocToFile:i:o@db.Catalog", -- list all your plugin function names and accepted argument types, "writeDBdocToClipboard:i:o@db.Catalog" -- keeping the rest unchanged; in this example there's only one -- function, function name is PluginFunctionName and argument type -- is db.Catalog } } end -- helper function to create a descriptor for an argument of a specific type of object -- you don't need to change here anything function objectPluginInput(type) return grtV.newObj("app.PluginObjectInput", {objectStructName= type}) end -- this function is called by MySQL Workbench core after a successful call to getModuleInfo() -- to gather information about the plugins in this module and the functions that the plugins expose; -- a plugin should expose only one function that will handle a menu command for a class of objects -- see the comments in the function body and adjust the parameters as appropriate function getPluginInfo() local l local plugin -- create the list of plugins that this module exports l= grtV.newList("object", "app.Plugin") -- create a new app.Plugin object for every plugin plugin= grtV.newObj("app.Plugin", { name= "wb.catalog.util.writeDBdocToFile", -- plugin namespace caption= "DBdoc: Write to File", -- plugin textual description (will appear as menu item name) moduleName= "DBdoc", -- this should be in sync with what you sepcified previously for module -- name in getModuleInfo() pluginType= "normal", -- don't change this moduleFunctionName= "writeDBdocToFile", -- the function that this plugin exposes inputValues= {objectPluginInput("db.Catalog")}, -- the type of object rating= 100, -- don't change this showProgress= 0, -- don't change this groups= {"Catalog/Utilities", "Menu/Catalog"} -- use "Catalog/Utilities" to show the menu item on the overview page, -- or "Model/Utilities" to show the menu item on the canvas; -- the "Menu/*" entries control how the plugin will appear in main menu -- the possible values for it are "Menu/Model", "Menu/Catalog", "Menu/Objects", -- "Menu/Database", "Menu/Utilities" }) -- fixup owner plugin.inputValues[1].owner= plugin -- add to the list of plugins grtV.insert(l, plugin) plugin= grtV.newObj("app.Plugin", { name= "wb.catalog.util.writeDBdocToClipboard", caption= "DBdoc: Copy to Clipboard", moduleName= "DBdoc", pluginType= "normal", moduleFunctionName= "writeDBdocToClipboard", inputValues= {objectPluginInput("db.Catalog")}, rating= 100, showProgress= 0, groups= {"Catalog/Utilities", "Menu/Catalog"} }) -- fixup owner plugin.inputValues[1].owner= plugin -- add to the list of plugins grtV.insert(l, plugin) return l end -- Print some version information and copyright to the output window function printVersion() print("\n\n\nDBdoc v1.0\nAuthor SEO"); end -- -- writeDBdocToClipboard definition -- @param object catalog -- function writeDBdocToClipboard(catalog) printVersion() local doc = generateDBdoc(catalog) Workbench:copyToClipboard(doc) print("\n > DBdoc copied to clipboard") return 0 end -- -- writeDBdocToFile definition -- @param object catalog -- function writeDBdocToFile(catalog) printVersion() local doc = generateDBdoc(catalog); if (catalog.customData["DBdocExportPath"] ~= nil) then if (Workbench:confirm("Proceed?", "Do you want to overwrite previously exported file "..catalog.customData["DBdocExportPath"].." ?") == 1) then DBdocExportPath = catalog.customData["DBdocExportPath"]; else DBdocExportPath = Workbench:input('Please enter the DBdoc export path'); if (DBdocExportPath ~= "") then -- Try to save the filepath for the next time: catalog.customData["DBdocExportPath"] = DBdocExportPath; end end else DBdocExportPath = Workbench:input('Please enter the DBdoc export path'); if (DBdocExportPath ~= "") then -- Try to save the filepath for the next time: catalog.customData["DBdocExportPath"] = DBdocExportPath; end end if DBdocExportPath ~= '' then f = io.open(DBdocExportPath, "w"); if (f ~= nil) then doc = string.gsub(doc, "\r", "") f.write(f, doc); f.close(f); print('\n > DBdoc was exported to ' .. DBdocExportPath); else print('\n > Could not write file ' .. DBdocExportPath); end else print('\n > DBdoc was NOT exported. Path was invalid.'); end return 0 end -- -- generate DBdoc class -- @param object column -- @return string -- function generateDBdoc(catalog) local result = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> \n' result = result .. '<html xmlns="http://www.w3.org/1999/xhtml"> \n' result = result .. '<head> \n' result = result .. '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> \n' result = result .. '<title>DBdoc</title> \n' result = result .. '</head> \n' result = result .. '<style type="text/css"> \n' result = result .. ' table {width: 100%; border-collapse: collapse;} \n' result = result .. ' table, td, th {border: 1px solid black;} \n' result = result .. '</style> \n' result = result .. '<body> \n' for i = 1, grtV.getn(catalog.schemata) do schema = catalog.schemata[i] result = result .. '<h1> ' .. schema.name .. '</h1> \n' result = result .. '<ol> \n' result = result .. '<h2> Tablas</h2> \n' for j = 1, grtV.getn(schema.tables) do table = schema.tables[j] result = result .. ' <li>' .. table.name .. ' (' .. grtV.getn(table.columns) .. ' campos)</li> ' end result = result .. '<h2> Vistas</h2> \n' for j = 1, grtV.getn(schema.views) do view = schema.views[j] result = result .. ' <li>' .. view.name .. ' </li> ' end result = result .. '<ol> \n' result = result .. '<ol> \n' for j = 1, grtV.getn(schema.tables) do table = schema.tables[j] result = result .. ' <li id="' .. table.name .. '"> \n' result = result .. '<h2> ' .. table.name .. '</h2> \n' result = result .. '<p> ' .. table.comment .. '</p> \n' result = result .. '<table> \n' result = result .. ' <tr bgcolor="#1E90FF"> \n' result = result .. '<th>CAMPO</th> \n' result = result .. '<th>TIPO</th> \n' result = result .. '<th>NULO</th> \n' result = result .. '<th>EXTRA</th> \n' result = result .. '<th>COMENTARIOS</th> \n' result = result .. '</tr> \n' for k = 1, grtV.getn(table.columns) do col = table.columns[k] result = result .. ' <tr bgcolor="#ADD8E6"> \n' result = result .. ' <td>' .. col.name .. '</td> \n' result = result .. ' <td>' .. col.formattedType .. '</td> \n' if (col.isNotNull == 1) then result = result .. ' <td>' .. 'NO' .. '</td> \n' else result = result .. ' <td>' .. 'SI' .. '</td> \n' end if (col.autoIncrement == 1) then result = result .. ' <td>' .. 'AUTO_INCREMENT' .. '</td> \n' else result = result .. ' <td>' .. ' - ' .. '</td> \n' end result = result .. ' <td>' .. col.comment .. '</td> \n' result = result .. '</tr> \n' end result = result .. '</table> \n' result = result .. '</li> \n' end for j = 1, grtV.getn(schema.views) do view = schema.views[j] result = result .. ' <li id="' .. view.name .. '"> \n' result = result .. '<h2> ' .. view.name .. '</h2> \n' result = result .. '<p> ' .. view.comment .. '</p> \n' result = result .. '<table> \n' result = result .. ' <tr bgcolor="#1E90FF"> \n' result = result .. '<th>NOMBRE</th> \n' result = result .. '<th>COMENTARIOS</th> \n' result = result .. '<th>SCRIPT SQL</th> \n' result = result .. '</tr> \n' result = result .. ' <tr bgcolor="#ADD8E6"> \n' result = result .. '<th>' .. view.name .. '</th> \n' result = result .. '<th>' .. view.comment .. '</th> \n' result = result .. '<th>' .. view.sqlDefinition .. '</th> \n' result = result .. '</tr> \n' result = result .. '</table> \n' result = result .. '</li> \n' end end result = result .. '</ol> \n' result = result .. '</body> \n' result = result .. '</html>' return result end

Solo es necesario copiar el código y guardarlo en un archivo con extensión ".lua". El siguiente paso es agregarlo al Workbench, entonces una vez abierto el programa es necesario ir al menú Scripting>Install Plugin/Module File...

Después elegimos el archivo con extensión ".lua" donde se guardo el script.

Una vez hecho lo anterior se abrirá la ventana del depurador de Workbench. Si todo salió bien se mostrara un mensaje indicando que la instalación fue exitosa y después se debe reiniciar el Workbench para que surtan efecto los cambios. Al abrir de nueva cuenta el programa se mostraran dos nuevos menús como se muestran en la siguiente imagen:

La diferencia entre las dos opciones es que el primero guarda el diccionario en un archivo y el otro lo copia al "portapapeles del sistema". Se debe tener en cuenta que genera código HTML. Con esto es suficiente para que se pueda generar el diccionario de datos de una BD de MySQL. Enseguida dejo el resultado que genera para una BD que tengo.

bdrfid

Tablas

1. carrera (2 campos)
2. carrera_has_institucion (2 campos)
3. departamento (3 campos)
4. especialidad (3 campos)
5. estados (2 campos)
6. institucion (3 campos)
7. item (7 campos)
8. municipios (3 campos)
9. persona (15 campos)
10. registro (6 campos)
11. tag (3 campos)

Vistas

1. carrera

   CAMPO	TIPO	NULO	EXTRA	COMENTARIOS
   idCarrera	INT(11)	NO	AUTO_INCREMENT
   Nombre	VARCHAR(45)	SI	-

2. carrera_has_institucion

   CAMPO	TIPO	NULO	EXTRA	COMENTARIOS
   carrera_idCarrera	INT(11)	NO	-
   institucion_idInstitucion	INT(11)	NO	-

3. departamento

   CAMPO	TIPO	NULO	EXTRA	COMENTARIOS
   idDepartamento	INT(11)	NO	AUTO_INCREMENT
   Nombre	VARCHAR(80)	SI	-
   institucion_idInstitucion	INT(11)	NO	-

4. especialidad

   CAMPO	TIPO	NULO	EXTRA	COMENTARIOS
   idEspecialidad	INT(11)	NO	AUTO_INCREMENT
   Nombre	VARCHAR(45)	SI	-
   carrera_idCarrera	INT(11)	NO	-

5. estados

   CAMPO	TIPO	NULO	EXTRA	COMENTARIOS
   id_estado	INT(11)	NO	AUTO_INCREMENT
   estado	VARCHAR(45)	SI	-

6. institucion

   CAMPO	TIPO	NULO	EXTRA	COMENTARIOS
   idInstitucion	INT(11)	NO	AUTO_INCREMENT
   Nombre	VARCHAR(100)	SI	-
   municipios_id_municipios	INT(11)	NO	-

7. item

   CAMPO	TIPO	NULO	EXTRA	COMENTARIOS
   Id_item	INT(11)	NO	AUTO_INCREMENT
   Nombre	VARCHAR(45)	SI	-
   Tipo	VARCHAR(45)	SI	-
   Descripcion	TEXT	SI	-
   EPC	VARCHAR(45)	SI	-
   persona_Id_persona	INT(11)	NO	-
   tag_Id_tag	INT(10)	NO	-

8. municipios

   CAMPO	TIPO	NULO	EXTRA	COMENTARIOS
   id_municipios	INT(11)	NO	AUTO_INCREMENT
   nombre_municipios	VARCHAR(45)	SI	-
   estados_id_estado	INT(11)	NO	-

9. persona

   CAMPO	TIPO	NULO	EXTRA	COMENTARIOS
   Id_persona	INT(11)	NO	AUTO_INCREMENT
   Nivel	VARCHAR(45)	SI	-
   Clasificacion	VARCHAR(45)	SI	-
   EPC	VARCHAR(100)	SI	-
   Nombre	VARCHAR(45)	SI	-
   Apellido_materno	VARCHAR(45)	SI	-
   Apellido_paterno	VARCHAR(45)	SI	-
   Edad	INT(11)	SI	-
   Genero	VARCHAR(9)	SI	-
   Fotografia	LONGBLOB	SI	-
   institucion_idInstitucion	INT(11)	NO	-
   tag_Id_tag	INT(10)	NO	-
   carrera_idCarrera	INT(11)	SI	-
   especialidad_idEspecialidad	INT(11)	SI	-
   departamento_idDepartamento	INT(11)	SI	-

10. registro

    CAMPO	TIPO	NULO	EXTRA	COMENTARIOS
    idRegistro	INT(11)	NO	AUTO_INCREMENT
    Nivel	BINARY(1)	SI	-
    Entrada_salida	BINARY(1)	SI	-
    Fecha	DATE	SI	-
    Hora	TIME	SI	-
    Tag_Id_tag	INT(11)	NO	-

11. tag

    CAMPO	TIPO	NULO	EXTRA	COMENTARIOS
    Id_tag	INT(10)	NO	AUTO_INCREMENT
    EPC	VARCHAR(100)	NO	-
    Tipo	VARCHAR(45)	SI	-

 
Referencias:

http://tmsanchezdev.blogspot.mx/2010/07/reporte-en-html-de-un-modelo-en.html
http://tmsanchezdev.blogspot.mx/2011/07/nueva-version-para-generar-reporte-en.html
http://dl.dropbox.com/u/38625994/db_doc_plugin.lua