Generación de Sentencias DDL con ddlgen

Cuando Adaptive Server Enterprise (ASE) 12.5 fue liberado a mediados del año 2001, una de sus nuevas características fue una nueva herramienta cliente llamada ddlgen. Esta hace lo que su nombre sugiere: Genera sentencias DDL Transact-SQL para los objetos de una base de datos existente. En otras palabras, ddlgen realiza ingeniería reversa del esquema. Recuerde que "DDL" significa "Data Definition Language" (Lenguaje de Definición de Datos) y es un nombre colectivo para las sentencias que manipulan el esquema (pero no los datos de una base de datos) tales como create table, create procedure, etc. Seguramente cada DBA verá el potencial de esta herramienta de ingeniería reversa; en éste documento discutiremos algunos detalles técnicos de ddlgen.

Dónde Encontrar ddlgen

ddlgen es una aplicación Java la cual es ejecutada desde la línea de comandos del sistema operativo. (No hay que confundir esto con la muy promovida característica de "Java en ASE": ddlgen se ejecuta fuera de ASE). La ubicación de ddlgen depende de la versión de ASE:

Aunque ddlgen está disponible para los DBAs como una herramienta independiente, también es usada por otras aplicaciones Sybase, incluyendo la versión Java de Sybase Central y la herramienta sybmigrate (nueva en ASE 12.5.0.1. Para mayor información sobre sybmigrate vea el documento 'Sybase ASE 12.5: Migración a Nuevos Tamaños de Página Usando Sybmigrate', DocId=10123).

Cómo Trabaja ddlgen

ddlgen puede realizar ingeniaría reversa de objetos individuales de la base de datos o de bases de datos enteras de un servidor ASE. Por ejemplo ("%" indica el prompt de Unix; "#" indica un comentario):

ddlgen imprimirá todas las sentencias create necesarias para recrear el esquema actual de la base de datos prod (note que ddlgen no incluye ningún comando drop). Por defecto, ddlgen imprime las sentencias DDL generadas hacia la salida estándar. Esto rápidamente se convierte en una gran cantidad de texto: aún para una tabla simple de una columna, ddlgen genera 21 líneas de salida (en parte debido a que incluye líneas adicionales con comentarios para una mejor legibilidad del DDL).
A continuación una porción de la salida del ddlgen anterior:

-----------------------------------------------------------------------------
-- DDL for Database 'prod'
-----------------------------------------------------------------------------
print 'prod'

use master
go

create database prod on pruebas_dat = 3
go

-----------------------------------------------------------------------------
-- DDL for Rule 'prod.dbo.pub_idrule'
-----------------------------------------------------------------------------
print 'Creating Rule pub_idrule'
go

use prod
go

setuser 'dbo'
go

create rule pub_idrule
as @pub_id in ("1389", "0736", "0877", "1622", "1756")
or @pub_id like "99[0-9][0-9]"
go

setuser
go

-----------------------------------------------------------------------------
-- DDL for Rule 'prod.dbo.title_idrule'
-----------------------------------------------------------------------------
print 'Creating Rule title_idrule'
go

use prod
go

setuser 'dbo'
go

create rule title_idrule
as
@title_id like "BU[0-9][0-9][0-9][0-9]" or
@title_id like "[MT]C[0-9][0-9][0-9][0-9]" or
@title_id like "P[SC][0-9][0-9][0-9][0-9]" or
@title_id like "[A-Z][A-Z]xxxx" or
@title_id like "[A-Z][A-Z]yyyy"
:
:

Opciones de Línea de Comando

ddlgen acepta un número de opciones de línea de comando que le permiten realizar ingeniería reversa de objetos específicos. Las opciones más importantes son -D, para especificar una base de datos; -T, para especificar el tipo de objeto de base de datos, y -N para especificar un patrón para el nombre de un objeto. Por ejemplo, para generar el DDL de todas las tablas de usuario en la base de datos prod cuyos nombres comiencen con la letras "A":

Esta es la lista completa de tipos de objeto que pueden ser usados con la opción -T:

C - Cache	I - Indice	RS - Servidor Remoto
DB - Base de Datos	KC - Restricciones de llave primaria/única	SG - Segmento
D - Valor por Defecto		TR - Trigger
DBD - Dispositivo de Base de Datos	L - Login	U - Tabla de Usuario
DPD - Dispositivo de Dump	P - Procedimiento Alamcenado	UDD - Tipo de Dato Definido por Usuario
EC - Clase de Ejecución	R - Regla	USR - Usuario
EG - Grupo de Motores	RI - Restricciones de Integridad Referencial	V - Vista
GRP - Gripo de Usuarios	RO - Rol	XP - Procedimiento Alamcenado Extendido

Como se muestra en la tabla de arriba, a los objetos a nivel de servidor, tales como logins y roles también se les puede realizar ingeniería reversa:

Las opciones de línea de comando -X y -F permiten filtración adicional en combinación con -T.

El conjunto completo de opciones de comando de ddlgen es el siguiente:
-U login_name: El login usado para conectarse a ASE
-P password: La contraseña del login
-S hostname:port: Nombre del servidor (máquina) y puerto del ASE al que se va a conectar
-D db_name: El nombre de la base de datos; si se omite, se asume el nombre de la base de datos predeterminada del login
-T object_type: El tipo de objeto al cual se le va a realizar ingeniería reversa (ver la tabla de arriba; por defecto es DB)
-N object_name: Siempre debe ser usado con -T para especificar el nombre del objeto. Puede contener patrones o ser un nombre completo (por ejemplo, db_name.owner.table_name[.index]). Por defecto, especifique -N%
-XOU o -XOD: Estas opciones son usadas en combinación con -TU: con -XOU, solo tablas de usuario se incluyen; con -XOD, solo tablas proxy. Al especificar solo -TU, sin -X, incluye tanto tablas de usuario como tablas proxy
- F{TR|I|KC|RI|%}: Para tablas de usuario, no genere triggers (TR), índices (I), restricciones de llave primaria/única (KC), restricciones de integridad referencial (RI) para esa tabla(s). Estas opciones pueden ser combinadas con comas. % excluye todas las anteriores; -F solo no tiene ningún efecto
-O output_file: Archivo de salida para el DDL generado (por defecto la salida estándar)
-E error_file: Archivo para registrar errores
-J charset: Juego de caracteres del cliente
-v: Información sobre la versión de ddlgen

Ingeniería Reversa de Tablas #temp

Aunque esta capacidad no está documentada, ddlgen generará DDL para tablas temporales que pertenezcan a otras sesiones. Para llevar a cabo esto, especifique la base de datos tempdb y use '%' o especifique el nombre completo de la tabla:

# ingeniería reversa de todas las tablas temporales

% ddlgen -Usa -Ppasswd -Spluto:5001 -Dtempdb -TU -N#%

# ingeniería reversa de una tabla temporal específica

% ddlgen -Usa -Ppasswd -Spluto:5001 -Dtempdb -TU -N#t____________00000160012632096

Aparte de escribir consultas sobre las tablas del sistema de tempdb, prácticamente no existe ninguna otra manera de llevar a cabo ingeniería reversa de tablas temporales.

Algunos Consejos

Qué no Hace ddlgen

A pesar de su utilidad, no es sorpresa el hecho de que ddlgen tenga también sus limitaciones:

Dependencias Entre Objetos

Idealmente, el DDL generado se debe poder ejecutar sin errores. Un problema clásico para las herramientas de ingeniería reversa son las dependencias entre objetos de la base de datos. Por ejemplo, cuando el procedimiento P lee de la tabla T, el DDL de la tabla T debió haber sido generado antes que el DDL del procedimiento P -- ya que de otra manera se generará un error al ejecutar el DDL de P ya que la tabla T no existe.

ddlgen lleva a cabo un esfuerzo razonable al tomar en cuenta las dependencias entre objetos, pero no es perfecto. Cuando su DDL generado arroja errores, el remedio más simple es ejecutar el DDL otra vez. Los objetos que no pudieron ser creados la primera vez porque otros objetos no existían, serán creados la segunda vez (esto es posible ya que ddlgen no incluye comandos drop en los DDLs generados). La desventaja de éste método es que es desordenado. Durante la segunda ejecución del DDL, para cada tabla, índice, procedimiento almacenado, etc. habrá un mensaje de error indicando que el objeto ya existe. Esto hará más difícil determinar si todos los objetos han sido finalmente creados de manera correcta.

De manera alterna, usted también puede realizar explícitamente ingeniería reversa de los objetos por tipo usando las opciones -T y -F (ver arriba).

El Problema Clásico de la "Tabla del Procedimiento"

Un problema clásico es el del procedimiento almacenado que hace referencia a una tabla creada por fuera del procedimiento. ddlgen no resuelve este problema. Ejemplo:

La sentencia create table debe ejecutarse primero, o la creación del procedimiento almacenado p fallará, ya que hace falta la tabla #t1.

ddlgen llevará a cabo la ingeniería reversa del procedimiento p, pero este no incluirá la sentencia create table. Esto significa que cuando el DDL generado sea ejecutado, resultará en un error ya que la tabla #t1 no existe. Esto se debe a que ddlgen obtiene el texto SQL de la tabla del sistema syscomments, el cual no contiene la sentencia create table y que esta no es parte del texto SQL del procedimiento almacenado. Los DBAs deberán tratar estos casos manteniendo sus propios DDLs, que contengan ambos comandos, el create table y el create procedure.

Compatibilidad con Versiones Anteriores

Como se mencionó en la introducción, ddlgen fue introducido en ASE 12.5. Sin embargo, ddlgen también trabaja sobre versiones anteriores de ASE, a pesar de ciertas limitantes. Por favor note que la información que sigue fue determinada empíricamente. ddlgen es formalmente soportada sólo en ASE 12.5 o posterior.

Hasta ahora se pudo determinar que ddlgen trabaja bien sobre ASE 12.0, para todos los tipos de objetos. Sobre ASE 11.9 y 11.5, a algunos objetos se les puede aplicar ingeniería reversa, pero a otros no. Por ejemplo, a las tablas de usuario no se les puede aplicar ingeniería reversa en servidores anteriores al 12.0 ya que ddlgen espera encontrar la columna sysindexes.identitygap (así que el ddlgen falla). A otros objetos como índices, logins, roles, o cachés, se les puede aplicar ingeniería reversa exitosamente en servidores 11.9 y 11.5.

No se ha podido correr ddlgen sobre ASE 11.0; algunos problemas de conectividad hacen que ddlgen no se pueda conectar exitosamente.

Atributos del Documento
Resumen:	Este documento discute algunos detalles técnicos de la herramienta cliente ddlgen, utilizada para realizar ingeniería reversa de objetos en Adaptive Server Enterprise.
Código:	10132	Última Modificación:	Mar 23, 2006
Temas:	Administración	Tipo de Documento:	Documento Técnico
Productos:	Adaptive Server Enterprise	Versión:	12.5.x en adelante
Plataformas:	Todas las Plataformas	Sistema Operativo:	Todos los Sistemas Operativos

Una Mirada Más de Cerca a la Nueva Herramienta Cliente de ASE