PostgreSQL Extensions Best Practices¶

Core Principles¶

Essential Extensions: Install only what you need
Version Compatibility: Ensure extension compatibility with PostgreSQL version
Performance Impact: Monitor extension performance overhead
Security: Secure extension installation and usage
Maintenance: Regular extension updates and monitoring

Essential Extensions¶

Core Database Extensions¶

-- Enable essential extensions for production
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
CREATE EXTENSION IF NOT EXISTS "pgcrypto";
CREATE EXTENSION IF NOT EXISTS "pg_stat_statements";
CREATE EXTENSION IF NOT EXISTS "btree_gin";
CREATE EXTENSION IF NOT EXISTS "btree_gist";
CREATE EXTENSION IF NOT EXISTS "hstore";
CREATE EXTENSION IF NOT EXISTS "ltree";
CREATE EXTENSION IF NOT EXISTS "unaccent";
CREATE EXTENSION IF NOT EXISTS "pg_trgm";

-- Verify extensions are installed
SELECT * FROM pg_extension ORDER BY extname;

Performance Monitoring Extensions¶

-- Enable performance monitoring extensions
CREATE EXTENSION IF NOT EXISTS "pg_stat_statements";
CREATE EXTENSION IF NOT EXISTS "pg_stat_statements_reset";

-- Configure pg_stat_statements
ALTER SYSTEM SET shared_preload_libraries = 'pg_stat_statements';
ALTER SYSTEM SET pg_stat_statements.max = 10000;
ALTER SYSTEM SET pg_stat_statements.track = 'all';
SELECT pg_reload_conf();

-- View query statistics
SELECT 
    query,
    calls,
    total_time,
    mean_time,
    stddev_time,
    rows,
    100.0 * shared_blks_hit / nullif(shared_blks_hit + shared_blks_read, 0) AS hit_percent
FROM pg_stat_statements 
ORDER BY total_time DESC 
LIMIT 20;

Geospatial Extensions¶

PostGIS Setup¶

-- Install PostGIS extensions
CREATE EXTENSION IF NOT EXISTS "postgis";
CREATE EXTENSION IF NOT EXISTS "postgis_topology";
CREATE EXTENSION IF NOT EXISTS "fuzzystrmatch";
CREATE EXTENSION IF NOT EXISTS "postgis_tiger_geocoder";

-- Verify PostGIS installation
SELECT PostGIS_Version();
SELECT ST_AsText(ST_GeomFromText('POINT(0 0)', 4326));

-- Create spatial reference systems
INSERT INTO spatial_ref_sys (srid, auth_name, auth_srid, proj4text, srtext)
VALUES (900913, 'EPSG', 900913, '+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs', 
        'PROJCS["WGS 84 / Pseudo-Mercator",GEOGCS["WGS 84",DATUM["WGS_1984",SPHEROID["WGS 84",6378137,298.257223563,AUTHORITY["EPSG","7030"]],AUTHORITY["EPSG","6326"]],PRIMEM["Greenwich",0,AUTHORITY["EPSG","8901"]],UNIT["degree",0.0174532925199433,AUTHORITY["EPSG","9122"]],AUTHORITY["EPSG","4326"]],PROJECTION["Mercator_1SP"],PARAMETER["central_meridian",0],PARAMETER["scale_factor",1],PARAMETER["false_easting",0],PARAMETER["false_northing",0],UNIT["metre",1,AUTHORITY["EPSG","9001"]],AXIS["X",EAST],AXIS["Y",NORTH],AUTHORITY["EPSG","900913"]]');

Spatial Data Management¶

-- Create spatial tables
CREATE TABLE locations (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100) NOT NULL,
    geom GEOMETRY(POINT, 4326) NOT NULL,
    created_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP
);

-- Create spatial indexes
CREATE INDEX idx_locations_geom ON locations USING GIST (geom);
CREATE INDEX idx_locations_geom_4326 ON locations USING GIST (ST_Transform(geom, 4326));

-- Insert spatial data
INSERT INTO locations (name, geom) VALUES
    ('New York', ST_GeomFromText('POINT(-74.0060 40.7128)', 4326)),
    ('London', ST_GeomFromText('POINT(-0.1276 51.5074)', 4326)),
    ('Tokyo', ST_GeomFromText('POINT(139.6917 35.6895)', 4326));

-- Spatial queries
SELECT 
    name,
    ST_AsText(geom) as coordinates,
    ST_Distance(geom, ST_GeomFromText('POINT(0 0)', 4326)) as distance_from_origin
FROM locations
ORDER BY distance_from_origin;

Full-Text Search Extensions¶

Text Search Configuration¶

-- Enable full-text search extensions
CREATE EXTENSION IF NOT EXISTS "pg_trgm";
CREATE EXTENSION IF NOT EXISTS "unaccent";

-- Create custom text search configuration
CREATE TEXT SEARCH CONFIGURATION english_unaccent (COPY = english);

-- Add unaccent filter
ALTER TEXT SEARCH CONFIGURATION english_unaccent
    ALTER MAPPING FOR asciiword, asciihword, hword_asciipart, word, hword, hword_part
    WITH unaccent, english_stem;

-- Create full-text search table
CREATE TABLE documents (
    id SERIAL PRIMARY KEY,
    title VARCHAR(200) NOT NULL,
    content TEXT NOT NULL,
    search_vector TSVECTOR,
    created_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP
);

-- Create search vector index
CREATE INDEX idx_documents_search_vector ON documents USING GIN (search_vector);

-- Create trigram index for similarity search
CREATE INDEX idx_documents_content_trgm ON documents USING GIN (content gin_trgm_ops);

-- Function to update search vector
CREATE OR REPLACE FUNCTION update_document_search_vector()
RETURNS TRIGGER AS $$
BEGIN
    NEW.search_vector := to_tsvector('english_unaccent', COALESCE(NEW.title, '') || ' ' || COALESCE(NEW.content, ''));
    RETURN NEW;
END;
$$ LANGUAGE plpgsql;

-- Create trigger to update search vector
CREATE TRIGGER update_documents_search_vector
    BEFORE INSERT OR UPDATE ON documents
    FOR EACH ROW EXECUTE FUNCTION update_document_search_vector();

Advanced Text Search¶

-- Insert sample documents
INSERT INTO documents (title, content) VALUES
    ('PostgreSQL Guide', 'PostgreSQL is a powerful, open source object-relational database system.'),
    ('Database Design', 'Good database design is essential for application performance.'),
    ('SQL Optimization', 'Query optimization techniques can significantly improve database performance.');

-- Full-text search queries
SELECT 
    title,
    content,
    ts_rank(search_vector, plainto_tsquery('english_unaccent', 'database performance')) as rank
FROM documents
WHERE search_vector @@ plainto_tsquery('english_unaccent', 'database performance')
ORDER BY rank DESC;

-- Similarity search
SELECT 
    title,
    content,
    similarity(content, 'database performance') as sim
FROM documents
WHERE content % 'database performance'
ORDER BY sim DESC;

JSON and NoSQL Extensions¶

JSONB Operations¶

-- Enable JSON extensions
CREATE EXTENSION IF NOT EXISTS "jsquery";

-- Create JSONB table
CREATE TABLE user_profiles (
    id SERIAL PRIMARY KEY,
    user_id INTEGER NOT NULL,
    profile_data JSONB NOT NULL,
    created_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP
);

-- Create JSONB indexes
CREATE INDEX idx_user_profiles_profile_data ON user_profiles USING GIN (profile_data);
CREATE INDEX idx_user_profiles_user_id ON user_profiles (user_id);

-- Insert JSON data
INSERT INTO user_profiles (user_id, profile_data) VALUES
    (1, '{"name": "John Doe", "age": 30, "email": "john@example.com", "preferences": {"theme": "dark", "notifications": true}}'),
    (2, '{"name": "Jane Smith", "age": 25, "email": "jane@example.com", "preferences": {"theme": "light", "notifications": false}}');

-- JSONB queries
SELECT 
    user_id,
    profile_data->>'name' as name,
    profile_data->>'email' as email,
    profile_data->'preferences'->>'theme' as theme
FROM user_profiles
WHERE profile_data @> '{"preferences": {"theme": "dark"}}';

-- JSONB path queries
SELECT 
    user_id,
    profile_data #> '{preferences,notifications}' as notifications
FROM user_profiles
WHERE profile_data #> '{preferences,notifications}' = 'true';

Custom Extension Development¶

Extension Structure¶

-- Create custom extension
CREATE EXTENSION IF NOT EXISTS "plpgsql";

-- Custom function for data validation
CREATE OR REPLACE FUNCTION validate_email(email TEXT)
RETURNS BOOLEAN AS $$
BEGIN
    RETURN email ~* '^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$';
END;
$$ LANGUAGE plpgsql;

-- Custom function for data transformation
CREATE OR REPLACE FUNCTION normalize_phone(phone TEXT)
RETURNS TEXT AS $$
BEGIN
    -- Remove all non-digit characters
    RETURN regexp_replace(phone, '[^0-9]', '', 'g');
END;
$$ LANGUAGE plpgsql;

-- Custom aggregate function
CREATE OR REPLACE FUNCTION array_accum(anyarray, anyelement)
RETURNS anyarray AS $$
BEGIN
    RETURN array_append($1, $2);
END;
$$ LANGUAGE plpgsql;

CREATE AGGREGATE array_agg_custom(anyelement) (
    SFUNC = array_accum,
    STYPE = anyarray,
    INITCOND = '{}'
);

Extension Management¶

# extensions/extension_manager.py
import psycopg2
import logging
from typing import List, Dict, Any

class PostgreSQLExtensionManager:
    def __init__(self, connection_params):
        self.conn_params = connection_params
        self.setup_logging()

    def setup_logging(self):
        """Setup logging."""
        logging.basicConfig(level=logging.INFO)
        self.logger = logging.getLogger(__name__)

    def list_installed_extensions(self):
        """List all installed extensions."""
        conn = psycopg2.connect(**self.conn_params)

        try:
            with conn.cursor() as cur:
                cur.execute("""
                    SELECT 
                        extname,
                        extversion,
                        extrelocatable,
                        extconfig,
                        extcondition
                    FROM pg_extension
                    ORDER BY extname;
                """)

                extensions = cur.fetchall()
                return extensions

        except Exception as e:
            self.logger.error(f"Error listing extensions: {e}")
            return []
        finally:
            conn.close()

    def install_extension(self, extension_name, version=None):
        """Install a PostgreSQL extension."""
        conn = psycopg2.connect(**self.conn_params)

        try:
            with conn.cursor() as cur:
                if version:
                    sql = f"CREATE EXTENSION IF NOT EXISTS {extension_name} VERSION '{version}';"
                else:
                    sql = f"CREATE EXTENSION IF NOT EXISTS {extension_name};"

                cur.execute(sql)
                conn.commit()
                self.logger.info(f"Extension {extension_name} installed successfully")
                return True

        except Exception as e:
            self.logger.error(f"Error installing extension {extension_name}: {e}")
            conn.rollback()
            return False
        finally:
            conn.close()

    def uninstall_extension(self, extension_name):
        """Uninstall a PostgreSQL extension."""
        conn = psycopg2.connect(**self.conn_params)

        try:
            with conn.cursor() as cur:
                cur.execute(f"DROP EXTENSION IF EXISTS {extension_name};")
                conn.commit()
                self.logger.info(f"Extension {extension_name} uninstalled successfully")
                return True

        except Exception as e:
            self.logger.error(f"Error uninstalling extension {extension_name}: {e}")
            conn.rollback()
            return False
        finally:
            conn.close()

    def check_extension_availability(self, extension_name):
        """Check if an extension is available for installation."""
        conn = psycopg2.connect(**self.conn_params)

        try:
            with conn.cursor() as cur:
                cur.execute("""
                    SELECT EXISTS(
                        SELECT 1 FROM pg_available_extensions 
                        WHERE name = %s
                    );
                """, (extension_name,))

                available = cur.fetchone()[0]
                return available

        except Exception as e:
            self.logger.error(f"Error checking extension availability: {e}")
            return False
        finally:
            conn.close()

    def get_extension_dependencies(self, extension_name):
        """Get dependencies for an extension."""
        conn = psycopg2.connect(**self.conn_params)

        try:
            with conn.cursor() as cur:
                cur.execute("""
                    SELECT 
                        depname,
                        deptype
                    FROM pg_depend d
                    JOIN pg_extension e ON d.refobjid = e.oid
                    WHERE e.extname = %s;
                """, (extension_name,))

                dependencies = cur.fetchall()
                return dependencies

        except Exception as e:
            self.logger.error(f"Error getting extension dependencies: {e}")
            return []
        finally:
            conn.close()

    def update_extension(self, extension_name, new_version):
        """Update an extension to a new version."""
        conn = psycopg2.connect(**self.conn_params)

        try:
            with conn.cursor() as cur:
                cur.execute(f"ALTER EXTENSION {extension_name} UPDATE TO '{new_version}';")
                conn.commit()
                self.logger.info(f"Extension {extension_name} updated to version {new_version}")
                return True

        except Exception as e:
            self.logger.error(f"Error updating extension {extension_name}: {e}")
            conn.rollback()
            return False
        finally:
            conn.close()

# Usage
if __name__ == "__main__":
    manager = PostgreSQLExtensionManager({
        'host': 'localhost',
        'database': 'production',
        'user': 'extension_manager',
        'password': 'extension_password'
    })

    # List installed extensions
    extensions = manager.list_installed_extensions()
    for ext in extensions:
        print(f"Extension: {ext[0]}, Version: {ext[1]}")

    # Install new extension
    if manager.check_extension_availability('pg_stat_statements'):
        manager.install_extension('pg_stat_statements')

Time Series Extensions¶

TimescaleDB Integration¶

-- Install TimescaleDB extension
CREATE EXTENSION IF NOT EXISTS "timescaledb";

-- Create hypertable for time series data
CREATE TABLE sensor_readings (
    time TIMESTAMPTZ NOT NULL,
    sensor_id INTEGER NOT NULL,
    temperature DOUBLE PRECISION,
    humidity DOUBLE PRECISION,
    pressure DOUBLE PRECISION
);

-- Convert to hypertable
SELECT create_hypertable('sensor_readings', 'time');

-- Create indexes
CREATE INDEX idx_sensor_readings_sensor_id_time ON sensor_readings (sensor_id, time DESC);

-- Insert time series data
INSERT INTO sensor_readings (time, sensor_id, temperature, humidity, pressure)
SELECT 
    generate_series('2024-01-01'::timestamptz, '2024-01-31'::timestamptz, '1 hour'::interval),
    (random() * 10)::integer,
    (random() * 30 + 10)::double precision,
    (random() * 50 + 30)::double precision,
    (random() * 100 + 900)::double precision;

-- Time series queries
SELECT 
    time_bucket('1 day', time) as day,
    sensor_id,
    AVG(temperature) as avg_temp,
    MAX(temperature) as max_temp,
    MIN(temperature) as min_temp
FROM sensor_readings
WHERE time >= '2024-01-01' AND time < '2024-02-01'
GROUP BY day, sensor_id
ORDER BY day, sensor_id;

Extension Security¶

Secure Extension Management¶

-- Create extension management role
CREATE ROLE extension_manager WITH LOGIN PASSWORD 'secure_password';

-- Grant necessary privileges
GRANT CREATE ON DATABASE production TO extension_manager;
GRANT USAGE ON SCHEMA public TO extension_manager;

-- Restrict extension installation to specific schemas
CREATE SCHEMA IF NOT EXISTS extensions;
GRANT USAGE ON SCHEMA extensions TO extension_manager;

-- Create extension whitelist
CREATE TABLE extension_whitelist (
    id SERIAL PRIMARY KEY,
    extension_name VARCHAR(100) NOT NULL UNIQUE,
    allowed_versions TEXT[],
    security_level VARCHAR(20) DEFAULT 'medium',
    created_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP
);

-- Insert allowed extensions
INSERT INTO extension_whitelist (extension_name, allowed_versions, security_level) VALUES
    ('pg_stat_statements', ARRAY['1.8', '1.9'], 'low'),
    ('postgis', ARRAY['3.0', '3.1'], 'medium'),
    ('uuid-ossp', ARRAY['1.1'], 'low'),
    ('pgcrypto', ARRAY['1.3'], 'medium');

-- Function to check extension whitelist
CREATE OR REPLACE FUNCTION is_extension_allowed(ext_name TEXT, ext_version TEXT DEFAULT NULL)
RETURNS BOOLEAN AS $$
BEGIN
    IF ext_version IS NULL THEN
        RETURN EXISTS(
            SELECT 1 FROM extension_whitelist 
            WHERE extension_name = ext_name
        );
    ELSE
        RETURN EXISTS(
            SELECT 1 FROM extension_whitelist 
            WHERE extension_name = ext_name 
            AND (allowed_versions IS NULL OR ext_version = ANY(allowed_versions))
        );
    END IF;
END;
$$ LANGUAGE plpgsql;

Extension Monitoring¶

Extension Performance Monitoring¶

# monitoring/extension_monitor.py
import psycopg2
import json
from datetime import datetime
import logging

class ExtensionMonitor:
    def __init__(self, connection_params):
        self.conn_params = connection_params
        self.setup_logging()

    def setup_logging(self):
        """Setup logging."""
        logging.basicConfig(level=logging.INFO)
        self.logger = logging.getLogger(__name__)

    def monitor_extension_performance(self):
        """Monitor extension performance impact."""
        conn = psycopg2.connect(**self.conn_params)

        try:
            with conn.cursor() as cur:
                # Get extension usage statistics
                cur.execute("""
                    SELECT 
                        extname,
                        extversion,
                        pg_size_pretty(pg_relation_size(oid)) as size
                    FROM pg_extension
                    ORDER BY pg_relation_size(oid) DESC;
                """)

                extension_stats = cur.fetchall()

                # Get extension function usage
                cur.execute("""
                    SELECT 
                        n.nspname as schema_name,
                        p.proname as function_name,
                        pg_stat_get_function_calls(p.oid) as calls,
                        pg_stat_get_function_total_time(p.oid) as total_time
                    FROM pg_proc p
                    JOIN pg_namespace n ON p.pronamespace = n.oid
                    WHERE n.nspname IN (
                        SELECT extnamespace::regnamespace::text 
                        FROM pg_extension
                    )
                    ORDER BY pg_stat_get_function_total_time(p.oid) DESC;
                """)

                function_stats = cur.fetchall()

                return {
                    'extension_stats': extension_stats,
                    'function_stats': function_stats,
                    'monitor_timestamp': datetime.now().isoformat()
                }

        except Exception as e:
            self.logger.error(f"Error monitoring extensions: {e}")
            return {}
        finally:
            conn.close()

    def check_extension_health(self):
        """Check extension health and issues."""
        conn = psycopg2.connect(**self.conn_params)

        try:
            with conn.cursor() as cur:
                # Check for extension errors
                cur.execute("""
                    SELECT 
                        extname,
                        extversion,
                        extrelocatable
                    FROM pg_extension
                    WHERE extname NOT IN (
                        SELECT name FROM pg_available_extensions
                    );
                """)

                unavailable_extensions = cur.fetchall()

                # Check for extension conflicts
                cur.execute("""
                    SELECT 
                        extname,
                        COUNT(*) as dependency_count
                    FROM pg_depend d
                    JOIN pg_extension e ON d.refobjid = e.oid
                    GROUP BY extname
                    HAVING COUNT(*) > 10;
                """)

                high_dependency_extensions = cur.fetchall()

                return {
                    'unavailable_extensions': unavailable_extensions,
                    'high_dependency_extensions': high_dependency_extensions,
                    'health_check_timestamp': datetime.now().isoformat()
                }

        except Exception as e:
            self.logger.error(f"Error checking extension health: {e}")
            return {}
        finally:
            conn.close()

# Usage
if __name__ == "__main__":
    monitor = ExtensionMonitor({
        'host': 'localhost',
        'database': 'production',
        'user': 'monitor_user',
        'password': 'monitor_password'
    })

    # Monitor extension performance
    performance_data = monitor.monitor_extension_performance()
    print(json.dumps(performance_data, indent=2))

    # Check extension health
    health_data = monitor.check_extension_health()
    print(json.dumps(health_data, indent=2))

TL;DR Runbook¶

Quick Start¶

-- 1. Install essential extensions
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
CREATE EXTENSION IF NOT EXISTS "pgcrypto";
CREATE EXTENSION IF NOT EXISTS "pg_stat_statements";

-- 2. Install geospatial extensions
CREATE EXTENSION IF NOT EXISTS "postgis";

-- 3. Install full-text search extensions
CREATE EXTENSION IF NOT EXISTS "pg_trgm";
CREATE EXTENSION IF NOT EXISTS "unaccent";

-- 4. Verify extensions
SELECT * FROM pg_extension ORDER BY extname;

Essential Patterns¶

# Complete PostgreSQL extensions setup
def setup_postgresql_extensions():
    # 1. Essential extensions
    # 2. Geospatial extensions
    # 3. Full-text search extensions
    # 4. JSON/NoSQL extensions
    # 5. Custom extensions
    # 6. Extension management
    # 7. Security and monitoring
    # 8. Performance optimization

    print("PostgreSQL extensions setup complete!")