LINEAMIENTO PARA NOMBRAMIENTO DE BASES DE DATOS Bogotá D.C., Marzo de 2014 LINEAMIENTO PARA NOMBRAMIENTO EN BASES DE DATOS Proceso asociado: Tecnología de Información y Comunicaciones Código: L – TI -12 Versión: 01 TABLA DE CONTENIDO 1. 2. 3. 4. 4.1 4.2 4.3 4.4 4.5 4.6 5. 6. 7. 8. OBJETIVO -------------------------------------------------------------------------------------------- 3 ALCANCE -------------------------------------------------------------------------------------------- 3 TERMINOS Y DEFINICIONES ------------------------------------------------------------------ 3 ESQUEMA DE DENOMINACION BASES DE DATOS ----------------------------------- 4 ESQUEMAS --------------------------------------------------------------------------------------- 4 BASES DE DATOS, NOMBRES Y RUTAS DE ARCHIVO ---------------------------- 4 TABLAS Y VISTAS ------------------------------------------------------------------------------ 5 CAMPOS ------------------------------------------------------------------------------------------- 5 ÍNDICES -------------------------------------------------------------------------------------------- 6 PROCEDIMIENTOS ALMACENADOS Y FUNCIONES -------------------------------- 7 MARCO LEGAL ------------------------------------------------------------------------------------- 7 REQUISITOS TÉCNICOS ------------------------------------------------------------------------ 8 DOCUMENTOS ASOCIADOS -------------------------- ¡Error! Marcador no definido. RESPONSABLE DEL DOCUMENTO --------------------------------------------------------- 8 2 LINEAMIENTO PARA NOMBRAMIENTO EN BASES DE DATOS Proceso asociado: Tecnología de Información y Comunicaciones Código: L – TI -12 Versión: 01 1. OBJETIVO Describir los lineamientos a seguir para el nombramiento de los objetos dentro de las bases de datos que se desarrollan en el Área de Información y Sistemas del Departamento Administrativo de la Presidencia de la República aplicando las mejores prácticas. 2. ALCANCE El presente lineamiento aplica para el nombramiento de los objetos o elementos que componen las bases de datos (tablas, campos, esquemas, procedimientos almacenados, vistas, índices, llaves, etc.), desarrolladas o administradas por el Área de Información y Sistemas del Departamento Administrativo de la Presidencia de la República. 3. TERMINOS Y DEFINICIONES Camel Case: es una metodología de nombramiento que consiste en dejar la primer palabra en minúsculas y la siguiente solo con la inicial en mayúscula sin espacios Ejemplo: primeraSesion. Base de datos: Es una agrupación de datos o información de forma estructurada en forma de tablas Esquema: Describe la estructura de la base de datos en un leguaje formal soportado por un sistema administrador de base datos (DBMS). Campos: Es un espacio de almacenamiento para un dato almacenado en la base de datos, pueden tener diferentes tipos con enteros, texto, valores lógicos etc. Tablas: Es el tipo de modelado donde se almacenan los datos en campos que la componen. Vistas: Es una consulta accesible de una o varias tablas de una base de datos, se muestra en forma de tabla también. Clúster: es una tecnología que permite “unir recursos computacionales” para las bases de datos y permite utilizar hardware que no sea muy costoso. 3 LINEAMIENTO PARA NOMBRAMIENTO EN BASES DE DATOS Proceso asociado: Tecnología de Información y Comunicaciones Código: L – TI -12 Versión: 01 4. ESQUEMA DE DENOMINACION BASES DE DATOS El nombramiento de los objetos que componen las bases de datos puede ser creado sin restricciones, ni lineamientos. Por tal motivo, este documento comprende los lineamientos para la creación o modificación de objetos o elemento de las base de datos que se desarrollan en el Área de Información y Sistemas del Departamento Administrativo de la Presidencia de la República. 4.1 ESQUEMAS El nombre del esquema debe venir precedido (SCHEMA_NAME) y seguido por el carácter ( _ ). El nombre debe reflejar de manera precisa y exacta el contenido y su función. Se recomienda la notación Camel Case. No se deben utilizar espacios en el nombre de archivo El nombre debe ser igual al nombre de la base de datos PREFIJO SCH_ del prefijo SCH EJEMPLO [Servidor].[SCH_Plan_Compras].[Base_datos] * [Servidor] .[SCH_Seguridad].[Base_datos] * [Servidor].[SCH_Palacio].[Base_datos] * [Servidor].[SCH_SIG].[Base_datos] * *Nota: Se recomienda que los prefijos vayan escritos en letra mayúscula, y los nombres de los objetos utilizar la notación Camel Case. 4.2 BASES DE DATOS, NOMBRES Y RUTAS DE ARCHIVO El nombre de la base de datos debe venir precedido del prefijo BDS (Base de datos) y seguido por el carácter ( _ ) El nombre debe reflejar de manera precisa y exacta el contenido y su función. Se recomienda la notación Camello o Camel Case. No se deben utilizar espacios en el nombre de archivo 4 LINEAMIENTO PARA NOMBRAMIENTO EN BASES DE DATOS Proceso asociado: Tecnología de Información y Comunicaciones Código: L – TI -12 Versión: 01 El nombre del archivo debe ser igual al nombre de la base de datos PREFIJO BDS_ EJEMPLO [Servidor].[Schema].[BDS_Plan_Compras]* [Servidor] .[Schema].[BDS_SIG]* *Nota: Se recomienda que los prefijos vayan escritos en letra mayúscula, y los nombres de los objetos utilizar la notación Camel Case. 4.3 TABLAS Y VISTAS El nombre de la tabla debe venir precedido del prefijo TBL (Tabla) y seguido por el carácter ( _ ) . Los nombres de las tablas deben reflejar de manera precisa su contenido y función. Se recomienda la notación Camel Case. No se deben utilizar espacios en el nombre de archivo. Los nombres de las vistas siguen las mismas convenciones que los nombres de las tablas. Se recomienda utilizar el prefijo “VWS” PREFIJO TBL_ EJEMPLO [Servidor].[Schema].[Base_datos].[TBL_Cursos]* [Servidor].[Schema].[Base_datos].[TBL_Pagos]* VWS_ [Servidor].[Schema].[Base_datos].[VWS_Personas]* *Nota: Se recomienda que los prefijos vayan escritos en letra mayúscula, y los nombres de los objetos utilizar la notación Camel Case. 4.4 CAMPOS Las siguientes recomendaciones aplican a todos los campos 5 LINEAMIENTO PARA NOMBRAMIENTO EN BASES DE DATOS Código: L – TI -12 Proceso asociado: Tecnología de Información y Comunicaciones Versión: 01 El nombre de los campos deben venir precedido del prefijo PK o FK, seguido por el carácter ( _ ). Cada nombre de correspondiente. Cada nombre de campo debe derivarse del identificador utilizado durante el proceso de análisis de negocio. No se deben utilizar palabras reservadas como nombres de campos. Campos Campos propios campo debe ser único PREFIJO [servidor].[SCH_Plan_Compras].[bds_Pla n_Compras].[TBL_Pagos] [servidor].[SCH_Plan_Compras].[bds_Pla n_Compras].[TBL_Contabilidad] [servidor].[SCH_Plan_Compras].[bds_Pla n_Compras].[TBL_Personas] dentro de su tabla EJEMPLO PGS_Descripcion* CTB_ValorMoneda* PSN_Observaciones* *Nota: Se recomienda que los prefijos vayan escritos en letra mayúscula, y los nombres de los objetos utilizar la notación Camel Case. 4.5 ÍNDICES Los índices se nombran considerando la tabla a la que están relacionados y el propósito del índice. • Las claves primarias utilizan el texto “PK” como sufijo o prefijo, según se considere conveniente • Las claves foráneas utilizan el texto “FK” como sufijo o prefijo, según se considere conveniente • Los índices agrupados utilizan el sufijo o prefijo “IDX”, según se considere conveniente Campos Campos Clave o Primary Key PREFIJO PK_ (Primary Key) EJEMPLO PK_PGS_Curso* 6 LINEAMIENTO PARA NOMBRAMIENTO EN BASES DE DATOS Código: L – TI -12 Proceso asociado: Tecnología de Información y Comunicaciones Campos clave foránea FK_ (Foreign Key) Versión: 01 FK_PSN_Municipio* *Nota: Se recomienda que los prefijos vayan escritos en letra mayúscula, y los nombres de los objetos utilizar la notación Camel Case. 4.6 PROCEDIMIENTOS ALMACENADOS Y FUNCIONES Las siguientes recomendaciones aplican a todos las funciones y procedimientos. El nombre de los campos deben venir precedido del prefijo SP o FN, seguido por el carácter ( _ ) Cada nombre de correspondiente. Cada nombre de campo debe derivarse del identificador utilizado durante el proceso de análisis de negocio. campo debe ser único dentro de su tabla No se deben utilizar palabras reservadas como nombres de campos. Campos Store procedures PREFIJO SP_ EJEMPLO SP_ReporteSalidasFuncionarios* Funciones FN_ FN_FormatoFecha* *Nota: Se recomienda que los prefijos vayan escritos en letra mayúscula, y los nombres de los objetos utilizar la notación Camel Case. 5. MARCO LEGAL Decreto 1360 de 1989 - Inscripción de software en el Registro Nacional del Derecho de Autor, ver nomograma del proceso 7 LINEAMIENTO PARA NOMBRAMIENTO EN BASES DE DATOS Proceso asociado: Tecnología de Información y Comunicaciones Código: L – TI -12 Versión: 01 6. REQUISITOS TÉCNICOS ISO 19139:2007 MODELO RELACIONAL DE CAPA, TABLAS Y CAMPOS 7. RESPONSABLE DEL DOCUMENTO JEFE DE AREA DE INFORMACIÓN Y SISTEMAS 8