...
Limite de caracteres: 128 caracteres, conforme especificação do SQL Server 7/2000.
Escrita: Todos os nomes devem ser compostos por letras minúsculas, com palavras separadas por underscore ("_")e a segunda palavra começando com letra Maiúscula, exemplo, 'nomeUsuario'. Isso garante legibilidade e independência de autor.
Caracteres permitidos: Apenas caracteres alfabéticos (letras) são permitidos, sem acentuação, sem números, espaços ou caracteres especiais, exceto o underscore ("_").
Prefixos: Quando necessários, os prefixos (como sigla do sistema e tipo de objeto) devem ser separados por underscore.
Máximo de cinco palavras para definir o nome do objeto, além dos prefixos.
...
Sigla: O sistema será identificado por uma sigla de no mínimo duas e no máximo três letras, representando as palavras mais significativas para o sistema. A palavra "sistema" não será utilizada.
Exemplos:
ACP eSiPROC - Sistema de Auditoria de Contas PúblicasProcessos eletrônicos Interno
CA - Sistema de Contas Anuais
LRF - Sistema de Lei de Responsabilidade Fiscal
...
O nome do banco de dados será a sigla do sistema que contém a maior parte de suas tabelas.
Exemplos:
ACP, CA, LRF., Sfinge_gp, Editor_TCE, SGI
🗂 Tipo de objetos
As abreviações para os tipos de objetos são as seguintes:
Objeto | Abreviação | ||
---|---|---|---|
Stored Procedures | PR | ||
Views | VW | ||
Trigger | TR | ||
Funções | FN | ||
User Data Types | UD | ||
Default | DF | Rule | RL |
Constraint Check | CK | ||
Constraint Foreign Key | FK | ||
Constraint Unique Key | UKUQ | ||
Constraint Primary Key | PK |
🗒️ Entidades / Tabelas
Os nomes das entidades e tabelas devem ser escritos no singular, refletindo a funcionalidade da tabela.
A abreviação do sistema será precedida ao nome da tabela.
Não deve ser incluída a abreviação do tipo de objeto.
Exceção: Tabelas compartilhadas entre sistemas terão o prefixo do sistema que mantém os dados. Tabelas gerais terão a abreviação "TAB".
Exemplos:
ACP_CLIENTE Servidor (tabela de clientes servidor do sistema ACP)
TAB_TIPO_UNIDADE tipoUnidade (tabela geral de tipo de unidade);
...
Os nomes dos atributos devem ser compostos no singular, utilizando letras minúsculas, e as palavras devem ser separadas por underscores.
Os nomes dos atributos não podem conter o nome da entidade ou tabela.
A classe do atributo será representada por abreviações conforme a tabela abaixo.
ClasseAbreviação | Descrição | Exemplo | |
---|---|---|---|
CódigoCD | Valor codificado, numérico ou alfanumérico.cd_clienteautoincremento | Identificador | |
DataDT | Data (dia, mês, ano). | dt_inicio_funcionamentodataFuncionamento | |
Descrição | DE | Texto livre representando uma descrição. | de_observacoesobservacoesDetalhes |
HoraHR | Hora, minuto e segundo. | hr_inicio_funcionamentohoraInicio | |
IndicadorIN | Flag ou status binário (SIM ou NÃO). | in_cumprimento_pessoalIndicativoOutrasOpcoes | |
NomeNM | Texto alfanumérico para nomes. | nm_unidade_gestoranomeUnidade | |
Número | NU | Valor numérico identificador. | nu_processonumeroProcesso |
QuantidadeQT | Quantidade de algo. | qt_entradaquantidadeEntrada | |
Sigla | SG | Sigla ou abreviação. | sg_unidade_gestorasgUnidade |
ValorVL | Valor numérico geral. | vl_preco_mediovalorPreco |
📈 Stored Procedures
Os nomes das stored procedures devem seguir este formato:
Prefixo do sistema + Tipo de objeto (PR) + Entidade/tabela + Operação a ser realizada.
Exemplo: ACPeSIPROC_PR_CLIENTE_INCLUI, LRF_PR_DEMONSTRATIVO_MUNICIPIO_ATUALIZAmunicipioAtualiza
As stored procedures de administração do banco terão o prefixo ADM.
Exemplo: ADM_PR_TECNICO_INCLUIBackupFullBases
Observação: Deve-se procurar criar Stored Procedures pequenas, com poucas funcionalidades, de modo a eliminar situações como executar comandos variados de acordo com o valor de um parâmetro de entrada.
...
O nome das triggers deve seguir o formato:
Prefixo do sistema + Tipo de objeto (TR) + Entidade/tabela associada + Operação realizada.
Exemplo: ACPeSIPROC_TR_INTERESSADO_NOVO_DELETE, ACPeSiproc_TR_SESSAO_UPDATEsessaoUpdate
📐 Funções
Os nomes das funções devem ser compostos da seguinte maneira:
Prefixo do sistema + Tipo de objeto (FN) + Funcionalidade da função.
Exemplo: ACPeSIPROC_FN_CALCULA_CPF
🗃️ Rules
O nome das regras será composto por:
Abreviação do tipo de objeto (RL) + Prefixo do sistema + Definição da regra.
Exemplo: RL_CA_ENTRE_ZERO_CEM (para uma validação entre 0 e 100)
calculaCPF
📌 Constraints
Default
O nome da constraint será composto por:
Abreviação do tipo (DF) + Prefixo do sistema + Definição Nome da Tabela onde se esta criando a definição da constraint.
Exemplo: DF_ACP_SIMServidor
🖊️ Check
A constraint Check será nomeada conforme:
Abreviação do tipo (CK) + Nome do atributo.
Exemplo: CK_Tipo_CargotipoCargo
🔑 Primary Key
A constraint Primary Key será nomeada conforme:
Prefixo PK + Nome da tabela + Coluna da chave primária.
Exemplo: PK_ACP_CARGO_tp_cargoServidor
🗝️ Foreign Key
A constraint Foreign Key será nomeada conforme:
Prefixo FK + Nome da tabela filha + Nome da tabela pai + Coluna de referência da tabela filha.
Exemplo: FK_ACPServidor_CARGO_ACP_RESPONSAVEL_tp_cargoLotacaocd_lotacao
📒 Tipo de Dados Utilizados no SQL Server
O TCSC TCE/SC utiliza os seguintes tipos de dados no SQL Server para garantir consistência e precisão nas tabelas:
Tipo de Dados | SQL Server |
Numérico | Tinyint, Int, Smallint, Bigint |
Texto | Varchar(n) |
Data | Date, Datetime |
Binário | BIT (0, 1, NULL) |
Valor Monetário | Decimal(n,m) |
Caractere | Char(1) |
📒 📗 Auditoria e Segurança
As tabelas de auditoria devem seguir o padrão de colunas como:
tp_operacao tipoOperacao (Tipo da operação realizada, valores A-Alteração, E-Exclusão, I-Inclusão)
dt_ocorrencia dataOcorrencia (Data e hora da operação)
nunumeroMatricula_matricula_aud (Identificador do auditor ou responsável pela operação)
...
Code Block |
---|
Create table dbo.Auditoria ( tp_operacaotipoOperacao varchar(10), dt_ocorrenciadataOcorrencia datetime, nu_matriculanumeroMatricula_aud sysname not null ) |
...