{"id":202,"date":"2022-08-23T10:14:16","date_gmt":"2022-08-23T13:14:16","guid":{"rendered":"https:\/\/gerais.defensoria.mg.def.br\/metodologia-de-desenvolvimento\/?post_type=v1&p=202"},"modified":"2024-07-01T14:49:25","modified_gmt":"2024-07-01T17:49:25","slug":"banco-de-dados","status":"publish","type":"v1","link":"https:\/\/gerais.defensoria.mg.def.br\/metodologia-de-desenvolvimento\/sumario\/banco-de-dados\/","title":{"rendered":"Banco de Dados"},"content":{"rendered":"

1- OBJETIVO<\/strong><\/h2>\n

1.1- VIS\u00c3O GERAL DO PROCESSO<\/strong><\/h4>\n

O objetivo deste documento \u00e9 a padroniza\u00e7\u00e3o das nomenclaturas observando regras geralmente aceitas no meio em que se insere a Defensoria P\u00fablica de Minas Gerais e visando as integra\u00e7\u00f5es necess\u00e1rias \u00e0s suas atividades, notadamente aquelas a serem estabelecidas junto a outros \u00f3rg\u00e3os do Governo, seja no Executivo ou no Judici\u00e1rio, n\u00e3o descartando o Legislativo.<\/p>\n

O padr\u00e3o utilizado como base \u00e9 o referencial do Datasus datado de julho de 2018 em conson\u00e2ncia com a norma ISO\/IETEC 11179-5 e padr\u00f5es de interoperabilidade do Governo Federal seguidos por este documento.<\/p>\n

Casos omissos neste documento dever\u00e3o ser sanados pelo documento citado acima ou em comum acordo com a Superintend\u00eancia de Tecnologia da Informa\u00e7\u00e3o da Defensoria P\u00fablica de Minas Gerais.<\/p>\n

2- DEFINI\u00c7\u00d5ES GERAIS<\/strong><\/h2>\n
    \n
  • Constraint<\/strong> – Regras de valida\u00e7\u00e3o que podem ser de integridade, de neg\u00f3cio ou estar sujeitas a determinadas condi\u00e7\u00f5es como valores ou intervalos.<\/span><\/li>\n
  • Modelo de Dados<\/strong> \u2013 Artefato onde s\u00e3o registrados os dados de uma \u00e1rea negocial de um \u00d3rg\u00e3o.<\/span><\/li>\n
  • Objeto<\/strong> \u2013 Toda parte de uma modelo de dados f\u00edsico que \u00e9 pass\u00edvel de implementa\u00e7\u00e3o em um SGBD, por exemplo, tabelas, constraints, \u00edndices, views, etc.<\/span><\/li>\n
  • SGBD<\/strong> \u2013 Sistema Gerenciador de Banco de Dados. O sistema considerado como principal neste documento ser\u00e1 o Postgresql para as aplica\u00e7\u00f5es desenvolvidas pela Institui\u00e7\u00e3o e MySQL como segunda op\u00e7\u00e3o para ferramentas de terceiros.<\/span><\/li>\n
  • Banco de Dados Normalizado<\/strong><\/span> \u2013 Parte do SGBD que consegue armazenar de forma estruturada os dados coletados pelos sistemas da Defensoria.<\/span><\/li>\n
  • Banco de Dados n\u00e3o Normalizado<\/strong><\/span> \u2013 O banco de dados n\u00e3o normalizado adotado pela Institui\u00e7\u00e3o \u00e9 o MONGODB, utilizado para reposit\u00f3rio de arquivo. Para um volume grande de informa\u00e7\u00e3o, utilizamos como segunda op\u00e7\u00e3o o banco de dados Cassandra.<\/span><\/li>\n
  • Banco de Dados em Mem\u00f3ria<\/strong><\/span> \u2013 O banco de dados de armazenamento de chave-valor em mem\u00f3ria adotado pela Institui\u00e7\u00e3o \u00e9 o Redis.<\/span><\/li>\n
  • Esquema<\/strong> \u2013 Agrupamento l\u00f3gico do SGBD destinado a separar bancos de dados com base em sua finalidade (conceito utilizado neste manual).<\/span><\/li>\n<\/ul>\n

    3- NORMAS<\/strong><\/h2>\n

    3.1- NOMENCLATURA DE OBJETOS<\/strong><\/h4>\n

    O nome do objeto deve apresentar clareza, de forma a indicar a sua finalidade no neg\u00f3cio a que est\u00e1 vinculado. N\u00e3o deve ferir a norma culta da l\u00edngua portuguesa.<\/p>\n

    O nome de um objeto de banco de dados dever\u00e1 ser formado por uma ou mais palavras com todas as letras em mai\u00fasculas e no singular, cada uma<\/p>\n

    separada pelo caractere separador underscore (_). A sequ\u00eancia das palavras deve ser l\u00f3gica de tal forma que d\u00ea um significado preciso em Portugu\u00eas.<\/p>\n

    Para a forma\u00e7\u00e3o de cada palavra de um nome, deve-se sempre considerar a portabilidade entre SGBD\u00b4s, sendo assim utilize apenas os caracteres alfab\u00e9ticos n\u00e3o acentuados e num\u00e9ricos.<\/p>\n

    Para o caso de abrevia\u00e7\u00f5es, as seguintes regras devem ser observadas:<\/p>\n

      \n
    • Utilize abrevia\u00e7\u00f5es ou siglas somente quando o nome completo ultrapassar o tamanho m\u00e1ximo estipulado e nestas situa\u00e7\u00f5es, somente se for de aceita\u00e7\u00e3o e conhecimento geral do \u00f3rg\u00e3o;<\/li>\n
    • A palavra principal que comp\u00f5e o nome de um elemento de dado n\u00e3o deve ser abreviada;<\/li>\n
    • Na abrevia\u00e7\u00e3o de palavras, siga as regras definidas no item 5 deste documento.<\/li>\n<\/ul>\n

      Palavras em outro idioma n\u00e3o ser\u00e3o permitidas.<\/p>\n

      As exce\u00e7\u00f5es dever\u00e3o ser tratadas caso a caso.<\/p>\n

      Nome de qualquer tipo de objeto e colunas de tabelas deve possuir a forma\u00e7\u00e3o Prefixo_NomeObjeto.<\/p>\n

      O prefixo para o caso de tabelas e colunas define uma categoriza\u00e7\u00e3o para cada um, sendo que no caso de colunas n\u00e3o \u00e9 indicado tipo e tamanho que deve estar associado, pois isso depende do neg\u00f3cio, mas \u00e9 importante observar o bom senso nesse tipo de defini\u00e7\u00e3o, por exemplo, para colunas cujo tamanho \u00e9 de informa\u00e7\u00f5es conhecidas como CPF ou CNPJ deve-se utilizar o tipo e tamanho de acordo com a defini\u00e7\u00e3o existente, sendo CPF com varchar2(11) e CNPJ com varchar2(14). Para os casos onde o dom\u00ednio est\u00e1 definido em tabela, deve-se utilizar esta como FK<\/p>\n

      O prefixo de cada objeto deve indicar a finalidade do mesmo, conforme definido no Anexo I.<\/p>\n

      Para informa\u00e7\u00f5es comumente utilizadas e que o conjunto dos atributos contidos em cada classe comp\u00f5e uma informa\u00e7\u00e3o foi definido no Anexo II \u201cClasse de Dados\u201d. Exemplos: CPF, telefone, carteira de trabalho, etc. As informa\u00e7\u00f5es contidas nesse anexo, devem seguir as regras l\u00e1 definidas.<\/p>\n

      Para o caso de exclus\u00e3o l\u00f3gica de registro em uma tabela o tratamento deve ser o seguinte:<\/p>\n

      a) Deve ter um campo com nome ST_REGISTRO_ATIVO datatype VARCHAR2(1) e dom\u00ednio S ou N;<\/p>\n

      b) A sua descri\u00e7\u00e3o pode ser \u201cIndica se o registro est\u00e1 ativo ou n\u00e3o (exclu\u00eddo logicamente). O seu dom\u00ednio \u00e9: S \u2013 Sim (est\u00e1 ativo) ou N \u2013 N\u00e3o (n\u00e3o est\u00e1 ativo). O controle no uso de registros exclu\u00eddos deve ser feito pela aplica\u00e7\u00e3o.\u201d;<\/p>\n

      c) Quando a tabela \u00e9 criada j\u00e1 com essa coluna, n\u00e3o \u00e9 obrigat\u00f3rio a defini\u00e7\u00e3o de um valor DEFAULT, mas quando a coluna \u00e9 adicionada em uma tabela j\u00e1 existente, deve- se definir o valor DEFAULT, pois assim a coluna pode ser criada como NOT NULL e o valor DEFAULT ser\u00e1 preenchido para todos os registros existentes na tabela.<\/p>\n

      Para o caso de necessidade de exclus\u00e3o f\u00edsica de registros deve ser informada a necessidade de auditoria ou n\u00e3o. No caso de n\u00e3o necessidade \u00e9 preciso autoriza\u00e7\u00e3o do gestor.<\/p>\n

      O tamanho m\u00e1ximo de um nome de objeto n\u00e3o pode exceder 30 caracteres.<\/p>\n

      No caso de o nome do objeto ultrapassar o tamanho m\u00e1ximo estipulado, a seguinte regra deve ser utilizada:<\/p>\n

        \n
      • Verificar a possibilidade de substituir palavras por acr\u00f4nimos ou siglas;<\/li>\n
      • Abreviar as palavras utilizando-se da norma culta de nossa l\u00edngua.<\/li>\n<\/ul>\n

        No Anexo I, tabela 1, onde s\u00e3o tratados os prefixos dos objetos, as seguintes<\/p>\n

        regras devem ser consideradas para as refer\u00eancias indicadas a seguir:<\/p>\n

          \n
        • [NOME DA TABELA]: nesta refer\u00eancia o nome da tabela n\u00e3o deve conter o prefixo, a menos que seja uma tabela com prefixo RL_, TL_ ou AU_; n\u00e3o deve conter o caractere separador _.<\/li>\n
        • [NOME DA COLUNA]: nesta refer\u00eancia o nome da coluna n\u00e3o deve conter o caractere separador_, sendo que este caractere dever\u00e1 conter quando for utilizada mais de uma coluna (para separar cada coluna).<\/li>\n
        • [NOME FK]: nesta refer\u00eancia o nome da FK deve conter o prefixo; n\u00e3o deve conter o caractere separador _.<\/li>\n<\/ul>\n

          4- ABREVIA\u00c7\u00c3O<\/strong><\/h2>\n

          Para abrevia\u00e7\u00e3o de palavras contidas nos nomes de objetos deve preferencialmente utilizar a regra definida no documento \u201cGoverno Brasileiro – Comit\u00ea Executivo de Governo Eletr\u00f4nico – Cat\u00e1logo de Padr\u00f5es de Dados\u201d. As regras contidas nesse documento s\u00e3o as seguintes:<\/p>\n

          4.1- USO E SIGLAS\/ACR\u00d4NIMOS E ABREVIATURAS NA NOMENCLATURA DE DADOS<\/strong><\/h4>\n

          sempre que poss\u00edvel, evitar o uso de abreviaturas\/acr\u00f4nimos, pois prejudicam o entendimento;<\/p>\n

            \n
          • N\u00e3o devem ser utilizadas preposi\u00e7\u00f5es, e na necessidade de se utilizar verbos, utilize no presente;<\/li>\n
          • Se a palavra, termo ou nome n\u00e3o tiver uma sigla\/acr\u00f4nimos conhecidos, use as diretrizes abaixo para construir a abreviatura;<\/li>\n
          • Apenas palavras que tenham no total mais de 8 caracteres podem ser abreviadas;<\/li>\n
          • A abreviatura deve ter no m\u00e1ximo dois ter\u00e7os do tamanho da palavra original;<\/li>\n
          • Acr\u00f4nimo e abreviaturas devem ter pelo menos 2 caracteres;<\/li>\n
          • Dar prefer\u00eancia a:<\/li>\n<\/ul>\n

            a) Abreviaturas comumente usadas em portugu\u00eas a abreviaturas de neg\u00f3cio;<\/p>\n

            b) Abreviaturas de neg\u00f3cio \u00e0 termos de tecnologia da informa\u00e7\u00e3o;<\/p>\n

            c) Termos da tecnologia da informa\u00e7\u00e3o \u00e0 cria\u00e7\u00e3o de novos;<\/p>\n

            d) Criar abreviaturas evitando ambiguidade.<\/p>\n

            5- RESPONSABILIDADES<\/strong><\/h2>\n

            A Superintend\u00eancia de Tecnologia da Informa\u00e7\u00e3o, atrav\u00e9s da Diretoria de Desenvolvimento em Sistemas e Projetos, validar\u00e1 e acompanhar\u00e1 o uso destas normas por terceiros e por servidores.<\/p>\n

            \"img\"<\/p>\n

            \"img\"<\/p>\n

            \"img\"<\/p>\n

            \"img\"<\/p>\n

            Observa\u00e7\u00f5es:<\/p>\n

              \n
            1. Nos casos onde \u00e9 inserido no padr\u00e3o [NOME DA TABELA] esta deve ser referenciada sem seu prefixo e sem o caracter _ (separador entre palavras);<\/li>\n
            2. Nos casos onde \u00e9 inserido no padr\u00e3o [NOME DA COLUNA] esta deve ser referenciada sem o caracter _ (separador entre palavras).<\/li>\n<\/ol>\n

              6- TIPOS DE TABELA<\/strong><\/h2>\n\n\n\n\n\n\n\n\n\n\n
              TIPO DE TABELA<\/b><\/td>\nDESCRI\u00c7\u00c3O<\/b><\/td>\nTIPO DE TABELA DE NEG\u00d3CIO (SIM\/N\u00c3O)<\/b><\/td>\nPADR\u00c3O ESTABELECIDO<\/b><\/td>\n<\/tr>\n
              Tabela de Sistema<\/span><\/td>\nTabela utilizada para armazenar dados de aplica\u00e7\u00e3o<\/span><\/td>\nsim<\/span><\/td>\nTB_+[NOME DA TABELA]<\/span><\/td>\n<\/tr>\n
              Tabela de Relacionamento (Associativa)<\/span><\/td>\nTabela que resolve relacionamentos \u201cN para N\u201d entre duas tabelas.<\/span><\/td>\nsim<\/span><\/td>\nRL_+[NOME DA TABELA1]+_+[NOME DA TABELA2]<\/span><\/td>\n<\/tr>\n
              Tabela Log de Opera\u00e7\u00f5es<\/span><\/td>\nTabela utilizada para armazenar dos dados das opera\u00e7\u00f5es de usu\u00e1rios realizadas no esquema. Exemplos de opera\u00e7\u00f5es: insert, update, delete. Este tipo de tabela somente pode ser utilizado para log\u2019s alimentados cuja responsabilidade \u00e9 da equipe de desenvolvimento de sistemas<\/span><\/td>\nN\u00e3o<\/span><\/td>\nTL_+[NOME DA TABELA]<\/span><\/td>\n<\/tr>\n
              Tabela Tempor\u00e1ria<\/span><\/td>\nTabela utilizada em rotinas dos sistemas para armazenamento tempor\u00e1rio de dados.<\/span><\/td>\nsim<\/span><\/td>\nTM_+[NOME DA TABELA]<\/span><\/td>\n<\/tr>\n
              Tabela de Hist\u00f3rico<\/span><\/td>\nTabela utilizada para armazenar os dados hist\u00f3ricos de uma determinada funcionalidade, podendo ter vida \u00fatil para os dados.<\/span><\/td>\nsim<\/span><\/td>\nTH_+[NOME DA TABELA]<\/span><\/td>\n<\/tr>\n
              Tabela de Relacionamento Tern\u00e1rio (Associativa)<\/span><\/td>\nTabela que resolve relacionamentos \u201cN para N\u201d, envolvendo tr\u00eas tabelas ou mais<\/span><\/td>\nsim<\/span><\/td>\nRT_+[NOME DA TABELA]<\/span><\/td>\n<\/tr>\n
              Tabela do Rob\u00f4<\/span><\/td>\nTabela utilizada em rotinas automatizadas do sistema.\u00a0<\/span><\/td>\nsim\u00a0<\/span><\/td>\nRB_+[NOME DA TABELA<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

              Observa\u00e7\u00f5es:<\/span><\/p>\n

                \n
              1. Nos casos onde \u00e9 inserido no padr\u00e3o [NOME DA TABELA] esta deve ser referenciada sem seu prefixo e sem o caractere _ (separador entre palavras);<\/li>\n
              2. Nos casos onde \u00e9 inserido no padr\u00e3o [NOME DA COLUNA] esta deve ser referenciada sem o caractere _ (separador entre palavras).<\/li>\n<\/ol>\n

                7- PADR\u00d5ES PARA COLUNAS<\/strong><\/h2>\n
                ANEXO I<\/strong><\/h5>\n

                \"img\"<\/p>\n

                \"img\"<\/p>\n

                \"img\"<\/p>\n

                \"img\"<\/p>\n

                Observa\u00e7\u00f5es:<\/p>\n

                  \n
                1. Nos casos onde \u00e9 inserido no padr\u00e3o [NOME DA COLUNA] esta deve seguir as normas especificadas no item 4.1.<\/li>\n<\/ol>\n

                  ANEXO II<\/strong><\/h4>\n
                  CLASSE DE DADOS<\/strong><\/h5>\n

                  \"img\"<\/p>\n

                  \"img\"<\/p>\n

                  \"img\"<\/p>\n

                  \"img\"<\/p>\n

                  8- COLUNAS DE AUDITORIA<\/strong><\/h2>\n

                  A Superintend\u00eancia de Tecnologia da Informa\u00e7\u00e3o, realiza a partir das colunas de auditoria um rastreio de onde, quando e quem realizou qualquer altera\u00e7\u00e3o nos dados daquela tabela.<\/span><\/p>\n

                  Periodicamente os dados destas colunas s\u00e3o coletados e organizados para apresenta\u00e7\u00f5es, na presta\u00e7\u00e3o de contas e identifica\u00e7\u00e3o do usu\u00e1rio respons\u00e1vel.<\/span><\/p>\n

                  As tabelas s\u00e3o padronizadas com as seguintes colunas, utilizando os atalhos do (ITEM 7- PADR\u00d5ES PARA COLUNAS):<\/span><\/p>\n

                    \n
                  • sg_projeto_modificador<\/strong>: Cont\u00e9m a sigla do projeto que iniciou o processo modificador do dado.<\/span><\/li>\n
                  • sg_acao_modificadora:<\/strong> Cont\u00e9m a sigla do registro da a\u00e7\u00e3o do processo modificador do dado.<\/span><\/li>\n
                  • no_end_point_modificador:<\/strong> Cont\u00e9m o nome do End Point que iniciou o processo modificador do dado.<\/span><\/li>\n
                  • st_ativo:<\/strong> Cont\u00e9m o estado de armazenamento do registro. Indicando se o dado est\u00e1 sendo utilizado ou n\u00e3o pelo sistema. TRUE = Ativo ou FALSE = Inativo.<\/span><\/li>\n
                  • dh_criacao:<\/strong> Cont\u00e9m a data e hora da cria\u00e7\u00e3o do registro.<\/span><\/li>\n
                  • dh_alteracao:<\/strong> Cont\u00e9m a data e hora da \u00faltima altera\u00e7\u00e3o do registro.<\/span><\/li>\n
                  • tp_operacao:<\/strong> Cont\u00e9m o tipo da opera\u00e7\u00e3o realizada no registro. Por exemplo: CREATE, READ, UPDATE, DELETE.<\/span><\/li>\n
                  • nu_versao:<\/strong> Cont\u00e9m o n\u00famero da vers\u00e3o do registro.<\/span><\/li>\n
                  • co_uuid:<\/strong> Cont\u00e9m o registro de uma chave \u00fanica. Identificador \u00danico Universal (do ingl\u00eas \u201cUniversally Unique IDentifier\u201d – UUID).<\/span><\/li>\n
                  • co_uuid_1:<\/strong> Cont\u00e9m o UUID do usu\u00e1rio que realizou a altera\u00e7\u00e3o no registo. Pode ser de um usu\u00e1rio INTERNO ou EXTERNO.<\/span><\/li>\n<\/ul>\n","protected":false},"featured_media":0,"parent":0,"menu_order":6,"template":"","class_list":["post-202","v1","type-v1","status-publish","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/gerais.defensoria.mg.def.br\/metodologia-de-desenvolvimento\/wp-json\/wp\/v2\/v1\/202","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/gerais.defensoria.mg.def.br\/metodologia-de-desenvolvimento\/wp-json\/wp\/v2\/v1"}],"about":[{"href":"https:\/\/gerais.defensoria.mg.def.br\/metodologia-de-desenvolvimento\/wp-json\/wp\/v2\/types\/v1"}],"wp:attachment":[{"href":"https:\/\/gerais.defensoria.mg.def.br\/metodologia-de-desenvolvimento\/wp-json\/wp\/v2\/media?parent=202"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}