""" SQLite schema definitions for NHS High-Cost Drug Patient Pathway Analysis Tool. Contains SQL strings for creating reference tables, fact tables, and indexes. Schema design supports: - Reference data from CSV files (drug names, organizations, directories) - Drug-directory mappings with single-valid-directory flag - Patient intervention facts with proper indexing - Cached aggregations for performance - File tracking for incremental updates """ from typing import Optional import sqlite3 from core.logging_config import get_logger logger = get_logger(__name__) # ============================================================================= # Reference Table Schemas # ============================================================================= REF_DRUG_NAMES_SCHEMA = """ -- Mapping from raw drug names (as they appear in source data) to standardized names -- Source: data/drugnames.csv CREATE TABLE IF NOT EXISTS ref_drug_names ( id INTEGER PRIMARY KEY AUTOINCREMENT, raw_name TEXT NOT NULL UNIQUE, standard_name TEXT NOT NULL, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ); -- Index for fast lookups during data transformation CREATE INDEX IF NOT EXISTS idx_ref_drug_names_raw ON ref_drug_names(raw_name); CREATE INDEX IF NOT EXISTS idx_ref_drug_names_standard ON ref_drug_names(standard_name); """ REF_ORGANIZATIONS_SCHEMA = """ -- NHS organization codes and names -- Source: data/org_codes.csv CREATE TABLE IF NOT EXISTS ref_organizations ( id INTEGER PRIMARY KEY AUTOINCREMENT, org_code TEXT NOT NULL UNIQUE, org_name TEXT NOT NULL, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ); -- Index for fast lookups by organization code CREATE INDEX IF NOT EXISTS idx_ref_organizations_code ON ref_organizations(org_code); """ REF_DIRECTORIES_SCHEMA = """ -- Medical directories/specialties -- Source: data/directory_list.csv CREATE TABLE IF NOT EXISTS ref_directories ( id INTEGER PRIMARY KEY AUTOINCREMENT, directory_name TEXT NOT NULL UNIQUE, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ); -- Index for fast lookups by directory name CREATE INDEX IF NOT EXISTS idx_ref_directories_name ON ref_directories(directory_name); """ REF_DRUG_DIRECTORY_MAP_SCHEMA = """ -- Mapping from drug names to valid directories -- Source: data/drug_directory_list.csv -- A drug may map to multiple directories (one row per drug-directory pair) -- The is_single_valid flag indicates drugs with exactly ONE valid directory, -- which enables automatic directory assignment in department_identification() CREATE TABLE IF NOT EXISTS ref_drug_directory_map ( id INTEGER PRIMARY KEY AUTOINCREMENT, drug_name TEXT NOT NULL, directory_name TEXT NOT NULL, is_single_valid BOOLEAN NOT NULL DEFAULT 0, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, UNIQUE(drug_name, directory_name) ); -- Index for looking up directories by drug name (most common access pattern) CREATE INDEX IF NOT EXISTS idx_ref_drug_directory_map_drug ON ref_drug_directory_map(drug_name); -- Index for reverse lookup (find drugs by directory) CREATE INDEX IF NOT EXISTS idx_ref_drug_directory_map_directory ON ref_drug_directory_map(directory_name); -- Index for quick filtering of single-valid drugs CREATE INDEX IF NOT EXISTS idx_ref_drug_directory_map_single ON ref_drug_directory_map(is_single_valid); """ REF_DRUG_INDICATION_CLUSTERS_SCHEMA = """ -- Mapping from drugs to SNOMED clusters for indication validation -- Source: data/drug_indication_clusters.csv -- Used to validate that patients have appropriate GP diagnoses for their prescribed drugs -- A drug may map to multiple clusters (one row per drug-indication-cluster combination) CREATE TABLE IF NOT EXISTS ref_drug_indication_clusters ( id INTEGER PRIMARY KEY AUTOINCREMENT, drug_name TEXT NOT NULL, indication TEXT NOT NULL, cluster_id TEXT NOT NULL, cluster_description TEXT, nice_ta_reference TEXT, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, UNIQUE(drug_name, indication, cluster_id) ); -- Index for looking up clusters by drug name (most common access pattern) CREATE INDEX IF NOT EXISTS idx_ref_drug_indication_clusters_drug ON ref_drug_indication_clusters(drug_name); -- Index for looking up drugs by cluster (for finding all drugs treating a condition) CREATE INDEX IF NOT EXISTS idx_ref_drug_indication_clusters_cluster ON ref_drug_indication_clusters(cluster_id); -- Index for looking up by indication text CREATE INDEX IF NOT EXISTS idx_ref_drug_indication_clusters_indication ON ref_drug_indication_clusters(indication); """ # ============================================================================= # Pathway Data Architecture Schemas # ============================================================================= PATHWAY_DATE_FILTERS_SCHEMA = """ -- Stores the 6 pre-computed date filter combinations -- Each combination represents a different initiated/last_seen date range -- Used to efficiently query pre-computed pathway data CREATE TABLE IF NOT EXISTS pathway_date_filters ( id TEXT PRIMARY KEY, -- e.g., 'all_6mo', '1yr_12mo' initiated_label TEXT NOT NULL, -- e.g., 'All years', 'Last 1 year', 'Last 2 years' last_seen_label TEXT NOT NULL, -- e.g., 'Last 6 months', 'Last 12 months' initiated_years INTEGER, -- NULL for 'All', 1, or 2 last_seen_months INTEGER NOT NULL, -- 6 or 12 is_default INTEGER DEFAULT 0, -- 1 for 'all_6mo' (default selection) created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ); -- Pre-populate the 6 combinations INSERT OR REPLACE INTO pathway_date_filters (id, initiated_label, last_seen_label, initiated_years, last_seen_months, is_default) VALUES ('all_6mo', 'All years', 'Last 6 months', NULL, 6, 1), ('all_12mo', 'All years', 'Last 12 months', NULL, 12, 0), ('1yr_6mo', 'Last 1 year', 'Last 6 months', 1, 6, 0), ('1yr_12mo', 'Last 1 year', 'Last 12 months', 1, 12, 0), ('2yr_6mo', 'Last 2 years', 'Last 6 months', 2, 6, 0), ('2yr_12mo', 'Last 2 years', 'Last 12 months', 2, 12, 0); """ PATHWAY_NODES_SCHEMA = """ -- Main pathway nodes table (one set per date filter + chart type combination) -- Stores pre-computed pathway hierarchy with all visualization data -- Designed for fast filtering by date_filter_id + chart_type + trust/directory/drug CREATE TABLE IF NOT EXISTS pathway_nodes ( id INTEGER PRIMARY KEY AUTOINCREMENT, -- Date filter combination this belongs to date_filter_id TEXT NOT NULL, -- Chart type: "directory" (Trust→Directory→Drug) or "indication" (Trust→SearchTerm→Drug) chart_type TEXT NOT NULL DEFAULT 'directory', -- Hierarchy structure (for icicle chart) parents TEXT NOT NULL, -- Parent node identifier ids TEXT NOT NULL, -- Unique node identifier (hierarchical path) labels TEXT NOT NULL, -- Display label level INTEGER NOT NULL, -- Hierarchy depth (0=root, 1=trust, 2=directory/search_term, 3+=drugs) -- Patient counts (accurate for this date filter combination) value INTEGER NOT NULL DEFAULT 0, -- Patient count -- Cost metrics cost REAL NOT NULL DEFAULT 0.0, -- Total cost costpp REAL, -- Cost per patient cost_pp_pa TEXT, -- Cost per patient per annum (formatted string) -- Visualization colour REAL NOT NULL DEFAULT 0.0, -- Color value (proportion of parent) -- Date ranges (for this node) first_seen TEXT, -- First intervention date (ISO format) last_seen TEXT, -- Last intervention date (ISO format) first_seen_parent TEXT, -- Earliest date in parent group last_seen_parent TEXT, -- Latest date in parent group -- Treatment statistics average_spacing TEXT, -- Formatted treatment duration string average_administered TEXT, -- JSON array of average doses per drug avg_days REAL, -- Average treatment duration in days -- Denormalized filter columns (for efficient WHERE clause filtering) trust_name TEXT, -- Extracted trust name from ids directory TEXT, -- Extracted directory from ids drug_sequence TEXT, -- Pipe-separated drug sequence from pathway -- Metadata created_at TEXT DEFAULT CURRENT_TIMESTAMP, data_refresh_id TEXT, -- Links to pathway_refresh_log -- Unique per date filter + chart type + pathway UNIQUE(date_filter_id, chart_type, ids), FOREIGN KEY (date_filter_id) REFERENCES pathway_date_filters(id) ); -- Indexes for efficient filtering -- Primary filter: select by date_filter_id CREATE INDEX IF NOT EXISTS idx_pathway_nodes_date_filter ON pathway_nodes(date_filter_id); -- Chart type filter: for switching between directory and indication views CREATE INDEX IF NOT EXISTS idx_pathway_nodes_chart_type ON pathway_nodes(date_filter_id, chart_type); -- Level filter: often used with date_filter_id CREATE INDEX IF NOT EXISTS idx_pathway_nodes_level ON pathway_nodes(date_filter_id, level); -- Trust filter: for Trust dropdown filtering CREATE INDEX IF NOT EXISTS idx_pathway_nodes_trust ON pathway_nodes(date_filter_id, trust_name); -- Directory filter: for Directory dropdown filtering CREATE INDEX IF NOT EXISTS idx_pathway_nodes_directory ON pathway_nodes(date_filter_id, directory); -- Drug sequence filter: for drug filtering (uses LIKE '%DRUG%') CREATE INDEX IF NOT EXISTS idx_pathway_nodes_drug_seq ON pathway_nodes(drug_sequence); -- Parents filter: for finding children of a node CREATE INDEX IF NOT EXISTS idx_pathway_nodes_parents ON pathway_nodes(date_filter_id, parents); -- Composite index for common filter combination CREATE INDEX IF NOT EXISTS idx_pathway_nodes_filter_composite ON pathway_nodes(date_filter_id, chart_type, trust_name, directory); """ PATHWAY_REFRESH_LOG_SCHEMA = """ -- Metadata table for tracking refresh status -- Tracks when pathway data was last refreshed from Snowflake CREATE TABLE IF NOT EXISTS pathway_refresh_log ( id INTEGER PRIMARY KEY AUTOINCREMENT, refresh_id TEXT NOT NULL, -- Unique identifier for this refresh run started_at TEXT NOT NULL, -- ISO timestamp when refresh started completed_at TEXT, -- ISO timestamp when refresh completed (NULL if still running) status TEXT DEFAULT 'running', -- 'running', 'completed', 'failed' record_count INTEGER, -- Total pathway_nodes records created date_filter_counts TEXT, -- JSON: {"all_6mo": 1234, "all_12mo": 1567, ...} error_message TEXT, -- Error details if status='failed' snowflake_query_date_from TEXT, -- Start date of Snowflake query snowflake_query_date_to TEXT, -- End date of Snowflake query processing_duration_seconds REAL, -- How long the refresh took source_row_count INTEGER, -- Number of Snowflake rows fetched created_at TEXT DEFAULT CURRENT_TIMESTAMP ); -- Index for finding latest refresh CREATE INDEX IF NOT EXISTS idx_pathway_refresh_log_started ON pathway_refresh_log(started_at DESC); -- Index for finding by status CREATE INDEX IF NOT EXISTS idx_pathway_refresh_log_status ON pathway_refresh_log(status); """ # Combined pathway schema PATHWAY_TABLES_SCHEMA = f""" -- Pathway Data Architecture Tables -- Pre-computed pathway data for fast Reflex filtering {PATHWAY_DATE_FILTERS_SCHEMA} {PATHWAY_NODES_SCHEMA} {PATHWAY_REFRESH_LOG_SCHEMA} """ # ============================================================================= # Combined Schemas # ============================================================================= REFERENCE_TABLES_SCHEMA = f""" -- Reference Tables Schema -- Contains lookup data migrated from CSV files {REF_DRUG_NAMES_SCHEMA} {REF_ORGANIZATIONS_SCHEMA} {REF_DIRECTORIES_SCHEMA} {REF_DRUG_DIRECTORY_MAP_SCHEMA} {REF_DRUG_INDICATION_CLUSTERS_SCHEMA} """ ALL_TABLES_SCHEMA = f""" -- Complete Database Schema -- Reference tables + Pathway tables {REFERENCE_TABLES_SCHEMA} {PATHWAY_TABLES_SCHEMA} """ # ============================================================================= # Schema Helper Functions # ============================================================================= def create_reference_tables(conn: sqlite3.Connection) -> None: """ Create all reference tables in the database. Args: conn: SQLite database connection. """ logger.info("Creating reference tables...") conn.executescript(REFERENCE_TABLES_SCHEMA) logger.info("Reference tables created successfully") def drop_reference_tables(conn: sqlite3.Connection) -> None: """ Drop all reference tables from the database. Args: conn: SQLite database connection. Warning: This will delete all reference data. Use with caution. """ logger.warning("Dropping reference tables...") conn.executescript(""" DROP TABLE IF EXISTS ref_drug_names; DROP TABLE IF EXISTS ref_organizations; DROP TABLE IF EXISTS ref_directories; DROP TABLE IF EXISTS ref_drug_directory_map; DROP TABLE IF EXISTS ref_drug_indication_clusters; """) logger.info("Reference tables dropped") def get_reference_table_counts(conn: sqlite3.Connection) -> dict[str, int]: """ Get row counts for all reference tables. Args: conn: SQLite database connection. Returns: Dictionary mapping table name to row count. """ tables = [ "ref_drug_names", "ref_organizations", "ref_directories", "ref_drug_directory_map", "ref_drug_indication_clusters", ] counts = {} for table in tables: try: cursor = conn.execute(f"SELECT COUNT(*) FROM {table}") result = cursor.fetchone() counts[table] = result[0] if result else 0 except sqlite3.OperationalError: counts[table] = 0 return counts def verify_reference_tables_exist(conn: sqlite3.Connection) -> list[str]: """ Verify that all reference tables exist. Args: conn: SQLite database connection. Returns: List of missing table names. Empty list means all tables exist. """ required_tables = [ "ref_drug_names", "ref_organizations", "ref_directories", "ref_drug_directory_map", "ref_drug_indication_clusters", ] missing = [] for table in required_tables: cursor = conn.execute( "SELECT name FROM sqlite_master WHERE type='table' AND name=?", (table,) ) if cursor.fetchone() is None: missing.append(table) return missing # ============================================================================= # Pathway Table Helper Functions # ============================================================================= def create_pathway_tables(conn: sqlite3.Connection) -> None: """ Create pathway data architecture tables in the database. Creates: - pathway_date_filters: 6 pre-defined date filter combinations - pathway_nodes: Pre-computed pathway hierarchy data - pathway_refresh_log: Refresh tracking metadata Args: conn: SQLite database connection. """ logger.info("Creating pathway tables...") conn.executescript(PATHWAY_TABLES_SCHEMA) logger.info("Pathway tables created successfully") def drop_pathway_tables(conn: sqlite3.Connection) -> None: """ Drop pathway data architecture tables from the database. Args: conn: SQLite database connection. Warning: This will delete all pre-computed pathway data. """ logger.warning("Dropping pathway tables...") conn.executescript(""" DROP TABLE IF EXISTS pathway_nodes; DROP TABLE IF EXISTS pathway_refresh_log; DROP TABLE IF EXISTS pathway_date_filters; """) logger.info("Pathway tables dropped") def get_pathway_table_counts(conn: sqlite3.Connection) -> dict[str, int]: """ Get row counts for pathway tables. Args: conn: SQLite database connection. Returns: Dictionary mapping table name to row count. """ tables = ["pathway_date_filters", "pathway_nodes", "pathway_refresh_log"] counts = {} for table in tables: try: cursor = conn.execute(f"SELECT COUNT(*) FROM {table}") result = cursor.fetchone() counts[table] = result[0] if result else 0 except sqlite3.OperationalError: # Table doesn't exist yet counts[table] = 0 return counts def verify_pathway_tables_exist(conn: sqlite3.Connection) -> list[str]: """ Verify that pathway tables exist. Args: conn: SQLite database connection. Returns: List of missing table names. Empty list means all tables exist. """ required_tables = ["pathway_date_filters", "pathway_nodes", "pathway_refresh_log"] missing = [] for table in required_tables: cursor = conn.execute( "SELECT name FROM sqlite_master WHERE type='table' AND name=?", (table,) ) if cursor.fetchone() is None: missing.append(table) return missing def clear_pathway_nodes(conn: sqlite3.Connection, date_filter_id: str | None = None) -> int: """ Clear pathway nodes, optionally for a specific date filter. Args: conn: SQLite database connection. date_filter_id: If provided, only clear nodes for this date filter. If None, clear all pathway nodes. Returns: Number of rows deleted. """ if date_filter_id: cursor = conn.execute( "DELETE FROM pathway_nodes WHERE date_filter_id = ?", (date_filter_id,) ) else: cursor = conn.execute("DELETE FROM pathway_nodes") deleted_count = cursor.rowcount conn.commit() logger.info(f"Cleared {deleted_count} pathway nodes") return deleted_count def get_pathway_refresh_status(conn: sqlite3.Connection) -> dict | None: """ Get the status of the most recent pathway refresh. Args: conn: SQLite database connection. Returns: Dictionary with refresh status, or None if no refresh has been done. """ try: cursor = conn.execute(""" SELECT refresh_id, started_at, completed_at, status, record_count, date_filter_counts, error_message, processing_duration_seconds FROM pathway_refresh_log ORDER BY started_at DESC LIMIT 1 """) row = cursor.fetchone() if row: return { "refresh_id": row[0], "started_at": row[1], "completed_at": row[2], "status": row[3], "record_count": row[4], "date_filter_counts": row[5], "error_message": row[6], "processing_duration_seconds": row[7], } return None except sqlite3.OperationalError: # Table doesn't exist yet return None def migrate_pathway_nodes_chart_type(conn: sqlite3.Connection) -> tuple[bool, str]: """ Migrate pathway_nodes table to add chart_type column. This migration: 1. Checks if chart_type column already exists 2. If not, adds it with DEFAULT 'directory' 3. Updates existing rows to have 'directory' chart_type 4. Adds index for efficient filtering Args: conn: SQLite database connection. Returns: Tuple of (success: bool, message: str) """ # Check if table exists cursor = conn.execute( "SELECT name FROM sqlite_master WHERE type='table' AND name='pathway_nodes'" ) if cursor.fetchone() is None: return True, "pathway_nodes table does not exist yet (will be created with chart_type column)" # Check if chart_type column already exists cursor = conn.execute("PRAGMA table_info(pathway_nodes)") columns = [row[1] for row in cursor.fetchall()] if "chart_type" in columns: return True, "chart_type column already exists in pathway_nodes" # Add chart_type column logger.info("Adding chart_type column to pathway_nodes table...") try: # Add column with default value conn.execute(""" ALTER TABLE pathway_nodes ADD COLUMN chart_type TEXT NOT NULL DEFAULT 'directory' """) # Create index for efficient filtering by chart type conn.execute(""" CREATE INDEX IF NOT EXISTS idx_pathway_nodes_chart_type ON pathway_nodes(date_filter_id, chart_type) """) # Update existing composite index (need to drop and recreate) # Note: SQLite doesn't support DROP INDEX IF EXISTS in older versions, # so we use a try/except try: conn.execute("DROP INDEX idx_pathway_nodes_filter_composite") except sqlite3.OperationalError: pass # Index didn't exist conn.execute(""" CREATE INDEX IF NOT EXISTS idx_pathway_nodes_filter_composite ON pathway_nodes(date_filter_id, chart_type, trust_name, directory) """) # Need to recreate unique constraint since it changed # SQLite doesn't support ALTER TABLE to change constraints, but # since we're adding a column with a default value and the old # constraint was (date_filter_id, ids), the new constraint # (date_filter_id, chart_type, ids) will be satisfied by all existing # rows since they all have chart_type='directory' conn.commit() logger.info("chart_type column added successfully") # Count updated rows cursor = conn.execute("SELECT COUNT(*) FROM pathway_nodes") row_count = cursor.fetchone()[0] return True, f"Added chart_type column, {row_count} existing rows set to 'directory'" except Exception as e: logger.error(f"Failed to add chart_type column: {e}") return False, f"Migration failed: {e}" def migrate_refresh_log_source_row_count(conn: sqlite3.Connection) -> tuple[bool, str]: """Add source_row_count column to pathway_refresh_log if it doesn't exist. This column stores the Snowflake row count for display in the UI footer. """ cursor = conn.execute("PRAGMA table_info(pathway_refresh_log)") columns = [row[1] for row in cursor.fetchall()] if "source_row_count" in columns: return True, "source_row_count column already exists" logger.info("Adding source_row_count column to pathway_refresh_log...") try: conn.execute(""" ALTER TABLE pathway_refresh_log ADD COLUMN source_row_count INTEGER """) conn.commit() return True, "Added source_row_count column" except Exception as e: logger.error(f"Failed to add source_row_count column: {e}") return False, f"Migration failed: {e}" # ============================================================================= # Combined Helper Functions # ============================================================================= def create_all_tables(conn: sqlite3.Connection) -> None: """ Create all tables (reference + pathway) in the database. Args: conn: SQLite database connection. """ logger.info("Creating all database tables...") conn.executescript(ALL_TABLES_SCHEMA) logger.info("All tables created successfully") def drop_all_tables(conn: sqlite3.Connection) -> None: """ Drop all tables from the database. Args: conn: SQLite database connection. Warning: This will delete all data. Use with extreme caution. """ logger.warning("Dropping all tables...") drop_pathway_tables(conn) drop_reference_tables(conn) logger.info("All tables dropped") def get_all_table_counts(conn: sqlite3.Connection) -> dict[str, int]: """ Get row counts for all tables. Args: conn: SQLite database connection. Returns: Dictionary mapping table name to row count. """ counts = {} counts.update(get_reference_table_counts(conn)) counts.update(get_pathway_table_counts(conn)) return counts def verify_all_tables_exist(conn: sqlite3.Connection) -> list[str]: """ Verify that all tables exist. Args: conn: SQLite database connection. Returns: List of missing table names. Empty list means all tables exist. """ missing = [] missing.extend(verify_reference_tables_exist(conn)) missing.extend(verify_pathway_tables_exist(conn)) return missing