O motivo para escrever este estudo foi um artigo . Também achei interessante o artigo publicado há 4 anos — .
Achei interessante que a mesma ideia-"implementar a lógica de negócios no banco de dados".
não me ocorreu apenas a mim.
Além disso, gostaria de preservar, para mim em primeiro lugar, as interessantes contribuições que surgiram durante a implementação. Especialmente considerando que, relativamente recentemente, foi tomada a decisão estratégica de mudar a arquitetura e transferir a lógica de negócios para o nível do backend. Então, tudo o que foi desenvolvido em breve não será mais necessário e não interessará a ninguém.
Os métodos descritos não são uma descoberta ou algo excepcional know how, tudo na clássica e foi implementado várias vezes (por exemplo, eu usei uma abordagem semelhante há 20 anos na Oracle). Apenas decidi reunir tudo em um só lugar. Quem sabe, pode ser útil para alguém. Como a prática mostrou — frequentemente a mesma ideia vem independentemente a pessoas diferentes. E deixar isso para a memória é útil.
Claro, nada neste mundo é perfeito, erros e typos são, infelizmente, possíveis. Críticas e comentários são sempre bem-vindos e esperados. E mais um pequeno detalhe — detalhes específicos da implementação foram omitidos. Afinal, tudo ainda está sendo utilizado em um projeto em funcionamento. Portanto, o artigo é um estudo e descrição da concepção geral, não mais que isso. Espero que para entender o quadro geral, os detalhes sejam suficientes.
A ideia geral — “divida e domine, esconda e possua”
A ideia é clássica — um esquema separado para tabelas, um esquema separado para funções armazenadas.
O cliente não tem acesso direto aos dados. Tudo o que o cliente pode fazer é apenas chamar uma função armazenada e processar a resposta recebida.
Funções
CREATE ROLE store;
CREATE ROLE sys_functions;
CREATE ROLE loc_audit_functions;
CREATE ROLE service_functions;
CREATE ROLE business_functions;
Esquemas
Esquema de armazenamento de tabelas
Tabelas-alvo que implementam entidades de domínio.
CREATE SCHEMA store AUTHORIZATION store ;
Esquema de funções do sistema
Funções do sistema, em particular para registrar alterações nas tabelas.
CREATE SCHEMA sys_functions AUTHORIZATION sys_functions ;
Esquema de auditoria local
Funções e tabelas para a implementação de auditoria local da execução de funções armazenadas e alteração de tabelas-alvo.
CREATE SCHEMA loc_audit_functions AUTHORIZATION loc_audit_functions;
Esquema de funções de serviço
Funções para funções de serviço e DML.
CREATE SCHEMA service_functions AUTHORIZATION service_functions;
Esquema de funções de negócios
Funções para funções de negócios finais chamadas pelo cliente.
CREATE SCHEMA business_functions AUTHORIZATION business_functions;
Direitos de acesso
Função — DBA tem acesso total a todos os esquemas (separada da função de proprietário do banco de dados).
CREATE ROLE dba_role;
GRANT store TO dba_role;
GRANT sys_functions TO dba_role;
GRANT loc_audit_functions TO dba_role;
GRANT service_functions TO dba_role;
GRANT business_functions TO dba_role;
Função — USUÁRIO possui a privilégio EXECUTAR no esquema business_functions.
CREATE ROLE user_role;
Privilégios entre esquemas
GRANT
Uma vez que todas as funções são criadas com o atributo SECURITY DEFINER uma instrução é necessária REVOKE EXECUTE ON ALL FUNCTION… FROM public;
REVOKE EXECUTE ON ALL FUNCTION IN SCHEMA sys_functions FROM public;
REVOKE EXECUTE ON ALL FUNCTION IN SCHEMA loc_audit_functions FROM public;
REVOKE EXECUTE ON ALL FUNCTION IN SCHEMA service_functions FROM public;
REVOKE EXECUTE ON ALL FUNCTION IN SCHEMA business_functions FROM public;
GRANT USAGE ON SCHEMA sys_functions TO dba_role;
GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA sys_functions TO dba_role;
GRANT USAGE ON SCHEMA loc_audit_functions TO dba_role;
GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA loc_audit_functions TO dba_role;
GRANT USAGE ON SCHEMA service_functions TO dba_role;
GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA service_functions TO dba_role;
GRANT USAGE ON SCHEMA business_functions TO dba_role;
GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA business_functions TO dba_role;
GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA business_functions TO user_role;
GRANT ALL PRIVILEGES ON SCHEMA store TO GROUP business_functions;
GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA store TO business_functions;
GRANT USAGE ON ALL SEQUENCES IN SCHEMA store TO business_functions;
Assim, o esquema do banco de dados está pronto. Agora podemos começar a preencher os dados.
Tabelas-alvo
A criação de tabelas é trivial. Nenhuma particularidade, exceto que foi decidido abrir mão do uso de SERIAL e gerar sequências explicitamente. Além disso, claro, o uso máximo do comando
COMMENT ON ...Comentários para todas objetos, sem exceções.
Auditoria local
Para registrar a execução de funções armazenadas e a alteração de tabelas-alvo, utiliza-se uma tabela de auditoria local, que inclui também detalhes da conexão do cliente, a etiqueta do módulo chamado, valores reais dos parâmetros de entrada e saída em formato JSON.
Funções do sistema
Destinadas a registrar as alterações nas tabelas-alvo. Constituem funções de gatilho.
Modelo — função do sistema
---------------------------------------------------------
-- INSERIR
CREATE OR REPLACE FUNCTION sys_functions.table_insert_log ()
RETURNS TRIGGER AS $$
BEGIN
PERFORM loc_audit_functions.make_log( ' '||'table' , 'insert' , json_build_object('id', NEW.id) );
RETURN NULL ;
END
$$ LANGUAGE plpgsql SECURITY DEFINER;
CREATE TRIGGER table_after_insert AFTER INSERT ON storage.table FOR EACH ROW EXECUTE PROCEDURE sys_functions.table_insert_log();
---------------------------------------------------------
-- ATUALIZAR
CREATE OR REPLACE FUNCTION sys_functions.table_update_log ()
RETURNS TRIGGER AS $$
BEGIN
IF OLD.column != NEW.column
THEN
PERFORM loc_audit_functions.make_log( ' '||'table' , 'update' , json_build_object('OLD.column', OLD.column , 'NEW.column', NEW.column ) );
END IF ;
RETURN NULL ;
END
$$ LANGUAGE plpgsql SECURITY DEFINER;
CREATE TRIGGER table_after_update AFTER UPDATE ON storage.table FOR EACH ROW EXECUTE PROCEDURE sys_functions.table_update_log ();
---------------------------------------------------------
-- DELETAR
CREATE OR REPLACE FUNCTION sys_functions.table_delete_log ()
RETURNS TRIGGER AS $$
BEGIN
PERFORM loc_audit_functions.make_log( ' '||'table' , 'delete' , json_build_object('id', OLD.id ) );
RETURN NULL ;
END
$$ LANGUAGE plpgsql SECURITY DEFINER;
CREATE TRIGGER table_after_delete AFTER DELETE ON storage.table FOR EACH ROW EXECUTE PROCEDURE sys_functions.table_delete_log ();Funções de Serviço
Destinadas à implementação de operações de serviço e DML nas tabelas-alvo.
Modelo — função de serviço
--INSERIR
--RETORNAR id DA NOVA LINHA
CREATE OR REPLACE FUNCTION service_functions.table_insert ( new_column store.table.column%TYPE )
RETURNS integer AS $$
DECLARE
new_id integer ;
BEGIN
-- Gerar novo id
new_id = nextval('store.table.seq');
-- Inserir na tabela
INSERT INTO store.table
(
id ,
column
)
VALUES
(
new_id ,
new_column
);
RETURN new_id ;
END
$$ LANGUAGE plpgsql SECURITY DEFINER;
--DELETAR
--RETORNAR NÚMEROS DE LINHAS DELETADAS
CREATE OR REPLACE FUNCTION service_functions.table_delete ( current_id integer )
RETURNS integer AS $$
DECLARE
rows_count integer ;
BEGIN
DELETE FROM store.table WHERE id = current_id;
GET DIAGNOSTICS rows_count = ROW_COUNT;
RETURN rows_count ;
END
$$ LANGUAGE plpgsql SECURITY DEFINER;
-- ATUALIZAR DETALHES
-- RETORNAR NÚMEROS DE LINHAS ATUALIZADAS
CREATE OR REPLACE FUNCTION service_functions.table_update_column
(
current_id integer
,new_column store.table.column%TYPE
)
RETURNS integer AS $$
DECLARE
rows_count integer ;
BEGIN
UPDATE store.table
SET
column = new_column
WHERE id = current_id;
GET DIAGNOSTICS rows_count = ROW_COUNT;
RETURN rows_count ;
END
$$ LANGUAGE plpgsql SECURITY DEFINER;Funções de Negócio
Destinadas a funções de negócio finais chamadas pelo cliente. Sempre retornam — JSON. Para a captura e registro de erros de execução, utiliza-se o bloco EXCEÇÃO.
Modelo — função de negócio
CREATE OR REPLACE FUNCTION business_functions.business_function_template(
--Parâmetros de entrada
)
RETURNS JSON AS $$
DECLARE
------------------------
--para captura de exceções
error_message text ;
error_json json ;
result json ;
------------------------
BEGIN
--REGISTRO
PERFORM loc_audit_functions.make_log
(
'business_function_template',
'INICIADO',
json_build_object
(
--Parâmetros de entrada
)
);
PERFORM business_functions.notice('business_function_template');
--INICIAR PARTE DE NEGÓCIOS
--FINALIZAR PARTE DE NEGÓCIOS
-- RESULTADO COM SUCESSO
PERFORM business_functions.notice('resultado');
PERFORM business_functions.notice(result);
PERFORM loc_audit_functions.make_log
(
'business_function_template',
'FINALIZADO',
json_build_object( 'resultado',result )
);
RETURN result ;
----------------------------------------------------------------------------------------------------------
-- CAPTURA DE EXCEÇÕES
EXCEPTION
WHEN OTHERS THEN
PERFORM loc_audit_functions.make_log
(
'business_function_template',
'INICIADO',
json_build_object
(
--Parâmetros de entrada
) , TRUE );
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERRO',
json_build_object('SQLSTATE',SQLSTATE ), TRUE
);
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERRO',
json_build_object('SQLERRM',SQLERRM ), TRUE
);
GET STACKED DIAGNOSTICS error_message = RETURNED_SQLSTATE ;
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERRO-RETURNED_SQLSTATE',json_build_object('RETURNED_SQLSTATE',error_message ), TRUE );
GET STACKED DIAGNOSTICS error_message = COLUMN_NAME ;
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERRO-NOME_DA_COLUNA',
json_build_object('COLUMN_NAME',error_message ), TRUE );
GET STACKED DIAGNOSTICS error_message = CONSTRAINT_NAME ;
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERRO-NOME_DA_CONSTRAINT',
json_build_object('CONSTRAINT_NAME',error_message ), TRUE );
GET STACKED DIAGNOSTICS error_message = PG_DATATYPE_NAME ;
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERRO-PG_NOME_DO_TIPO',
json_build_object('PG_DATATYPE_NAME',error_message ), TRUE );
GET STACKED DIAGNOSTICS error_message = MESSAGE_TEXT ;
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERRO-TEXTO_DA_MENSAGEM',json_build_object('MESSAGE_TEXT',error_message ), TRUE );
GET STACKED DIAGNOSTICS error_message = SCHEMA_NAME ;
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERRO-NOME_DO_ESQUEMA',json_build_object('SCHEMA_NAME',error_message ), TRUE );
GET STACKED DIAGNOSTICS error_message = PG_EXCEPTION_DETAIL ;
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERRO-PG_DETALHE_DA_EXCEÇÃO',
json_build_object('PG_EXCEPTION_DETAIL',error_message ), TRUE );
GET STACKED DIAGNOSTICS error_message = PG_EXCEPTION_HINT ;
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERRO-PG_DICA_DA_EXCEÇÃO',json_build_object('PG_EXCEPTION_HINT',error_message ), TRUE );
GET STACKED DIAGNOSTICS error_message = PG_EXCEPTION_CONTEXT ;
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERRO-PG_CONTEXT_DA_EXCEÇÃO',json_build_object('PG_EXCEPTION_CONTEXT',error_message ), TRUE );
RAISE WARNING 'ALARME: %' , SQLERRM ;
SELECT json_build_object
(
'isError' , TRUE ,
'errorMsg' , SQLERRM
) INTO error_json ;
RETURN error_json ;
END
$$ LANGUAGE plpgsql SECURITY DEFINER;Resultado
Para descrever a imagem geral, acho que é bastante suficiente. Se alguém estiver interessado nos detalhes e resultados, escreva comentários, ficarei feliz em complementar a imagem com toques adicionais.
P.S.
Registro de um erro simples — tipo de parâmetro de entrada
-[ REGISTRO 1 ]-
date_trunc | 2020-08-19 13:15:46
id | 1072
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | INICIADO
jsonb_pretty | {
| "dko": {
| "id": 4,
| "type": "Tipo1",
| "title": "CRIADO POR addKD",
| "Weight": 10,
| "Tr": "300",
| "reduction": 10,
| "isTrud": "VERDADEIRO",
| "description": "descrição",
| "lowerTr": "100",
| "measurement": "medida1",
| "methodology": "m1",
| "passportUrl": "arquivos",
| "upperTr": "200",
| "weightingFactor": 100.123,
| "actualTrValue": null,
| "upperTrCalcNumber": "120"
| },
| "CardId": 3
| }
-[ REGISTRO 2 ]-
date_trunc | 2020-08-19 13:15:46
id | 1073
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO
jsonb_pretty | {
| "SQLSTATE": "22P02"
| }
-[ REGISTRO 3 ]-
date_trunc | 2020-08-19 13:15:46
id | 1074
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO
jsonb_pretty | {
| "SQLERRM": "sintaxe de entrada inválida para tipo numérico: "null""
| }
-[ REGISTRO 4 ]-
date_trunc | 2020-08-19 13:15:46
id | 1075
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO-RETORNADO_SQLSTATE
jsonb_pretty | {
| "RETURNED_SQLSTATE": "22P02"
| }
-[ REGISTRO 5 ]-
date_trunc | 2020-08-19 13:15:46
id | 1076
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO-NOME_DA_COLUNA
jsonb_pretty | {
| "COLUMN_NAME": ""
| }
-[ REGISTRO 6 ]-
date_trunc | 2020-08-19 13:15:46
id | 1077
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO-NOME_DA_RESTRIÇÃO
jsonb_pretty | {
| "CONSTRAINT_NAME": ""
| }
-[ REGISTRO 7 ]-
date_trunc | 2020-08-19 13:15:46
id | 1078
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO-NOME_DO_TIPO_PG
jsonb_pretty | {
| "PG_DATATYPE_NAME": ""
| }
-[ REGISTRO 8 ]-
date_trunc | 2020-08-19 13:15:46
id | 1079
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO-TEXTO_DA_MENSAGEM
jsonb_pretty | {
| "MESSAGE_TEXT": "sintaxe de entrada inválida para tipo numérico: "null""
| }
-[ REGISTRO 9 ]-
date_trunc | 2020-08-19 13:15:46
id | 1080
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO-NOME_DO_ESQUEMA
jsonb_pretty | {
| "SCHEMA_NAME": ""
| }
-[ REGISTRO 10 ]-
date_trunc | 2020-08-19 13:15:46
id | 1081
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO-DADOS_DE_EXCEÇÃO_PG
jsonb_pretty | {
| "PG_EXCEPTION_DETAIL": ""
| }
-[ REGISTRO 11 ]-
date_trunc | 2020-08-19 13:15:46
id | 1082
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO-DICA_DE_EXCEÇÃO_PG
jsonb_pretty | {
| "PG_EXCEPTION_HINT": ""
| }
-[ REGISTRO 12 ]-
date_trunc | 2020-08-19 13:15:46
id | 1083
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO-CONTEXTO_DE_EXCEÇÃO_PG
jsonb_pretty | {
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | ERRO-TEXTO_DA_MENSAGEM
jsonb_pretty | {
| "MESSAGE_TEXT": "sintaxe de entrada inválida para tipo numérico: "null""
| }Fonte: habr.com
