Last active
February 19, 2021 07:10
-
-
Save blitzblade/3a3f1b107690c6813f588afa1a2c0b3f to your computer and use it in GitHub Desktop.
Postgres
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#STEP 1 | |
CREATE EXTENSION IF NOT EXISTS hstore; | |
CREATE SCHEMA audit; | |
REVOKE ALL ON SCHEMA audit FROM public; | |
COMMENT ON SCHEMA audit IS 'Out-of-table audit/history logging tables and trigger functions'; | |
-- | |
-- Audited data. Lots of information is available, it's just a matter of how much | |
-- you really want to record. See: | |
-- | |
-- http://www.postgresql.org/docs/9.1/static/functions-info.html | |
-- | |
-- Remember, every column you add takes up more audit table space and slows audit | |
-- inserts. | |
-- | |
-- Every index you add has a big impact too, so avoid adding indexes to the | |
-- audit table unless you REALLY need them. The hstore GIST indexes are | |
-- particularly expensive. | |
-- | |
-- It is sometimes worth copying the audit table, or a coarse subset of it that | |
-- you're interested in, into a temporary table where you CREATE any useful | |
-- indexes and do your analysis. | |
-- | |
CREATE TABLE audit.logged_actions ( | |
event_id bigserial primary key, | |
schema_name text not null, | |
table_name text not null, | |
relid oid not null, | |
session_user_name text, | |
action_tstamp_tx TIMESTAMP WITH TIME ZONE NOT NULL, | |
action_tstamp_stm TIMESTAMP WITH TIME ZONE NOT NULL, | |
action_tstamp_clk TIMESTAMP WITH TIME ZONE NOT NULL, | |
transaction_id bigint, | |
application_name text, | |
client_addr inet, | |
client_port integer, | |
client_query text, | |
action TEXT NOT NULL CHECK (action IN ('I','D','U', 'T')), | |
row_data hstore, | |
changed_fields hstore, | |
statement_only boolean not null | |
); | |
REVOKE ALL ON audit.logged_actions FROM public; | |
COMMENT ON TABLE audit.logged_actions IS 'History of auditable actions on audited tables, from audit.if_modified_func()'; | |
COMMENT ON COLUMN audit.logged_actions.event_id IS 'Unique identifier for each auditable event'; | |
COMMENT ON COLUMN audit.logged_actions.schema_name IS 'Database schema audited table for this event is in'; | |
COMMENT ON COLUMN audit.logged_actions.table_name IS 'Non-schema-qualified table name of table event occured in'; | |
COMMENT ON COLUMN audit.logged_actions.relid IS 'Table OID. Changes with drop/create. Get with ''tablename''::regclass'; | |
COMMENT ON COLUMN audit.logged_actions.session_user_name IS 'Login / session user whose statement caused the audited event'; | |
COMMENT ON COLUMN audit.logged_actions.action_tstamp_tx IS 'Transaction start timestamp for tx in which audited event occurred'; | |
COMMENT ON COLUMN audit.logged_actions.action_tstamp_stm IS 'Statement start timestamp for tx in which audited event occurred'; | |
COMMENT ON COLUMN audit.logged_actions.action_tstamp_clk IS 'Wall clock time at which audited event''s trigger call occurred'; | |
COMMENT ON COLUMN audit.logged_actions.transaction_id IS 'Identifier of transaction that made the change. May wrap, but unique paired with action_tstamp_tx.'; | |
COMMENT ON COLUMN audit.logged_actions.client_addr IS 'IP address of client that issued query. Null for unix domain socket.'; | |
COMMENT ON COLUMN audit.logged_actions.client_port IS 'Remote peer IP port address of client that issued query. Undefined for unix socket.'; | |
COMMENT ON COLUMN audit.logged_actions.client_query IS 'Top-level query that caused this auditable event. May be more than one statement.'; | |
COMMENT ON COLUMN audit.logged_actions.application_name IS 'Application name set when this audit event occurred. Can be changed in-session by client.'; | |
COMMENT ON COLUMN audit.logged_actions.action IS 'Action type; I = insert, D = delete, U = update, T = truncate'; | |
COMMENT ON COLUMN audit.logged_actions.row_data IS 'Record value. Null for statement-level trigger. For INSERT this is the new tuple. For DELETE and UPDATE it is the old tuple.'; | |
COMMENT ON COLUMN audit.logged_actions.changed_fields IS 'New values of fields changed by UPDATE. Null except for row-level UPDATE events.'; | |
COMMENT ON COLUMN audit.logged_actions.statement_only IS '''t'' if audit event is from an FOR EACH STATEMENT trigger, ''f'' for FOR EACH ROW'; | |
CREATE INDEX logged_actions_relid_idx ON audit.logged_actions(relid); | |
CREATE INDEX logged_actions_action_tstamp_tx_stm_idx ON audit.logged_actions(action_tstamp_stm); | |
CREATE INDEX logged_actions_action_idx ON audit.logged_actions(action); | |
CREATE OR REPLACE FUNCTION audit.if_modified_func() RETURNS TRIGGER AS $body$ | |
DECLARE | |
audit_row audit.logged_actions; | |
include_values boolean; | |
log_diffs boolean; | |
h_old hstore; | |
h_new hstore; | |
excluded_cols text[] = ARRAY[]::text[]; | |
BEGIN | |
IF TG_WHEN <> 'AFTER' THEN | |
RAISE EXCEPTION 'audit.if_modified_func() may only run as an AFTER trigger'; | |
END IF; | |
audit_row = ROW( | |
nextval('audit.logged_actions_event_id_seq'), -- event_id | |
TG_TABLE_SCHEMA::text, -- schema_name | |
TG_TABLE_NAME::text, -- table_name | |
TG_RELID, -- relation OID for much quicker searches | |
session_user::text, -- session_user_name | |
current_timestamp, -- action_tstamp_tx | |
statement_timestamp(), -- action_tstamp_stm | |
clock_timestamp(), -- action_tstamp_clk | |
txid_current(), -- transaction ID | |
current_setting('application_name'), -- client application | |
inet_client_addr(), -- client_addr | |
inet_client_port(), -- client_port | |
current_query(), -- top-level query or queries (if multistatement) from client | |
substring(TG_OP,1,1), -- action | |
NULL, NULL, -- row_data, changed_fields | |
'f' -- statement_only | |
); | |
IF NOT TG_ARGV[0]::boolean IS DISTINCT FROM 'f'::boolean THEN | |
audit_row.client_query = NULL; | |
END IF; | |
IF TG_ARGV[1] IS NOT NULL THEN | |
excluded_cols = TG_ARGV[1]::text[]; | |
END IF; | |
IF (TG_OP = 'UPDATE' AND TG_LEVEL = 'ROW') THEN | |
audit_row.row_data = hstore(OLD.*); | |
audit_row.changed_fields = (hstore(NEW.*) - audit_row.row_data) - excluded_cols; | |
IF audit_row.changed_fields = hstore('') THEN | |
-- All changed fields are ignored. Skip this update. | |
RETURN NULL; | |
END IF; | |
ELSIF (TG_OP = 'DELETE' AND TG_LEVEL = 'ROW') THEN | |
audit_row.row_data = hstore(OLD.*) - excluded_cols; | |
ELSIF (TG_OP = 'INSERT' AND TG_LEVEL = 'ROW') THEN | |
audit_row.row_data = hstore(NEW.*) - excluded_cols; | |
ELSIF (TG_LEVEL = 'STATEMENT' AND TG_OP IN ('INSERT','UPDATE','DELETE','TRUNCATE')) THEN | |
audit_row.statement_only = 't'; | |
ELSE | |
RAISE EXCEPTION '[audit.if_modified_func] - Trigger func added as trigger for unhandled case: %, %',TG_OP, TG_LEVEL; | |
RETURN NULL; | |
END IF; | |
INSERT INTO audit.logged_actions VALUES (audit_row.*); | |
RETURN NULL; | |
END; | |
$body$ | |
LANGUAGE plpgsql | |
SECURITY DEFINER | |
SET search_path = pg_catalog, public; | |
COMMENT ON FUNCTION audit.if_modified_func() IS 'MODIFIED_FUNC'; | |
#STEP 2 | |
CREATE OR REPLACE FUNCTION audit.audit_table(target_table regclass, audit_rows boolean, audit_query_text boolean, ignored_cols text[]) RETURNS void AS $body$ | |
DECLARE | |
stm_targets text = 'INSERT OR UPDATE OR DELETE OR TRUNCATE'; | |
_q_txt text; | |
_ignored_cols_snip text = ''; | |
BEGIN | |
EXECUTE 'DROP TRIGGER IF EXISTS audit_trigger_row ON ' || target_table; | |
EXECUTE 'DROP TRIGGER IF EXISTS audit_trigger_stm ON ' || target_table; | |
IF audit_rows THEN | |
IF array_length(ignored_cols,1) > 0 THEN | |
_ignored_cols_snip = ', ' || quote_literal(ignored_cols); | |
END IF; | |
_q_txt = 'CREATE TRIGGER audit_trigger_row AFTER INSERT OR UPDATE OR DELETE ON ' || | |
target_table || | |
' FOR EACH ROW EXECUTE PROCEDURE audit.if_modified_func(' || | |
quote_literal(audit_query_text) || _ignored_cols_snip || ');'; | |
RAISE NOTICE '%',_q_txt; | |
EXECUTE _q_txt; | |
stm_targets = 'TRUNCATE'; | |
ELSE | |
END IF; | |
_q_txt = 'CREATE TRIGGER audit_trigger_stm AFTER ' || stm_targets || ' ON ' || | |
target_table || | |
' FOR EACH STATEMENT EXECUTE PROCEDURE audit.if_modified_func('|| | |
quote_literal(audit_query_text) || ');'; | |
RAISE NOTICE '%',_q_txt; | |
EXECUTE _q_txt; | |
END; | |
$body$ | |
language 'plpgsql'; | |
COMMENT ON FUNCTION audit.audit_table(regclass, boolean, boolean, text[]) IS $body$ | |
Add auditing support to a table. | |
Arguments: | |
target_table: Table name, schema qualified if not on search_path | |
audit_rows: Record each row change, or only audit at a statement level | |
audit_query_text: Record the text of the client query that triggered the audit event? | |
ignored_cols: Columns to exclude from update diffs, ignore updates that change only ignored cols. | |
$body$; | |
-- Pg doesn't allow variadic calls with 0 params, so provide a wrapper | |
CREATE OR REPLACE FUNCTION audit.audit_table(target_table regclass, audit_rows boolean, audit_query_text boolean) RETURNS void AS $body$ | |
SELECT audit.audit_table($1, $2, $3, ARRAY[]::text[]); | |
$body$ LANGUAGE SQL; | |
-- And provide a convenience call wrapper for the simplest case | |
-- of row-level logging with no excluded cols and query logging enabled. | |
-- | |
CREATE OR REPLACE FUNCTION audit.audit_table(target_table regclass) RETURNS void AS $$ | |
SELECT audit.audit_table($1, BOOLEAN 't', BOOLEAN 't'); | |
$$ LANGUAGE 'sql'; | |
COMMENT ON FUNCTION audit.audit_table(regclass) IS '$body$' | |
#STEP 3 | |
SELECT audit.audit_table(myTable) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SELECT tweet_id, "timestamp", user_id, screen_name, is_retweet, is_quote, text, quoted_text | |
FROM public.france_tweets limit 50; | |
DO | |
$do$ | |
DECLARE | |
_tbl text; | |
BEGIN | |
FOR _tbl IN | |
SELECT quote_ident(table_schema) || '.' | |
|| quote_ident(table_name) -- escape identifier and schema-qualify! | |
FROM information_schema.tables | |
WHERE table_name LIKE 'trending_' || '%' -- your table name prefix | |
AND table_schema NOT LIKE 'pg\_%' -- exclude system schemas | |
LOOP | |
RAISE NOTICE '%', | |
-- EXECUTE | |
'DROP TABLE ' || _tbl; -- see below | |
END LOOP; | |
END | |
$do$; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment