2 583
edições
Convenções gerais SQL: mudanças entre as edições
Convenções gerais SQL (ver código-fonte)
Edição das 17h46min de 7 de maio de 2023
, 7 de maio de 2023sem sumário de edição
(Criou página com 'Convenções de sintaxe e estilo para ''scripts'' SQL para os projetos em geral, dentro do escopo do Instituto AddressForAll.') |
Sem resumo de edição |
||
| Linha 1: | Linha 1: | ||
Convenções de sintaxe e estilo para ''scripts'' [[wikipedia:SQL|SQL]] para os projetos em geral, dentro do escopo do Instituto AddressForAll. | Convenções de sintaxe e estilo para ''scripts'' [[wikipedia:SQL|SQL]] para os projetos em geral, dentro do escopo do Instituto AddressForAll. Principais tipos de convenção adotadas: | ||
* '''Estilo''' sintático: dentre as várias alternativas que a linguagem SQL oferece para se escrever a mesma coisa, quais recomendamos. | |||
* '''Documentação''': onde e como documentar. A principal recomendação aqui é "use o comando COMMENT" do SQL. Além disso existe um parser que gera código mediawiki para postar nesta Wiki. | |||
** Documentação e estilo: devido ao parser algumas partes da documentação podem ser expressas em <code>-- informal comm</code> | |||
* '''Testes''': requisitos mínimos de teste, tipicamente usando comando ASSERT em scripts dedicados, ou gerando a partir . | |||
* Objetos: em quais SQL-schemas definir, com qual sintaxe de nomenclatura, com qual estilo e níveis de documentação. | |||
** '''UDF''' - ''User Defined Functions''; | |||
** '''Views''' e Materialized Views; | |||
** '''Tables'''. | |||
== UDFs do schema Public == | |||
Foi convencionado que todos os projetos do Instituto devem ou criar schema próprio ou incluir novas funções ''Public'' (schema ''default'' do PostgreSQL) no '''projeto PubLib''', atualmente na sua primeira versão: https://git.AddressForAll.org/pg_pubLib-v1 | |||