HOWTO · PostgreSQL

Convenciones de nomenclatura de PostgreSQL

Aprende una forma coherente de nombrar las bases de datos, tablas, secuencias, claves, restricciones e índices de PostgreSQL, y cómo se comportan los identificadores entre comillas.

En esta página

Elige una convención de nombres legible para tu proyecto y aplícala a las bases de datos, tablas, secuencias, claves primarias, restricciones e índices. PostgreSQL no exige un estilo universal; la coherencia ayuda a los desarrolladores a encontrar y mantener los objetos.

Convenciones de nomenclatura de PostgreSQL

Las reglas para los identificadores de PostgreSQL son independientes de las decisiones de estilo. Escribir las palabras clave de SQL en mayúsculas es una convención de formato. Para los identificadores, una opción práctica es usar palabras en minúsculas separadas por guiones bajos, por ejemplo, customer_order o created_at. Usa nombres descriptivos y sigue un patrón coherente para las tablas, columnas, secuencias, restricciones e índices. Nombres como customer_order_pkey, customer_order_status_check y customer_order_created_at_idx ayudan a reconocer la función de cada objeto.

Un identificador sin comillas se convierte a minúsculas, por lo que Employee, EMPLOYEE y employee hacen referencia al mismo nombre. Un identificador entre comillas conserva las mayúsculas y minúsculas: "Employee" es distinto y debes escribirlo siempre con las mismas comillas dobles y la misma combinación de mayúsculas y minúsculas. Para simplificar las consultas y las herramientas, prefiere los nombres en minúsculas sin comillas. Evita usar palabras reservadas como nombres. Poner una palabra entre comillas no la vuelve inutilizable, pero obliga a citarla y puede dificultar el mantenimiento del SQL.

Adapta el patrón a la función de cada objeto. El nombre de una tabla suele ser un sustantivo en singular o plural, siempre que el esquema siga un criterio coherente; los nombres de las columnas describen el valor almacenado; y el nombre de una secuencia puede indicar qué tabla y clave proporciona. En las restricciones y los índices, incluye el nombre de la tabla o la columna y un sufijo como _pkey, _key, _check o _idx. Estos sufijos son convenciones, no requisitos de PostgreSQL. PostgreSQL puede generar nombres para las restricciones y los índices que no tengan uno explícito, pero asignarles nombres facilita la lectura de las migraciones, los mensajes de error y las consultas de mantenimiento. Procura que los nombres sean concisos y no superen el límite de longitud de los identificadores de PostgreSQL; los nombres más largos se truncan, lo que puede hacer que otros nombres similares entren en conflicto.

Esta secuencia de pasos está pensada para una sesión interactiva de psql conectada a una base de datos en la que tu rol tenga permiso para crear bases de datos. Primero ejecuta el comando para crear la base de datos y luego conéctate a ella con el metacomando de psql. Las instrucciones SQL siguientes crean la secuencia, la tabla, las restricciones de clave primaria y de unicidad, y un índice secundario. Los comandos finales de psql muestran las definiciones de la base de datos, la secuencia y la tabla. Necesitas PostgreSQL para ejecutar este recorrido; los comandos no son la transcripción de una sesión real del servidor.

  1. Crea una base de datos independiente para la demostración con CREATE DATABASE naming_demo;.
  2. Conéctate a ella con \connect naming_demo.
  3. Crea la secuencia de la clave con CREATE SEQUENCE employee_id_seq;.
  4. Crea la tabla con CREATE TABLE employee (employee_id integer DEFAULT nextval('employee_id_seq'::regclass), first_name text NOT NULL, last_name text NOT NULL, email_address text NOT NULL, CONSTRAINT employee_pkey PRIMARY KEY (employee_id), CONSTRAINT employee_email_address_key UNIQUE (email_address));.
  5. Asocia la secuencia a la columna de la clave con ALTER SEQUENCE employee_id_seq OWNED BY employee.employee_id;.
  6. Añade un índice con nombre propio mediante CREATE INDEX employee_last_name_idx ON employee (last_name);.
  7. Examina la base de datos con \l naming_demo, la secuencia con \ds employee_id_seq y la tabla con \d employee. La descripción de la tabla muestra sus columnas, restricciones e índices, incluidos employee_pkey, employee_email_address_key y employee_last_name_idx.

Los nombres entre comillas son útiles cuando un esquema existente requiere mayúsculas y minúsculas combinadas o signos de puntuación, pero establecen una convención que tendrás que mantener: cada referencia debe conservar la grafía exacta y llevar comillas dobles. Se puede usar un nombre entre comillas que coincida con una palabra clave cuando PostgreSQL lo permita, aunque los lectores pueden confundirlo fácilmente con la sintaxis de SQL. Para evitar esa dificultad, elige una alternativa como user_account. Los nombres en minúsculas sin comillas se ajustan de forma natural a la conversión que aplica PostgreSQL y suelen ser más fáciles de usar en consultas, scripts y herramientas de bases de datos.

Este fragmento de Python da formato a un pequeño conjunto de nombres de ejemplo. Ilustra una convención de nomenclatura y no se conecta a PostgreSQL. Ejecuta este ejemplo:

objects = ["customer order", "created at", "customer order pkey"]
names = [name.replace(" ", "_") for name in objects]
print("\n".join(names))
customer_order
created_at
customer_order_pkey