De aanleiding voor het schrijven van dit essay was een artikel . Ook leek het interessant een artikel te publiceren dat vier jaar geleden is verschenen — .
Het leek interessant dat dezelfde gedachte-"de bedrijfslogica in de database te implementeren".
niet alleen bij mij opkwam.
Daarnaast wilde ik voor de toekomst interessante bevindingen die tijdens de implementatie zijn ontstaan, vooral voor mezelf, bewaren. Zeker gezien het feit dat onlangs een strategische beslissing is genomen om de architectuur te veranderen en de bedrijfslogica naar het backend-niveau te verplaatsen. Dus, alles wat was verzameld, zal binnenkort voor niemand nuttig zijn en niemand zal het interessant vinden.
De beschreven methoden zijn geen ontdekking en zijn niet uniek know how, alles volgens de klassiekers en is herhaaldelijk geïmplementeerd (ik had bijvoorbeeld deze aanpak 20 jaar geleden op Oracle toegepast). Ik besloot gewoon alles op één plek te verzamelen. Misschien dat iemand het kan gebruiken. Zoals de praktijk heeft aangetoond — vaak komt dezelfde idee onafhankelijk bij verschillende mensen op. En om het voor mezelf te bewaren, is ook nuttig.
Natuurlijk is niets in deze wereld perfect, fouten en typfouten zijn helaas mogelijk. Kritiek en opmerkingen worden ten zeerste verwelkomt en worden verwacht. En nog een klein detail — specifieke implementatiedetails zijn weggelaten. Dit wordt immers nog steeds gebruikt in een echt werkend project. Dus, het artikel is meer een essay en een beschrijving van het algemene concept, niet meer dan dat. Ik hoop dat de details genoeg zijn voor een algemeen begrip.
Het algemene idee — 'deel en heers, verberg en bezit'
Het idee is klassiek — een aparte schema voor tabellen, een aparte schema voor opgeslagen functies.
De klant heeft geen directe toegang tot de gegevens. Alles wat de klant kan doen, is alleen een opgeslagen functie aanroepen en het ontvangen antwoord verwerken.
Rollen
CREATE ROLE store;
CREATE ROLE sys_functions;
CREATE ROLE loc_audit_functions;
CREATE ROLE service_functions;
CREATE ROLE business_functions;
Schemas
Schema voor het opslaan van tabellen
Doel tabellen die objectentiteiten implementeren.
CREATE SCHEMA store AUTHORIZATION store;
Schema voor systeemfuncties
Systeemfuncties, in het bijzonder voor het loggen van wijzigingen in tabellen.
CREATE SCHEMA sys_functions AUTHORIZATION sys_functions;
Schema voor lokale audits
Functies en tabellen voor het uitvoeren van een lokale audit van opgeslagen functies en het wijzigen van doel tabellen.
CREATE SCHEMA loc_audit_functions AUTHORIZATION loc_audit_functions;
Schema van servicefuncties
Functies voor service- en DML-functies.
CREATE SCHEMA service_functions AUTHORIZATION service_functions;
Schema van bedrijfsfuncties
Functies voor eindgebruikers bedrijfsfuncties die door de klant worden aangeroepen.
CREATE SCHEMA business_functions AUTHORIZATION business_functions;
Access Rights
Rol — DBA heeft volledige toegang tot alle schema's (afzonderlijk van de rol DB Owner).
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;
Rol — USER heeft de bevoegdheid EXECUTE in het schema business_functions.
CREATE ROLE user_role;
Bevoegdheden tussen schema's
GRANT
Omdat alle functies worden aangemaakt met het attribuut SECURITY DEFINER is de instructie nodig 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;
Dus het DB-schema is klaar. We kunnen beginnen met het vullen met gegevens.
Doel tabellen
Het aanmaken van tabellen is triviaal. Geen bijzonderheden, behalve dat is besloten af te zien van het gebruik van SERIAL en expliciet sequenties te genereren. Uiteraard, het maximale gebruik van de instructie
COMMENT ON ...Opmerkingen voor van alle objecten, zonder uitzondering.
Lokale audit
Voor het bijhouden van het logboek van het uitvoeren van opgeslagen functies en het wijzigen van doel tabellen wordt een lokale audit tabel gebruikt, inclusief details van de klantverbinding, het label van de aangeroepen module, en de werkelijke waarden van invoer- en uitvoerparameters in JSON-vorm.
Systeemfuncties
Bedoeld voor het loggen van wijzigingen in doel tabellen. Het zijn triggerfuncties.
Sjabloon — systeemfunctie
---------------------------------------------------------
-- INSERT
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();
---------------------------------------------------------
-- UPDATE
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 ();
---------------------------------------------------------
-- DELETE
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 ();Servicediensten
Zijn bedoeld voor het uitvoeren van service- en DML-operaties op de doeltabellen.
Sjabloon — servicemethode
--INSERT
--RETURN id VAN NIEUWE RIJ
CREATE OR REPLACE FUNCTION service_functions.table_insert ( new_column store.table.column%TYPE )
RETURNS integer AS $$
DECLARE
new_id integer ;
BEGIN
-- Genereer nieuwe id
new_id = nextval('store.table.seq');
-- Invoegen in tabel
INSERT INTO store.table
(
id ,
column
)
VALUES
(
new_id ,
new_column
);
RETURN new_id ;
END
$$ LANGUAGE plpgsql SECURITY DEFINER;
--DELETE
--RETURN AANTAL VERWIJDERDE RIJEN
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;
-- UPDATE GEGEVENS
-- RETURN AANTAL BIJGEWERKTE RIJEN
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;Business functies
Zijn bedoeld voor de eindgebruikersfuncties die door de klant worden aangeroepen. Geven altijd terug — of een ander formaat.. Voor het onderscheppen en loggen van uitvoeringsfouten wordt een blok gebruikt UITZONDERING.
Sjabloon — business functie
CREATE OR REPLACE FUNCTION business_functions.business_function_template(
--Invoergegevens
)
RETURNS JSON AS $$
DECLARE
------------------------
--voor foutafhandeling
error_message text ;
error_json json ;
result json ;
------------------------
BEGIN
--LOGGEN
PERFORM loc_audit_functions.make_log
(
'business_function_template',
'STARTED',
json_build_object
(
--IN Parameters
)
);
PERFORM business_functions.notice('business_function_template');
--START ZAKELIJKE DEEL
--EIND ZAKELIJKE DEEL
-- SUCCESVOL RESULTAAT
PERFORM business_functions.notice('result');
PERFORM business_functions.notice(result);
PERFORM loc_audit_functions.make_log
(
'business_function_template',
'FINISHED',
json_build_object( 'result',result )
);
RETURN result ;
----------------------------------------------------------------------------------------------------------
-- UITZONDERING AFHANDELING
EXCEPTION
WHEN OTHERS THEN
PERFORM loc_audit_functions.make_log
(
'business_function_template',
'STARTED',
json_build_object
(
--IN Parameters
) , TRUE );
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERROR',
json_build_object('SQLSTATE',SQLSTATE ), TRUE
);
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERROR',
json_build_object('SQLERRM',SQLERRM ), TRUE
);
GET STACKED DIAGNOSTICS error_message = RETURNED_SQLSTATE ;
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERROR-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',
' ERROR-COLUMN_NAME',
json_build_object('COLUMN_NAME',error_message ), TRUE );
GET STACKED DIAGNOSTICS error_message = CONSTRAINT_NAME ;
PERFORM loc_audit_functions.make_log
(
'business_function_template',
' ERROR-CONSTRAINT_NAME',
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',
' ERROR-PG_DATATYPE_NAME',
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',
' ERROR-MESSAGE_TEXT',json_build_object('MESSAGE_TEXT',error_message ), TRUE );
GET STACKED DIAGNOSTICS error_message = SCHEMA_NAME ;
PERFORM loc_audit_functions.make_log
(s
'business_function_template',
' ERROR-SCHEMA_NAME',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',
' ERROR-PG_EXCEPTION_DETAIL',
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',
' ERROR-PG_EXCEPTION_HINT',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',
' ERROR-PG_EXCEPTION_CONTEXT',json_build_object('PG_EXCEPTION_CONTEXT',error_message ), TRUE );
RAISE WARNING 'ALARM: %' , SQLERRM ;
SELECT json_build_object
(
'isError' , TRUE ,
'errorMsg' , SQLERRM
) INTO error_json ;
RETURN error_json ;
END
$$ LANGUAGE plpgsql SECURITY DEFINER;Conclusie
Voor een algemeen overzicht denk ik dat dit voldoende is. Als iemand geïnteresseerd is in de details en resultaten, laat dan een reactie achter, ik vul het graag aan met extra details.
P.S.
Logging van een eenvoudige fout - type invoerparameter
-[ RECORD 1 ]-
date_trunc | 2020-08-19 13:15:46
id | 1072
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | IN BEWEGING
jsonb_pretty | {
| "dko": {
| "id": 4,
| "type": "Type1",
| "title": "AANGEMAAKT DOOR addKD",
| "Weight": 10,
| "Tr": "300",
| "reduction": 10,
| "isTrud": "WAAR",
| "description": "beschrijving",
| "lowerTr": "100",
| "measurement": "meting1",
| "methodology": "m1",
| "passportUrl": "bestanden",
| "upperTr": "200",
| "weightingFactor": 100.123,
| "actualTrValue": null,
| "upperTrCalcNumber": "120"
| },
| "CardId": 3
| }
-[ RECORD 2 ]-
date_trunc | 2020-08-19 13:15:46
id | 1073
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT
jsonb_pretty | {
| "SQLSTATE": "22P02"
| }
-[ RECORD 3 ]-
date_trunc | 2020-08-19 13:15:46
id | 1074
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT
jsonb_pretty | {
| "SQLERRM": "ongeldige invoersyntaxis voor type numeriek: "null""
| }
-[ RECORD 4 ]-
date_trunc | 2020-08-19 13:15:46
id | 1075
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT-TERUGGEGEVEN_SQLSTATE
jsonb_pretty | {
| "RETURNED_SQLSTATE": "22P02"
| }
-[ RECORD 5 ]-
date_trunc | 2020-08-19 13:15:46
id | 1076
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT-COLUMN_NAME
jsonb_pretty | {
| "COLUMN_NAME": ""
| }
-[ RECORD 6 ]-
date_trunc | 2020-08-19 13:15:46
id | 1077
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT-CONSTRAINT_NAME
jsonb_pretty | {
| "CONSTRAINT_NAME": ""
| }
-[ RECORD 7 ]-
date_trunc | 2020-08-19 13:15:46
id | 1078
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT-PG_DATATYPE_NAME
jsonb_pretty | {
| "PG_DATATYPE_NAME": ""
| }
-[ RECORD 8 ]-
date_trunc | 2020-08-19 13:15:46
id | 1079
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT-MESSAGE_TEXT
jsonb_pretty | {
| "MESSAGE_TEXT": "ongeldige invoersyntaxis voor type numeriek: "null""
| }
-[ RECORD 9 ]-
date_trunc | 2020-08-19 13:15:46
id | 1080
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT-SCHEMA_NAME
jsonb_pretty | {
| "SCHEMA_NAME": ""
| }
-[ RECORD 10 ]-
date_trunc | 2020-08-19 13:15:46
id | 1081
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT-PG_EXCEPTION_DETAIL
jsonb_pretty | {
| "PG_EXCEPTION_DETAIL": ""
| }
-[ RECORD 11 ]-
date_trunc | 2020-08-19 13:15:46
id | 1082
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT-PG_EXCEPTION_HINT
jsonb_pretty | {
| "PG_EXCEPTION_HINT": ""
| }
-[ RECORD 12 ]-
date_trunc | 2020-08-19 13:15:46
id | 1083
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT-PG_EXCEPTION_CONTEXT
jsonb_pretty | {
usename | emp1
log_module | addKD
log_module_hash | 0b4c1529a89af3ddf6af3821dc790e8a
status | FOUT-MESSAGE_TEXT
jsonb_pretty | {
| "MESSAGE_TEXT": "ongeldige invoersyntaxis voor type numeriek: "null""
| }Bron: habr.com
