Page Comparison

...

• 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:

🗒️  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_tipoUnidade (tabela geral de tipo de unidade);

...

...

• 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_municipioAtualiza

• As stored procedures de administração do banco terão o prefixo ADM.

  • Exemplo: ADM_PR_tecnicoIncluiBackupFullBases

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_sessaoUpdate

📐 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_calculaCPF

🗃️ 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_zeroCem (para uma validação entre 0 e 100)

📌 Constraints

• Default
  O nome da constraint será composto por:

1. Abreviação do tipo (DF) + Prefixo do sistema + Definição Nome da Tabela onde se esta criando a definição da constraint.

2. Exemplo: DF_ACP_SIMServidor

🖊️ Check

• A constraint Check será nomeada conforme:

...

1. Prefixo PK + Nome da tabela + Coluna da chave primária.

2. Exemplo: PK_ACP_CARGO_tipoCargoServidor

🗝️ Foreign Key

• A constraint Foreign Key será nomeada conforme:

1. Prefixo FK + Nome da tabela filha + Nome da tabela pai + Coluna de referência da tabela filha.

2. 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:

...

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)

...

Create table dbo.Auditoria (

  tp_operacaotipoOperacao varchar(10),
  dt_ocorrenciadataOcorrencia datetime,
  nu_matriculanumeroMatricula_aud sysname not null
)

...