Nomenclatura para La Base de Datos-637677920

Coordinacin General de Gestin
Estratgica
Direccin de Tecnologas de la
Informacin
ESTNDARES DE NOMENCLATURA PARA
BASE DE DATOS
MANUAL TCNICO
Versin 1.0, Revisin 2.0
2014 Direccin de Tecnologas de la Informacin Coordinacin General de Gestin Estratgica

MIPRO
TODOS LOS DERECHOS RESERVADOS
Queda reservado el derecho de propiedad de este documento, con la facultad de disponer de l,
publicarlo, traducirlo o autorizar su traduccin.
No se permite la reproduccin total o parcial de este documento, ni su incorporacin a un sistema
informtico, ni su locacin, ni su transmisin en cualquier forma o por cualquier medio, sea ste
escrito o electrnico, mecnico, por fotocopia, por grabacin u otros mtodos, sin el permiso previo
y escrito de los titulares de los derechos y del copyright.
FOTOCOPIAR ES DELITO.
Otros nombres de compaas y productos mencionados en este documento, pueden ser marcas
comerciales o marcas registradas por sus respectivos dueos.
. Ynez Pinzn N26-12, entre Av. Coln y la Nia, 5to. Piso (593)2 3948 760, Quito Ecuador
Confidencial
CGGE-MIPRO,2014
Pginas Totales: 17
COORDINACIN GENERAL DE GESTIN

ESTRATGICA
DIRECCIN DE TECNOLOGAS DE LA INFORMACIN
NOMENCLATURA PARA BASE DE DATOS
DTI.MT.13-01
Pgina 2 de 17
INFORMACIN GENERAL DEL DOCUMENTO

TTULO:
ESTNDARES DE NOMENCLATURA PARA BASE DE DATOS
RESUMEN
Lineamientos a seguir para el diseo de los esquemas de base de

datos.
VERSIN
1.0
NOMBRE ARCHIVO:
TIC.MT.13-01.odt
PLANTILLA:
INFORMES REVISIN: 2.0
AUTOR PLANTILLA:
DAP MIPRO
VIGENTE
27.nov.2013
DESDE:
FIRMAS Y APROBACIONES
ELABORADO
POR:
FECHA:
REVISADO
POR:
Ing. Christian Andrade H.

Analista Tecnologas de la
Informacin
Ing. Marcelo Muoz M.
Analista Tecnologas de la
Informacin
15.jul.2014
Firma:
Ing. lex Gordillo M.

Director Tecnologas de la
Informacin (E)
Ing. Edgar Valarezo
Asesor CGGE
FECHA:
25.jul.2014
APROBADO
POR:
Ing. Flor Mara Ramn.

Coordinadora General de
Gestin Estratgica
Firma:
FECHA:
Firma:
LISTA DE CAMBIOS
VERSIN
REVISIN
FECHA
1.0
1.0
12.dic.2013
1,0
2.0
15.jul.2014
Confidencial
AUTOR
Christian Andrade H.
Marcelo Muoz M.
Marcelo Muoz M.
DESCRIPCIN
Emisin Inicial del
Documento.
Actualizacin del
documento
Ynez Pinzn N26-12, entre Av. Coln y la Nia, 5to. Piso (593)2 3948 760, Quito Ecuador
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 3 de 17
DECLARACIN DE LIBERACIN: Este documento, con la versin indicada es para uso institucional de la Coordinacin
General de Gestin Estratgica del Ministerio de Industrias y Productividad y est sujeto a los controles de
procedimientos de su emisor, la Direccin de Tecnologas de la Informacin. Comentarios, sugerencias o preguntas
debern ser direccionadas al emisor.
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DIRECCIN DE TECNOLOGAS DE LA INFORMACI N
DTI.MT.13-01
Pgina 4 de 17
TABLA DE CONTENIDO
ndice de contenido
INFORMACIN GENERAL DEL DOCUMENTO.................................................... 2
FIRMAS Y APROBACIONES.............................................................................. 2
LISTA DE CAMBIOS......................................................................................... 2
TABLA DE CONTENIDO.................................................................................... 4
TRMINOS Y ABREVIATURAS........................................................................... 6
Trminos...................................................................................................... 6
Abreviaturas................................................................................................ 6
INTRODUCCIN.............................................................................................. 7
Objetivo....................................................................................................... 7
Alcance........................................................................................................ 7
Audiencia.................................................................................................... 7
Condiciones de uso de este documento...................................................... 7
Convenciones utilizadas en este documento.............................................. 8
Terminologa y definiciones......................................................................... 9
GUA RPIDA................................................................................................... 9
Convenciones de nomenclatura................................................................ 10
CONVENCIONES DE NOMENCLATURA........................................................... 11
Guas genricas y buenas prcticas.......................................................... 11
Nomenclatura para los elementos de una base de datos ...................... 12
Base de Datos........................................................................................ 12
Esquema................................................................................................ 12
Tablas..................................................................................................... 13
Vistas..................................................................................................... 13
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 5 de 17
Columnas............................................................................................... 13
Stored Procedures.................................................................................. 14
Funciones definidas por el usuario......................................................... 14
Triggers.................................................................................................. 15
Tipos de datos definidos por el usuario.................................................. 15
Primary keys.......................................................................................... 16
Foreign keys........................................................................................... 16
Indexes................................................................................................... 16
Variables................................................................................................ 17
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 6 de 17
TRMINOS Y ABREVIATURAS
Trminos
Undescore: Guin bajo
Abreviaturas
CGGE: Coordinacin General de Gestin Estratgica
DTI: Direccin de Tecnologas de la Informacin
CASE: Ingeniera de Software Asistida por Computadora
(Computer Aided Software Engineering)
IDE: Entorno de Desarrollo Integrado (Integrated Development
Environment).
E-R: Entidad Relacin
MIPRO: Ministerio de Industrias y Productividad
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
NOMENCLATURA PARA BASE DE DATOS Pgina 7 de 17
INTRODUCCIN
El presente documento describe la nomenclatura a utilizar en el diseo de
base de datos en el rea de desarrollo del MIPRO.
Objetivo
El objetivo de este documento es institucionalizar buenas prcticas y
estandarizar la nomenclatura de nombres utilizada en el diseo y
mantenimiento de bases de datos en el rea de desarrollo del MIPRO.
Alcance
Este documento aplica al diseo y mantenimiento de base de datos en el rea
de desarrollo del MIPRO orientado al motor de base de datos Postgresql.
Por defecto todas las indicaciones que se presentan aplican a todos los
manejadores a menos que se especifique lo contrario.
En caso de querer aplicar la nomenclatura para otro manejador de base de
datos, distinto a Postgresql, se debe decidir si alinearse a la nomenclatura
Postgresql definida en este documento en base a factores como:
Tipo de soporte case sensitive que tenga el manejador y el cliente

utilizado.
La existencia o no de un estndar para dicho manejador
Audiencia
Este documento se encuentra dirigido a programadores, analistas, jefes de
proyecto y especialistas tcnicos del rea de desarrollo de software de la DTI
del MIPRO, que tengan entre sus tareas realizar el diseo o mantenimiento de
una base de datos.
Condiciones de uso de este documento
Una regla puede romperse slo ante razones justificadas, discutidas, con
previa autorizacin del responsable del producto, y en caso que no pueda
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 8 de 17
aplicarse ninguna alternativa razonable. El autor de la excepcin,

obligatoriamente debe documentar el cdigo explicando la causa de la
violacin de la regla.
Las preferencias personales no se consideran una razn justificada.
Convenciones utilizadas en este documento

Trmino
Descripcin
OBL
Obligatorio
REC
Recomendado
Negrita
Texto con nfasis adicional que debe ser considerado
Siempre
Indica que esta regla DEBE ser respetada, en los trminos de

este manual.
Nunca
Indica que esta accin NO DEBE ser realizada, en los

trminos de este manual.
No hacer
Indica que esta accin NO DEBE ser realizada, en los

trminos de este manual.
Evitar
Indica que esta prctica debe ser evitada siempre que sea
posible, pero pueden existir excepciones AUTORIZADAS para
su utilizacin.
Intentar
Indica que esta prctica debe aplicarse siempre que sea

posible y apropiado.
Razn
Explica el propsito y las causas que motivan la regla o

recomendacin.
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 9 de 17
Terminologa y definiciones
Trmino
Camel Case
Descripcin
Una palabra con la primera letra en minsculas, y la primera

letra de cada una de las palabras subsecuentes en
maysculas.
Ejemplo: customerName
Cualquier literal numrico utilizado dentro de una expresin
(o inicializacin de variable) que no posea un significado
claro. Usualmente este trmino no aplica a los valores 0 y 1
y cualquier otra expresin numrica equivalente que su
evaluacin resulte 0.
Magic
Number
Pascal Case
Una palabra con la primera letra en maysculas, y la

primera letra de cada palabra subsecuente tambin en
maysculas.
Ejemplo: CustomerName
Hungarian
Notation
Underscore
Separated
Comienzan con una o mas letras en minscula que denotan

el tipo de la variable
Ejemplo: string sVariable
Indica palabras separadas con infraguin.
Ejemplo:
CUSTOMER_DETAIL
GUA RPIDA
En esta seccin se incluye un breve resumen de los principales estndares
descritos a lo largo de este documento. Estas tablas no son detalladas en sus
descripciones, pero brindan una rpida referencia a los elementos.
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 10 de 17
Convenciones de nomenclatura
Trmino
Descripcin
camel Case
Pascal Case
USM
Minsculas con Separacion de guion bajo(Undescore)
Prefijo con guion bajo (underscore)
No aplica
[]
Lo se encuentre contenido entre parntesis rectos significa

que es opcional.
<VAR>
Indica que esa posicin debe sustituirse por el valor del

campo VAR. En el caso de la variable TABLA se hace la
siguente distincin: TABLE_S representa el nombre de una
tabla en singular (ej: Cliente).
Trmino
Descripcin
Ejemplo
Base de datos
USM
<PAIS>_<INSTITUCION>[_AUX]
ec_mipro
ec_mipro_pruebas
Schema
USM
<PAIS>_<INSTITUCION>_<SOLUCION>[_AUX]
ec_mipro_artesano
ec_iess_moraPatronal_2012
Tablas
USM singular
documento_habilitante
Vistas
USM
VW_<DESCRIPCION>
vw_reporteporpais
USM
SP_<OPERACION>[_<AUX>]
sp_insertar_arancel,
sp_obtener_arancelporexportador
USM
FUNC_<OPERACION>[_<AUX>]
func_calcular_subsidioporarancel
Stored
Procedures
Funciones
definidas por el
usuario
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 11 de 17
Triggers
USM
TGR_<TABLA>_<OPERACION_P>[_<AUX>]
tgr_adocumento_habilitante_Inse
rt,
tgr_exportador_actualizar_validar
documento
Columns
USM
Para las claves <TABLA>_id
orden_id, ruc_exportador,
direccion , fecha_registro
User defined
data types
USM
TYP_<DESCRIPCION>
typ_ persona
Primary keys
USM
PK_<TABLA>
pk_usuario
Foreign keys
USM
FK_<TABLA>_<REF_TABLA>
fk_grupo_permiso
Indexes
USM
IDX_<TABLA>_<CAMPO>[_AUX]
idx_detalle_solicitud_ruc_U_NC
En el ejemplo presentado _U
correspondera a Unique y _NC
correspondera a NonClustered.
Secuencias
USM
SEQ_<TABLA>[_<AUX>]
seq_usuario
Variables
USM
ruc
CONVENCIONES DE NOMENCLATURA
A continuacin se presentan un conjunto de guas y buenas prcticas, as
como la nomenclatura para utilizar en el diseo de bases de datos.
Guas genricas y buenas prcticas

1. OBL Utilizar nombres en castellano para todos los elementos
de la base de datos, tablas, vistas, campos, etc.
2. REC Utilizar nombres descriptivos para los campos. Utilizar
nombres que resulten intuitivos y permitan entender el significado de
los campos (mnemotcnicos). Evitar las abreviaciones, y si esto no es
posible documentarlas bien.
3. REC No nombrar campos que representan lo mismo de forma
distinta. La forma en que se nombran iguales propiedades debe ser
consistente en todo un esquema. Ejemplo: Nombrar al campo clave de
la tabla Customers como Id, y despus referenciarlo en otras tablas
como CustomerId es INCORRECTO. El campo debe ser nombrado
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 12 de 17
CustomerId en todos los casos que se quiera almacenar una clave de

Customers.
4. REC Evitar tener demasiadas columnas NULLABLES en una
tabla. Esto es indicio de un esquema poco o nada normalizado. Falta de
normalizacin puede conllevar problemas de consistencia en los datos
en la medida que un mismo campo se puede terminar almacenando en
varias tablas. Excesiva normalizacin puede tener asociada una perdida
de performance en ciertas operaciones sobre la base de datos. Es
necesario encontrar el equilibrio correspondiente a los requerimientos
de cada proyecto en este punto. Como regla general la tercera forma
normal es un buen punto intermedio.
5. REC Evitar tener tablas sin definicin de claves primarias.
6. REC Evitar tener tablas innecesarias en el sistema. Un buen
diseo es uno simple
7. REC Intentar evitar el uso de cdigo propietario en la definicin
de expresiones SQL.. Intentar utilizar cdigo Standard SQL-92.
Nomenclatura para los elementos de una base de datos
En esta seccin se presenta la nomenclatura definida para los distintos
elementos de una base de datos.
Base de Datos
Las bases de datos PostgreSQL y SQL Server debern nombrarse usando la
siguiente nomenclatura:
1. Cdigo del pas en dos letras
2. Institucin a la que pertenece la base de datos
3. Descripcin complementaria sin espacios en blanco
4. Utilizar minsculas sin espacios en blanco
Ejemplo:
ec_mipro
Esquema
Los esquemas debern nombrarse usando la siguiente nomenclatura:
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 13 de 17
1. Cdigo del pas en dos letras

2. Nombre de la institucin a la que pertenece el esquema
3. Nombre de la solucin que utiliza el esquema de base de datos en
minsculas sin espacios en blanco
4. Utilizar notacin USM
5. AUX se reserva para diferenciar dos bases de datos o esquemas
correspondientes a una misma solucin.
Ejemplo:
ec_mipro_artesano
Tablas
Las tablas deben nombrarse:
1. Los nombres deben escribirse en singular,
2. Los nombres deben escribirse en castellano
3. No utilizar espacios en blanco
Ejemplo:
documento_habilitante
Vistas
Las vistas deben nombrarse en minsculas sin espacios en blanco, pero
prefijadas usando vw_.
Ejemplo:
vw_reporteporexportador
Columnas
Los campos de una tabla corresponden a los atributos de una entidad,
describen propiedades de la misma.
Las columnas deben ser nombradas segn los lineamientos a continuacin:
1. Los nombres deben ser simples, representativos e intuitivos.
2. Los nombres de las columnas de una tabla deben estar expresados en
singular.
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 14 de 17
3. El campo clave de una tabla debe nombrarse como el nombre de la

tabla mas el sufijo id.
Ejemplo: Para una tabla de clientes arancel, se definiran las claves:
o
arancel_id
4. Campos que representen la misma entidad del mundo real, deben estar
nombrados de la misma manera en todas las tablas de un esquema.
Ejemplo nombrar la clave de la tabla solicitud, en una tabla como
solicitud_id y en otra solicitudKey es incorrecto.
5. Se desaconseja prefijar sistemticamente TODOS los campos de una
tabla con el nombre de la tabla o una abreviacin del mismo.
Entendemos que esto agrega un nivel de redundancia y complejidad al
sistema que no es necesario en manejadores modernos.
Stored Procedures
Los stored procedures son un espacio estndar para incluir lgica en la base de
datos, expresada en un lenguaje de scripting que extiende SQL. Los SP pueden
ser invocados utilizando SQL estndar desde una aplicacin, mediante la
instruccin EXEC.
Los stored procedures deben ser nombrados segn la siguiente nomenclatura:
1. Utilizar el prefijo sp
2. <operacin> Descripcin del procedimiento almacenado en minsculas
3. [_<AUX>] Descripcin complementaria en minsculas sin espacios en
blanco
Funciones definidas por el usuario
Las funciones definidas por el usuario son un mecanismo no totalmente
estndar para incluir lgica en la base de datos, expresada en un lenguaje de
scripting que extiende SQL.
La nomenclatura definida es:
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 15 de 17
1. Utilizar el prefijo func

2. <operacin> Descripcin del procedimiento almacenado en minsculas
blanco
Triggers
Un trigger es lgica alojada en la base de datos asociada a una determinada
accin sobre una tabla. La lgica es disparada cuando ocurre la accin
correspondiente.
Un trigger no tiene sentido fuera de una tabla y un trigger tiene asociada
siempre una operacin, por lo que dicha informacin debe estar asociada al
nombre del trigger.
1. Usar el prefijo tgr
2. <TABLA>Indicar el nombre de la tabla a la que se liga el diparador
3. <OPERACION_P> La operacin que dispara el trigger
blanco
5. Usar notacin USM
Ejemplo:
tgr_exportador_actualizar_validardocumento
Tipos de datos definidos por el usuario

Los tipos de datos definidos por el usuario son un mecanismo para mantener
la consistencia de tipos en la base de datos. Cuando un mismo tipo de datos
es utilizado en varias tablas, en vez de definirlo cada vez por separado, se
define un user defined data type para luego referenciarlo desde todas ellas y
mantener as centralizada su definicin.
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 16 de 17
1. Utilizar el prefijo typ

2. Descripcin de tipo de dato en minsculas sin espacios en blanco.
Ejemplo:
typ_persona
Primary keys
La clave primaria es un conjunto de campos que identifica de forma nica un
registro en una tabla. Son un caso particular de un ndice.
La nomenclatura es la siguiente:
1. Utlizar el prefijo pk
2. Incluir el nombre de la tabla donde se define la clave primaria.
Ejemplo:
pk_usuario
Foreign keys
Las foreign keys son usadas para definir vnculos entre tablas relacionadas.
Una foreign key establece una relacin entre una o ms columnas de una tabla
y la clave primaria de la tabla referenciada.
Como patrn para la nomenclatura se define:
1. Utilizar prefijo fk
2. Inclui nombre de la tabla que referencia
3. Incluir nombre de la tabla referenciada
Ejemplo:
fk_grupo_permiso
Indexes
Los ndices son un mecanismo para aumentar la eficiencia de localizacin y
acceso de un registro en una tabla en la base de datos, opcionalmente
asegurando unicidad de los valores del ndice. La definicin de ndices tiene un
Confidencial
CGGE-MIPRO, 2014.

ESTRATGICA
DTI.MT.13-01
Pgina 17 de 17
impacto positivo en los tiempos de consulta de registro y uno negativo en los

de insercin y actualizacin de los campos del ndice.
Los ndices estn asociados a una tabla y a un conjunto de campos de la tabla,
a su vez pueden ser nicos o no y pueden estar definidos en cluster o no.
1. Utilizar el prefijo idx
2. Incluir el nombre de la tabla
3. Indicar el nombre del campo al que se le aplicar el ndice
4. [_AUX] se reserva para indicar el tipo de ndice siendo por ejemplo:
U correspondera a Unique
NC correspondera a NonClustered
C Clustered

Ejemplo: Definir un ndice en la tabla detalle_solicitud, sobre el campo
ruc, unico y nonclustered.
idx_detalle_solicitud_ruc_U_NC
Variables
Cuando las variables corresponden columnas de una tabla, deben ser
nombrados de la misma manera que la columna.
La notacin elegida para definir las variables
1. Utilizar notacin USM.
Ejemplo:
Confidencial
ruc
CGGE-MIPRO, 2014.

Nomenclatura para La Base de Datos-637677920

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Nomenclatura para La Base de Datos-637677920

Uploaded by

Copyright:

Available Formats

Coordinacin General de Gestin

2014 Direccin de Tecnologas de la Informacin Coordinacin General de Gestin Estratgica

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

INFORMACIN GENERAL DEL DOCUMENTO

ESTNDARES DE NOMENCLATURA PARA BASE DE DATOS

Lineamientos a seguir para el diseo de los esquemas de base de

INFORMES REVISIN: 2.0

Ing. Christian Andrade H.

Ing. lex Gordillo M.

Ing. Flor Mara Ramn.

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS Pgina 7 de 17

Tipo de soporte case sensitive que tenga el manejador y el cliente

La existencia o no de un estndar para dicho manejador

Condiciones de uso de este documento

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

aplicarse ninguna alternativa razonable. El autor de la excepcin,

Convenciones utilizadas en este documento

Texto con nfasis adicional que debe ser considerado

Indica que esta regla DEBE ser respetada, en los trminos de

Indica que esta accin NO DEBE ser realizada, en los

Indica que esta accin NO DEBE ser realizada, en los

Indica que esta prctica debe aplicarse siempre que sea

Explica el propsito y las causas que motivan la regla o

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

Una palabra con la primera letra en minsculas, y la primera

Una palabra con la primera letra en maysculas, y la

Comienzan con una o mas letras en minscula que denotan

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

Minsculas con Separacion de guion bajo(Undescore)

Prefijo con guion bajo (underscore)

Lo se encuentre contenido entre parntesis rectos significa

Indica que esa posicin debe sustituirse por el valor del

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

Guas genricas y buenas prcticas

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

CustomerId en todos los casos que se quiera almacenar una clave de

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

1. Cdigo del pas en dos letras

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

3. El campo clave de una tabla debe nombrarse como el nombre de la

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS

1. Utilizar el prefijo func

Tipos de datos definidos por el usuario

COORDINACIN GENERAL DE GESTIN

NOMENCLATURA PARA BASE DE DATOS