phil/StarPunk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: Rename SCHEMA_SQL to INITIAL_SCHEMA_SQL

Browse Source 
This aligns with ADR-033's migration system redesign. The initial schema
represents the v1.0.0 baseline and should not be modified. All schema
changes after v1.0.0 must go in migration files.

Changes:
- Renamed SCHEMA_SQL → INITIAL_SCHEMA_SQL in database.py
- Updated all references in migrations.py comments
- Added comment: "DO NOT MODIFY - This represents the v1.0.0 schema state"
- No functional changes, purely documentation improvement

Part of v1.1.0 migration system redesign (Phase 2).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Phil Skentelbery
2025-11-25 09:59:17 -07:00
parent d9df55ae63
commit 8352c3ab7c
2 changed files with 20 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
starpunk/database.py
View File

@@ -7,8 +7,10 @@ import sqlite3
from pathlib import Path from pathlib import Path
# Database schema # Initial database schema (v1.0.0 baseline)
SCHEMA_SQL = """ # DO NOT MODIFY - This represents the v1.0.0 schema state
# All schema changes after v1.0.0 must go in migration files
INITIAL_SCHEMA_SQL = """
-- Notes metadata (content is in files) -- Notes metadata (content is in files)
CREATE TABLE IF NOT EXISTS notes ( CREATE TABLE IF NOT EXISTS notes (
id INTEGER PRIMARY KEY AUTOINCREMENT, id INTEGER PRIMARY KEY AUTOINCREMENT,
@@ -107,7 +109,7 @@ def init_db(app=None):
# Create database and initial schema # Create database and initial schema
conn = sqlite3.connect(db_path) conn = sqlite3.connect(db_path)
try: try:
conn.executescript(SCHEMA_SQL) conn.executescript(INITIAL_SCHEMA_SQL)
conn.commit() conn.commit()
if logger: if logger:
logger.info(f"Database initialized: {db_path}") logger.info(f"Database initialized: {db_path}")

30
starpunk/migrations.py
View File

@@ -7,7 +7,7 @@ Migrations are numbered SQL files in the migrations/ directory.
Fresh Database Detection: Fresh Database Detection:
- If schema_migrations table is empty AND schema is current - If schema_migrations table is empty AND schema is current
- Marks all migrations as applied (skip execution) - Marks all migrations as applied (skip execution)
- This handles databases created with current SCHEMA_SQL - This handles databases created with current INITIAL_SCHEMA_SQL
Existing Database Behavior: Existing Database Behavior:
- Applies only pending migrations - Applies only pending migrations
@@ -56,14 +56,14 @@ def create_migrations_table(conn):
def is_schema_current(conn): def is_schema_current(conn):
""" """
Check if database schema is current (matches SCHEMA_SQL + all migrations) Check if database schema is current (matches INITIAL_SCHEMA_SQL + all migrations)
Uses heuristic: Check for presence of latest schema features Uses heuristic: Check for presence of latest schema features
Checks for: Checks for:
- code_verifier column NOT in auth_state (removed in migration 003) - code_verifier column NOT in auth_state (removed in migration 003)
- authorization_codes table (migration 002 or SCHEMA_SQL >= v1.0.0-rc.1) - authorization_codes table (migration 002 or INITIAL_SCHEMA_SQL >= v1.0.0-rc.1)
- token_hash column in tokens table (migration 002) - token_hash column in tokens table (migration 002)
- Token indexes (migration 002 only, removed from SCHEMA_SQL in v1.0.0-rc.2) - Token indexes (migration 002 only, removed from INITIAL_SCHEMA_SQL in v1.0.0-rc.2)
Args: Args:
conn: SQLite connection conn: SQLite connection
@@ -87,10 +87,10 @@ def is_schema_current(conn):
return False return False
# Check for token indexes (created by migration 002 ONLY) # Check for token indexes (created by migration 002 ONLY)
# These indexes were removed from SCHEMA_SQL in v1.0.0-rc.2 # These indexes were removed from INITIAL_SCHEMA_SQL in v1.0.0-rc.2
# to prevent conflicts when migrations run. # to prevent conflicts when migrations run.
# A database with tables/columns but no indexes means: # A database with tables/columns but no indexes means:
# - SCHEMA_SQL was run (creating tables/columns) # - INITIAL_SCHEMA_SQL was run (creating tables/columns)
# - But migration 002 hasn't run yet (no indexes) # - But migration 002 hasn't run yet (no indexes)
# So it's NOT fully current and needs migrations. # So it's NOT fully current and needs migrations.
if not index_exists(conn, 'idx_tokens_hash'): if not index_exists(conn, 'idx_tokens_hash'):
@@ -166,7 +166,7 @@ def is_migration_needed(conn, migration_name):
""" """
Check if a specific migration is needed based on database state Check if a specific migration is needed based on database state
This is used for fresh databases where SCHEMA_SQL may have already This is used for fresh databases where INITIAL_SCHEMA_SQL may have already
included some migration features. We check the actual database state included some migration features. We check the actual database state
rather than just applying all migrations blindly. rather than just applying all migrations blindly.
@@ -175,11 +175,11 @@ def is_migration_needed(conn, migration_name):
migration_name: Migration filename to check migration_name: Migration filename to check
Returns: Returns:
bool: True if migration should be applied, False if already applied via SCHEMA_SQL bool: True if migration should be applied, False if already applied via INITIAL_SCHEMA_SQL
""" """
# Migration 001: Adds code_verifier column to auth_state # Migration 001: Adds code_verifier column to auth_state
if migration_name == "001_add_code_verifier_to_auth_state.sql": if migration_name == "001_add_code_verifier_to_auth_state.sql":
# Check if column already exists (was added to SCHEMA_SQL in v0.8.0) # Check if column already exists (was added to INITIAL_SCHEMA_SQL in v0.8.0)
return not column_exists(conn, 'auth_state', 'code_verifier') return not column_exists(conn, 'auth_state', 'code_verifier')
# Migration 002: Creates new tokens/authorization_codes tables with indexes # Migration 002: Creates new tokens/authorization_codes tables with indexes
@@ -197,7 +197,7 @@ def is_migration_needed(conn, migration_name):
# If tables exist with correct structure, check indexes # If tables exist with correct structure, check indexes
# If indexes are missing but tables exist, this is a fresh database from # If indexes are missing but tables exist, this is a fresh database from
# SCHEMA_SQL that just needs indexes. We CANNOT run the full migration # INITIAL_SCHEMA_SQL that just needs indexes. We CANNOT run the full migration
# (it will fail trying to CREATE TABLE). Instead, we mark it as not needed # (it will fail trying to CREATE TABLE). Instead, we mark it as not needed
# and apply indexes separately. # and apply indexes separately.
has_all_indexes = ( has_all_indexes = (
@@ -209,7 +209,7 @@ def is_migration_needed(conn, migration_name):
) )
if not has_all_indexes: if not has_all_indexes:
# Tables exist but indexes missing - this is a fresh database from SCHEMA_SQL # Tables exist but indexes missing - this is a fresh database from INITIAL_SCHEMA_SQL
# We need to create just the indexes, not run the full migration # We need to create just the indexes, not run the full migration
# Return False (don't run migration) and handle indexes separately # Return False (don't run migration) and handle indexes separately
return False return False
@@ -323,7 +323,7 @@ def run_migrations(db_path, logger=None):
Fresh Database Behavior: Fresh Database Behavior:
- If schema_migrations table is empty AND schema is current - If schema_migrations table is empty AND schema is current
- Marks all migrations as applied (skip execution) - Marks all migrations as applied (skip execution)
- This handles databases created with current SCHEMA_SQL - This handles databases created with current INITIAL_SCHEMA_SQL
Existing Database Behavior: Existing Database Behavior:
- Applies only pending migrations - Applies only pending migrations
@@ -457,13 +457,13 @@ def run_migrations(db_path, logger=None):
conn.execute(index_sql) conn.execute(index_sql)
logger.info(f"Created {len(indexes_to_create)} missing indexes from migration 002") logger.info(f"Created {len(indexes_to_create)} missing indexes from migration 002")
# Mark as applied without executing full migration (SCHEMA_SQL already has table changes) # Mark as applied without executing full migration (INITIAL_SCHEMA_SQL already has table changes)
conn.execute( conn.execute(
"INSERT INTO schema_migrations (migration_name) VALUES (?)", "INSERT INTO schema_migrations (migration_name) VALUES (?)",
(migration_name,) (migration_name,)
) )
skipped_count += 1 skipped_count += 1
logger.debug(f"Skipped migration {migration_name} (already in SCHEMA_SQL)") logger.debug(f"Skipped migration {migration_name} (already in INITIAL_SCHEMA_SQL)")
else: else:
# Apply the migration (within our transaction) # Apply the migration (within our transaction)
try: try:
@@ -497,7 +497,7 @@ def run_migrations(db_path, logger=None):
if skipped_count > 0: if skipped_count > 0:
logger.info( logger.info(
f"Migrations complete: {pending_count} applied, {skipped_count} skipped " f"Migrations complete: {pending_count} applied, {skipped_count} skipped "
f"(already in SCHEMA_SQL), {total_count} total" f"(already in INITIAL_SCHEMA_SQL), {total_count} total"
) )
else: else:
logger.info( logger.info(