Naming

O nome de uma tabela ou coluna é lido muito mais vezes do que é escrito, e trocá-lo depois sai caro: você precisa de uma migration, e toda query, view e linha de código que citam aquele nome mudam junto. Escreva tudo em inglês, use plural na tabela e singular na coluna. Um nome descritivo em inglês raramente colide com uma palavra que a linguagem SQL já reservou para si, então você não precisa de colchetes nem de aspas para escapar o nome.

Os exemplos deste guia seguem a convenção do SQL Server. No PostgreSQL, aplique snake_case em minúsculas. Os princípios de nomenclatura são os mesmos nos dois bancos, e só a grafia muda.

Palavras comuns do português colidem com tipos e funções que a linguagem SQL (Structured Query Language · Linguagem de Consulta Estruturada) já usa: Data é um tipo de data, Time é um tipo de hora e Status aparece em comandos. Quando o nome colide, o banco só aceita a query se você escapar o identificador com colchetes ou aspas, e a partir daí todo mundo que tocar naquela tabela carrega os delimitadores junto.

SELECT [Data], [Time] FROM [TimesDeFutebol];

SELECT MatchDate, TeamName FROM FootballTeams;

A tabela guarda uma coleção, então ela recebe o plural: FootballTeams. Cada coluna descreve uma propriedade de um único registro, então ela recebe o singular: Name, FoundedYear. Ler FootballTeams.Name já diz que estamos olhando o nome de um time dentro da coleção de times.

CREATE TABLE Time
(
  TimeId INT,
  NomeDoTime NVARCHAR(100),
  TotalTitulos INT
);

CREATE TABLE FootballTeams
(
  Id UNIQUEIDENTIFIER NOT NULL DEFAULT NEWID(),
  Name NVARCHAR(100) NOT NULL,
  FoundedYear INT,
  Stadium NVARCHAR(150),
  City NVARCHAR(100),
  Country NVARCHAR(100),
  Coach NVARCHAR(100),
  ChampionshipsWon INT DEFAULT 0,

  CONSTRAINT PK_FootballTeams PRIMARY KEY (Id)
);

Users.UserName diz "usuário" duas vezes. A tabela já dá o contexto, então a coluna carrega só a propriedade: Users.Name, Users.Email. O prefixo repetido cresce em cada SELECT e não acrescenta informação nenhuma.

SELECT
  UserId,
  UserName,
  UserEmail
FROM
  Users;

SELECT
  Users.Id,
  Users.Name,
  Users.Email
FROM
  Users;

Em uma query com mais de uma tabela, a coluna sozinha esconde de onde ela veio. Name pode ser o nome do usuário ou o nome do pedido, e descobrir qual dos dois exige abrir o schema. Escrever Users.Name responde a pergunta na própria linha. Pelo mesmo motivo, o alias de uma letra (u, t, c) fica de fora: ele economiza três caracteres e devolve a dúvida ao leitor.

SELECT
  u.Id,
  Name,
  Email
FROM
  Users u
JOIN
  Orders o ON u.Id = o.UserId;

SELECT
  Users.Id,
  Users.Name,
  Users.Email
FROM
  Users
JOIN
  Orders ON Users.Id = Orders.UserId;

Cada tipo de objeto do banco carrega um prefixo no nome. Ao encontrar IX_PLAYERS_TEAM_ID em um script, você já sabe que é um índice antes de ler o resto da linha, e ao encontrar SP_GET_ORDER_BY_ID já sabe que é uma procedure que busca um pedido por identificador.

No SQL Server, procedures e functions ficam em maiúsculas com sublinhado (SP_GET_ORDER_BY_ID). No PostgreSQL, o mesmo objeto segue o snake_case minúsculo da linguagem (fn_get_order_by_id). O prefixo é o mesmo em ideia; a caixa acompanha o idioma do banco.

Declare cada constraint (regra que o banco impõe sobre os dados) com a palavra CONSTRAINT e um nome seu. Quando você deixa a constraint inline e sem nome, o banco inventa um nome como CK__Players__SquadN__3B75D760. Duas coisas quebram a partir daí: a mensagem de erro que chega ao desenvolvedor cita esse nome ilegível, e o ALTER TABLE ... DROP CONSTRAINT fica impossível de escrever numa migration, porque o nome gerado muda de ambiente para ambiente.

CREATE TABLE Players
(
  Id UNIQUEIDENTIFIER PRIMARY KEY DEFAULT NEWID(),
  TeamId UNIQUEIDENTIFIER NOT NULL REFERENCES FootballTeams(Id),
  SquadNumber INT CHECK (SquadNumber BETWEEN 1 AND 99)
);

CREATE TABLE Players
(
  Id UNIQUEIDENTIFIER NOT NULL DEFAULT NEWID(),
  TeamId UNIQUEIDENTIFIER NOT NULL,
  SquadNumber INT NOT NULL,

  CONSTRAINT PK_Players PRIMARY KEY (Id),
  CONSTRAINT FK_Players_FootballTeams FOREIGN KEY (TeamId)
    REFERENCES FootballTeams (Id),
  CONSTRAINT CK_Players_SquadNumber CHECK (SquadNumber BETWEEN 1 AND 99)
);

O verbo abre o nome da procedure e diz o que ela faz com os dados. GET traz um registro, LIST traz uma coleção filtrada, e essa diferença evita que o chamador espere uma linha e receba mil.

DoDocs v3.7.0 · Desenvolvido por @thiagocajadev · Baseado no trabalho de pmndrs/docs · Poimandres.