Tecnología de la Información

Estándares de Objetos de
Base de Datos

Estándar de documento de Objetos de Base de Datos Página 1 de 16

 INDICE

1. INTRODUCCIÓN .............................................................................................................. 3

1.1. OBJETIVOS ...................................................................................................... 3

1.2. ALCANCE ......................................................................................................... 3

1.3. CONTROL DE VERSIONES ................................................................................ 3

2. DEFINICIÓN DE BASE Dé DATOS ..................................................................................... 3

3. DEFINICIÓN DE TABLA .................................................................................................... 4

4. DEFINICIÓN DE COLUMNA O CAMPO ............................................................................ 5

5. TIPO DE DATOS PERSONALIZADOS ................................................................................ 5

6. DEFINICIÓN DE OBJETOS DE INTEGRIDAD REFERENCIAL .............................................. 6

6,1. Primary Key .................................................................................................... 6

6.2. Foreign Key .................................................................................................... 6

6.3. Default ........................................................................................................... 7

6.4. Check ............................................................................................................. 7

7. DEFINICIÓN DE INDICE .................................................................................................. 8

8. DEFINICIÓN DE VARIABLES Y PARAMETROS ................................................................. 8

9. DEFINICIÓN DE PROCEDIMIENTO ALMACENADO ......................................................... 9

10. DEFINICIÓN DE FUNCIONES ........................................................................................ 10

11. DEFINICIÓN DE TRIGGER ............................................................................................. 12

12. DEFINICIÓN DE CURSOR ...............................................................................................12

13. DEFINICIÓN DE VISTA .................................................................................................. 13

ANEXOS.............................................................................................................................. 15

Estándar de documento de Objetos de Base de Datos Página 2 de 16

1. INTRODUCCIÓN

1.1.OBJETIVOS

Estandarizar la nomenclatura de objetos de base de datos

1.2.ALCANCE

Dirigido al equipo de desarrollo de TI.

1.3. CONTROL DE VERSIONES

EVOLUCION DEL DOCUMENTO

Versión Fecha Autor Detalle de Cambios
1.0 07/12/2018 Elizabeth Aguilar Luza Primera versión de los estándares de
objetos de la base de datos.
1.1 07/12/2018 Elizabeth Aguilar Luza Mejoras al documento:
 Nombre del sistema a una
base de datos.
 Cambios en los comentarios
de procedimientos y vistas
1.2 07/12/2018 Elizabeth Aguilar Luza Mejoras al documento:
 Agregar tipo de datos
personalizados y modo de
utilizar
1.3 07/12/2018 Elizabeth Aguilar Luza Mejoras en el documento:
 Comentarios en los
Procedimientos, Funciones y
vistas

1.4 07/12/2018 Elizabeth Aguilar Luza Mejoras en el estándar de nombres de

procedimientos almacenados y
funciones

2. DEFINICIÓN DE BASE DE DATOS

El nombre de la Base de Datos deberá tener el nombre del sistema, fácil de ubicar el nombre
en una cadena de conexión.

Por ejemplo: ASA

De igual forma, se debe de definir un prefijo que indicará el nombre de la Base de Datos. Por
ejemplo:

El prefijo para utilizar para este documento es: SGR

Estándar de documento de Objetos de Base de Datos Página 3 de 16

3. DEFINICIÓN DE LA TABLA

El nombre de la tabla seguirá la siguiente nomenclatura:

XXX_T_NOMBRE_TABLA

• XXX: Son 3 letras mayúsculas e indica el sistema o subsistema al que pertenece .

• _: un símbolo (raya abajo).

• T: letra en mayúscula que Identifica el tipo de objeto, en este caso una tabla y será la letra
“T”.

• _: un símbolo (raya abajo).

• NOMBRE_TABLA: Identifica el nombre físico de la tabla, debe ser todo en mayúsculas y en

singular. En caso de una tabla temporal se debe añadir el prefijo TEMP. Pon, separar palabras
se debe usar el símbolo "_".

Debe mantenerse el nombre de la tabla padre en la tabla detalle o hija.

Por ejemplo.

SGR_T_LIQUIDACION

SGR_T_LIQUIDACION_DEPOSITO

SGR_T_TEMP_NOMBRE_TABLA

Nota: ludas las tablas deberán tener 4 campos obligatorios en las últimas posiciones, las cuales
son las siguientes.

Nombre Columna Tipo de Dato Descripción

bit_c_iusu_creacion Int Código de usuario quien creo
el registro.
Ejemplo: 01
bit_c_zfech_creacion Int Fecha de la creación del
registro.
bit_c_iusu_modificacion Int Código de usuario quien
modifico el registro.
bit_c_zfech_modificacion Int Fecha de modificación del
registro.
Ejemplo: 01

Si por algún caso se desea agregar columnas adicionales a las tablas, estos campos nuevos
deben ser antes de las 3 columnas mencionadas anteriormente.

Estándar de documento de Objetos de Base de Datos Página 4 de 16

4. DEFINICIÓN DE COLUMNA O CAMPO

El nombre de la columna, o campo, seguirá la siguiente nomenclatura:

nemonico_tabla_c_znombre_columna

Donde:

• nemonico_tabla: Son 3 letras minúsculas e indican la tabla a la que pertenece la columna.

Esta parte puede variar dependiendo de la longitud del nombre de la tabla, en tablas padres
puede seguir esta nomenclatura, en tablas hijas, dependientes o detalle esta parte de la
nomenclatura puede variar, principalmente aumentar y usar "_" para separar palabras.

• _: Es un símbolo (raya abajo).

• c: Letra minúscula que identifica el tipo de objeto, en este caso una columna y será la letra
"c".

• _: Es un símbolo (raya abajo).

• z: Letra minúscula que identifica el tipo de dato del objeto. Ver anexo 1.

• nombre_columna: identifica el nombre de la columna, debe ser todo en minúsculas y en

singular. Para separar palabras se debe usar el símbolo"_'.

Por ejemplo:

CREATE TABLE SGR_T_ESTADO_LIQUIDACION (

esl_c_icod_est_liquidacion Int identity (1,1) PRIMARY KEY,

esl_c_vnom_esta_liquidacion Varchar (100) null,

esl_c_bactivo bit null,

5. TIPO DE DATOS PERSONALIZADOS

Podemos crear nuestros propios tipos de datos, la cual tiene como objetivo generalizar los
tipos de datos para aquellos campos reutilizados en los objetos de la base de Datos.

Ejemplo: CREATE TYPE TYP_DNI FROM char1(8) NULL

Modo de utilizar:

declare @ityp_dni TYP_DNI

set @ityp_dni = '12345678'

print @ltyp_dni

Estándar de documento de Objetos de Base de Datos Página 5 de 16

6. DEFINICIÓN DE OBJETOS DE INTEGRIDAD REFERENCIAL

6.1. Primary Key

Un primary key seguirá la siguiente nomenclatura:

PK_XXX_T NOMBRE TABLA

Donde:

• PK: prefijo que denomina a un Primary Key.

• _: Es un símbolo (raya abajo).

• XXX_T NOMBRE_TABIA: este punto está definido en el tema de definición

tablas.

Por ejemplo:

ALTER TABLE [dbo].[SGR_T_CARTERA_JEFE] ADD CONSTRAINT

[PK_SGR_T_CARTERAJEF]

PRIMARY KEY (car_c_icod_cartera_jefe)

6.2. Foreign Key

Un foreign key seguirá la siguiente nomenclatura:

FK_XXXJ_NOMBRETABLAORIGEN_XXX_T_NOMBRE_TABLAREFERENCIA

Donde:

• FK: prefijo que denomina a un Foreign Key.

• _: Es un símbolo (raya abajo).

• XXX_T_NOMBRE_TABLAORIGEN: este punto está definido en el tema de

definición de tablas, y específica a la tabla origen.

• _: Es un símbolo (raya abajo).

• XXX_T_NOMBRE_TABLAREFERENCIA: este punto está definido en el tema de

definición de tablas, y específica a la tabla de referencia.

Por ejemplo:

ALTER TABLE [dbo].[SGR_T_CARTERA_JEFE] WITH CHECK ADD CONSTRAINT

[fk_SGR_T_CARTERAJEFE_SGR_T_EJECUTIVO]

FOREIGN KEY([car_c_ijefe])

REFERENCES [dbo].[SGR_T_EJECUTIVO_COMERCIAL]
([eje_c_iCod_ejecutivo_comercial])

6.3. Default

Un Default seguirá la siguiente nomenclatura:

Estándar de documento de Objetos de Base de Datos Página 6 de 16

 DF_NEMONICO_TABLA_NEMONICO_COLUMNA

Donde:

• DF: prefijo que denomina a un Default.

• _: Es un símbolo (raya abajo).

• NEMONICO_TABLA: En lugar de colocar el nombre de la tabla con su

nomenclatura específica, se utiliza un nemónico o palabra clave para un mayor
entendimiento. Es un símbolo (raya abajo).

•NEMONICO_COLUMNA: En lugar de colocar el nombre del campo con su

nomenclatura específica, se utiliza un nemónico o palabra clave para un mayor
entendimiento.

Por ejemplo:

ALTER TABLE SGR_T_LIQUIDACION ADD CONSTRAINT DF_LIQ_MONTO

DEFAULT 0.00 FOR liq_c_emonto

6.4. Check

Un Check seguirá la siguiente nomenclatura:

CK_NEMONICO_TABLA_NEMONICO_COLUMNA

• CE: prefijo que denomina a un Check.

• NEMONICO_TABLA: En lugar de colocar el nombre de la tabla con su

nomenclatura Donde: específica, se utiliza un nemónico o palabra clave para
un mayor entendimiento.

•: Es un símbolo (rayan bajo).

• NEMONICO_COLUMNA: En lugar de colocar el nombre del campo con su

nomenclatura específica, se utiliza un nemónico o palabra clave para un mayor
entendimiento.

Por ejemplo:

ALTER TABLE SGR_T_VENTA ADD CONSTRAINT CK_VEN_ABREV CHECK (LEN

(inmu_c_cabrev_inmu) = 4)

Estándar de documento de Objetos de Base de Datos Página 7 de 16

7. DEFINICIÓN DE INDICE

El nombre de un índice seguirá la siguiente nomenclatura:

IDX_ XXX_T_NOMBRE_TABLA_CORRELATIVO

Donde:

• IDX: prefijo que denomina a un Índice.

• _: Es un símbolo (raya abajo).

• XXX_T_NOMBRE_TABLA: este punto está definido en el tema de definición de tablas.

• _: Es un símbolo (raya abajo).

• CORRELATIVO: número correlativo que indicara el orden del índice.

Por ejemplo:

CREATE INDEX IDX_SGR_T_VENTA_01 ON SGR_T_VENTA (ven_c_icod_vent ASC,

ven_c_vnomb DESC)

8. DEFINICIÓN DE VARIABLES Y PARAMETROS

Una variable o parámetro debe seguir la siguiente nomenclatura:

@XY_NOMBRE

Donde:

• @: símbolo (arroba) es obligatorio anteponerlo por restricciones propias del

manejador de Base de datos.

• X: Letra mayúscula que identifica el tipo de objeto que se desea declarar.

— 'P': Parámetros

— 'I': Variables locales.

• Y: Letra que identifica el tipo de dato del objeto. Ver anexo 1.

• _: Es un símbolo (raya abajo).

• NOMBRE: Se detalla el nombre del objeto, ya sea parámetro o variable, debe ser en
mayúsculas y minúsculas.

Por ejemplo:

@pv_nomb_cli

@Ii_cod_clie

Estándar de documento de Objetos de Base de Datos Página 8 de 16

9. DEFINICIÓN DE PROCEDIMIENTO ALMACENADO

El nombre de un procedimiento almacenado seguirá la siguiente nomenclatura:

XXX_SP_NEMONICO_ACCION

Donde:

• XXX: Son 3 letras mayúsculas e indica el sistema o subsistema al que pertenece.

• Es un símbolo (raya abajo).

• SP: prefijo que denomina a un procedimiento almacenado.

• _: Es un símbolo (raya abajo).

• NEMONICO: Nombre de la tabla o modulo al cual hace referencia, es necesario que

el nemónico denote un nombre significativo para el mejor manejo y ubicación de
procedimiento almacenados. Se puede utilizar el guion bajo (_) para nemónico que
representen palabras compuestas.

• _: Es un símbolo (raya abajo).

• ACCION: Se detalla la acción que se ejecutará en el procedimiento almacenado. Ver

anexo 2.

 El nombre del Procedimiento debe ser singular y en mayúscula.

Estructura del procedimiento almacenado:

• Cabecera; Todos los procedimientos almacenados deberán tener los siguientes comentarios
en la cabecera.

✓ Descripción: Descripción / Objetivo de funcionalidad del procedimiento.

✓ Retorno N/A - Tipo de Dato que devuelve. Ejemplo: String, Table,

✓ Notas: N/A

✓ Autor y Documento: Nombre y Apellido del autor del Procedimiento y el numero de

documento

✓ Fecha y Hora Fecha y hora de Creación/Modificación de Cambios Importantes

✓ Modificaciones: Autor, Fecha, Descripción de Modificaciones.

✓ Ejecución: Ejecutar el procedimiento

• Declaración de Parámetros

✓ Parámetros

• Declaración Variables locales

✓ Mayúsculas y minúsculas

Estándar de documento de Objetos de Base de Datos Página 9 de 16

• Sentencias SQL

✓ Palabras del lenguaje SQL, y funciones de sistema en MAYÚSCULAS.

✓ Sentencias legibles (cada cláusula SQL en una línea nueva).

Por ejemplo:

CREATE PROCEDURE [dbo].[SGR_SP_CLIENTE_ELIMINAR]

/***********************************************
Descripción: Elimina el registro de un cliente en la base de datos
Retorno: N/A
Notas: N/A
Autor y Documento: Elizabeth Alondra Aguilar Luza
Fecha y Hora: 29/11/2018
Modificaciones: N/A
Ejecución: N/A
*************************************************/
@pi_Cod_cliente Int
as
Begin
update SGR_T_CLIENTE set clie_c_bactivo = 0
WHERE clie_c_iCod_cliente= @pi_Cod_cliente
End

10. DEFINICIÓN DE FUNCIONES

El nombre de una función seguirá la siguiente nomenclatura:

XXX_FS_ ACCION

Donde:

• XXX: Son 3 letras mayúsculas e indica el sistema o subsistema al que pertenece.

• _: Es un símbolo (raya abajo).

• FS: prefijo que denomina a una función.

• _: Es un símbolo (raya abajo).

• ACCION: Se detalla la acción que se ejecutará en la función.

• El nombre de la función debe ser singular y en mayúscula.

Estructura de la función:
• Cabecera: Todas las funciones deberán tener los siguientes comentarios en la cabecera.

✓ Descripción: Descripción / Objetivo de funcionalidad de la función.

✓ Retorno: N/A— Tipo de Dato que devuelve. Ejemplo: String, Int,

Estándar de documento de Objetos de Base de Datos Página 10 de 16

 ✓ Notas: N/A

✓ Autor y Documento: Nombre y Apellido del autor de la función y Código de

documento.

✓ Fecha y Hora: Fecha y hora de Creación/Modificación de Cambios Importantes

✓ Modificaciones: Autor, Fecha, Descripción de Modificaciones.

✓ Ejecución: Ejecutar la función

• Declaración de Parámetros

✓ Parámetros

• Declaración Variables locales

✓ Mayúsculas y minúsculas

• Sentencias SQL

✓ Palabras del lenguaje SQL, y funciones de sistema en MAYUSCULAS.

✓ Sentencias legibles (cada cláusula SQL en una línea nueva).

Por ejemplo:

CREATE FUNCTION [dbo].[SGR_FS_FECHA]

/***********************************************
Descripción: Obtiene las fechas de las 54 semanas del mes
Retorno: N/A
Notas: N/A
Autor y Documento: Elizabeth Alondra Aguilar Luza
Fecha y Hora: 29/11/2018
Modificaciones: N/A
Ejecución: N/A
*************************************************/
<Declaración de variables input>
<As>
<Declaración de variables locales>
<Sentencias SQL>

End

Estándar de documento de Objetos de Base de Datos Página 11 de 16

11. DEFINICIÓN DE TRIGGER

Un trigger debe seguir la siguiente nomenclatura:

TR_XXX_T_NOMBRE_TABLA_YYY_CORRELATIVO

Donde:

• TR: prefijo que denomina a un Trigger.

• _: Es un símbolo (raya abajo).

• XXX_T_NOMBRE_TABLA: este punto está definido en el tema de definición de tablas.

• _: Es un símbolo (raya abajo).

• YYY: Letras mayúscula que representa el tipo de lógica del trigger. Puede ser una letra, o
más, dependiendo si el trigger está diseñado para realizar más de un tipo de acción (insert,
update, select). Ver anexo 3.

• _: Es un símbolo (raya abajo).

• CORRELATIVO: número correlativo que indicara el orden del trigger

Por ejemplo:

CREATE TRIGGER TR_SGR _T_VENTA _01

ON TR_SGR _T_VENTA
FOR INSERT
AS BEGIN
.
.

END

12. DEFINICIÓN DE CURSOR

Un cursor debe seguir la siguiente nomenclatura:

CUR_NOMBRE_CURSOR

Donde:

• CUR: prefijo que denomina a un Cursor

• _: Es un símbolo (raya abajo).

• NOMBRE_CURSOR identifica el nombre del cursor, debe ser todo en mayúsculas y en

singular. Para separar palabras se debe usar el símbolo "_".

Por ejemplo:

Estándar de documento de Objetos de Base de Datos Página 12 de 16

-- Se declara un cursor para almacenar las zonas que existen en Lima

DECLARE CUR_ZON_LIMA
CURSOR FOR SELECT ... FROM ... WHERE

13. DEFINICIÓN DE VISTA

Una vista debe seguir la siguiente nomenclatura:

XXX_VW_NEMONICO_ACCION

Donde:

• XXX: Son 3 letras mayúsculas e indica el sistema o subsistema al que pertenece.

• _: Es un símbolo (raya abajo).

• VW: prefijo que denomina a una vista.

• _: Es un símbolo (raya abajo).

• NEMONICO: Nombre de la tabla(s) o modulo al cual hace referencia, es necesario

que el nemónico denote un nombre significativo para el mejor manejo y ubicación de
procedimiento almacenados. Se puede utilizar el guion bajo (_) para nemónico que
representen palabras compuestas.

• _: Es un símbolo (raya abajo).

• ACCION: Se detalla la acción que se visualizará en la vista. Ver anexo 2.

Estructura de la vista:
• Cabecera Todas las vistas deberán tener los siguientes comentarios en la cabecera.

✓ Descripción: Descripción / Objetivo de funcionalidad de la función.

✓ Retorno: N/A— Tipo de Dato que devuelve. Ejemplo: String, Int,

✓ Notas: N/A

✓ Autor y Documento: Nombre y Apellido del autor de la función y Código de

documento.

✓ Fecha y Hora: Fecha y hora de Creación/Modificación de Cambios Importantes

✓ Modificaciones: Autor, Fecha, Descripción de Modificaciones.

• Sentencias SQL.

✓Palabras del lenguaje SQL. y funciones de sistema en MAYU5CULAS

✓ Sentencias legibles (cada cláusula SQL en una línea nueve)

Por ejemplo:

CREATE VIEW SGR_VW_VEN_LISTAR

Estándar de documento de Objetos de Base de Datos Página 13 de 16

 /***********************************************
Descripción: Obtiene las fechas de las 54 semanas del mes
Retorno: N/A
Notas: N/A
Autor y Documento: Elizabeth Alondra Aguilar Luza
Fecha y Hora: 29/11/2018
Modificaciones: N/A
*************************************************/
<Declaración de variables input>
<As>
<Declaración de variables locales>
<Sentencias SQL>

End

Estándar de documento de Objetos de Base de Datos Página 14 de 16

 ANEXOS

Anexo 1:

Abreviatura de tipo de datos:

CARÁCTER TIPO DE DATO

C Char
D Date
S Smalldatetime
I Int
N Numeric
V Varchar
B Bit
G Bigint
A Binary
E Decimal
F Float
Z Datetime
O Money
H Nchar
T Ntext
R Nvarchar
L Real
Q Sql_Variant
X Text
P TimesTamp
Y TinyInt
U UniqueIdentifier
TYP Tipo de dato personalizado
M XML

Anexo 2:

Definición de posibles acciones de los procedimientos almacenados y funciones

REPRESENTACIÓN DEL ESTÁNDAR ACCION

INSERTAR Insertar
ELIMINAR Eliminar
ACTUALIZAR Actualizar
SELECCIONAR Seleccionar un solo registro
LISTAR Listar varios registros sin filtros

Estándar de documento de Objetos de Base de Datos Página 15 de 16

 BUSCAR Buscar varios registros en función a filtros
CALCULAR Realizar un calculo que contengan operaciones matemáticas
ENVIAR Envía un correo electrónico después de N consultas

Anexo 3:

Letras para definir el tipo del trigger

CARACTER TIPO DE LOGICA

I INSERT
U UPDATE
D DELETE

Estándar de documento de Objetos de Base de Datos Página 16 de 16