Skip to content

fix: generated column on public schema #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tianzhou merged 1 commit into from
Dec 17, 2025
Merged

fix: generated column on public schema #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
175 changes: 112 additions & 63 deletions ir/queries/queries.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,72 +127,121 @@ ORDER BY c.table_schema, c.table_name, c.ordinal_position;

-- GetColumnsForSchema retrieves all columns for tables in a specific schema
-- name: GetColumnsForSchema :many
WITH column_base AS (
SELECT
c.table_schema,
c.table_name,
c.column_name,
c.ordinal_position,
c.column_default,
c.is_nullable,
c.data_type,
c.character_maximum_length,
c.numeric_precision,
c.numeric_scale,
c.udt_name,
COALESCE(d.description, '') AS column_comment,
CASE
WHEN dt.typtype = 'd' THEN
CASE WHEN dn.nspname = c.table_schema THEN dt.typname
ELSE dn.nspname || '.' || dt.typname
END
WHEN dt.typtype = 'e' OR dt.typtype = 'c' THEN
CASE WHEN dn.nspname = c.table_schema THEN dt.typname
ELSE dn.nspname || '.' || dt.typname
END
WHEN dt.typtype = 'b' AND dt.typelem <> 0 THEN
-- Array types: apply same schema qualification logic to element type
CASE
WHEN en.nspname = 'pg_catalog' THEN et.typname || '[]'
WHEN en.nspname = c.table_schema THEN et.typname || '[]'
ELSE en.nspname || '.' || et.typname || '[]'
END
WHEN dt.typtype = 'b' THEN
-- Non-array base types: qualify if not in pg_catalog or table's schema
CASE
WHEN dn.nspname = 'pg_catalog' THEN c.udt_name
WHEN dn.nspname = c.table_schema THEN dt.typname
ELSE dn.nspname || '.' || dt.typname
END
ELSE c.udt_name
END AS resolved_type,
c.is_identity,
c.identity_generation,
c.identity_start,
c.identity_increment,
c.identity_maximum,
c.identity_minimum,
c.identity_cycle,
a.attgenerated,
ad.adbin,
ad.adrelid,
cl.oid AS table_oid
FROM information_schema.columns c
LEFT JOIN pg_namespace n ON n.nspname = c.table_schema
LEFT JOIN pg_class cl ON cl.relname = c.table_name AND cl.relnamespace = n.oid
LEFT JOIN pg_description d ON d.objoid = cl.oid AND d.classoid = 'pg_class'::regclass AND d.objsubid = c.ordinal_position
LEFT JOIN pg_attribute a ON a.attrelid = cl.oid AND a.attname = c.column_name
LEFT JOIN pg_attrdef ad ON ad.adrelid = a.attrelid AND ad.adnum = a.attnum
LEFT JOIN pg_type dt ON dt.oid = a.atttypid
LEFT JOIN pg_namespace dn ON dt.typnamespace = dn.oid
LEFT JOIN pg_type et ON dt.typelem = et.oid
LEFT JOIN pg_namespace en ON et.typnamespace = en.oid
WHERE
c.table_schema = $1
)
SELECT
c.table_schema,
c.table_name,
c.column_name,
c.ordinal_position,
cb.table_schema,
cb.table_name,
cb.column_name,
cb.ordinal_position,
CASE
WHEN a.attgenerated = 's' THEN NULL -- Generated columns don't have defaults
ELSE COALESCE(pg_get_expr(ad.adbin, ad.adrelid), c.column_default)
WHEN cb.attgenerated = 's' THEN NULL -- Generated columns don't have defaults
ELSE COALESCE(pg_get_expr(cb.adbin, cb.adrelid), cb.column_default)
END AS column_default,
c.is_nullable,
c.data_type,
c.character_maximum_length,
c.numeric_precision,
c.numeric_scale,
c.udt_name,
COALESCE(d.description, '') AS column_comment,
CASE
WHEN dt.typtype = 'd' THEN
CASE WHEN dn.nspname = c.table_schema THEN dt.typname
ELSE dn.nspname || '.' || dt.typname
END
WHEN dt.typtype = 'e' OR dt.typtype = 'c' THEN
CASE WHEN dn.nspname = c.table_schema THEN dt.typname
ELSE dn.nspname || '.' || dt.typname
END
WHEN dt.typtype = 'b' AND dt.typelem <> 0 THEN
-- Array types: apply same schema qualification logic to element type
CASE
WHEN en.nspname = 'pg_catalog' THEN et.typname || '[]'
WHEN en.nspname = c.table_schema THEN et.typname || '[]'
ELSE en.nspname || '.' || et.typname || '[]'
END
WHEN dt.typtype = 'b' THEN
-- Non-array base types: qualify if not in pg_catalog or table's schema
CASE
WHEN dn.nspname = 'pg_catalog' THEN c.udt_name
WHEN dn.nspname = c.table_schema THEN dt.typname
ELSE dn.nspname || '.' || dt.typname
END
ELSE c.udt_name
END AS resolved_type,
c.is_identity,
c.identity_generation,
c.identity_start,
c.identity_increment,
c.identity_maximum,
c.identity_minimum,
c.identity_cycle,
a.attgenerated,
CASE
WHEN a.attgenerated = 's' THEN pg_get_expr(ad.adbin, ad.adrelid)
ELSE NULL
END AS generated_expr
FROM information_schema.columns c
LEFT JOIN pg_namespace n ON n.nspname = c.table_schema
LEFT JOIN pg_class cl ON cl.relname = c.table_name AND cl.relnamespace = n.oid
LEFT JOIN pg_description d ON d.objoid = cl.oid AND d.classoid = 'pg_class'::regclass AND d.objsubid = c.ordinal_position
LEFT JOIN pg_attribute a ON a.attrelid = cl.oid AND a.attname = c.column_name
LEFT JOIN pg_attrdef ad ON ad.adrelid = a.attrelid AND ad.adnum = a.attnum
LEFT JOIN pg_type dt ON dt.oid = a.atttypid
LEFT JOIN pg_namespace dn ON dt.typnamespace = dn.oid
LEFT JOIN pg_type et ON dt.typelem = et.oid
LEFT JOIN pg_namespace en ON et.typnamespace = en.oid
WHERE
c.table_schema = $1
ORDER BY c.table_name, c.ordinal_position;
cb.is_nullable,
cb.data_type,
cb.character_maximum_length,
cb.numeric_precision,
cb.numeric_scale,
cb.udt_name,
cb.column_comment,
cb.resolved_type,
cb.is_identity,
cb.identity_generation,
cb.identity_start,
cb.identity_increment,
cb.identity_maximum,
cb.identity_minimum,
cb.identity_cycle,
cb.attgenerated,
-- Use LATERAL join to guarantee execution order:
-- 1. set_config sets search_path to only the table's schema
-- 2. pg_get_expr then uses that search_path
-- This ensures cross-schema function references in generated columns are qualified
--
-- NOTE: The 'dummy' column in the LATERAL subquery forces set_config to execute
-- before pg_get_expr. PostgreSQL evaluates SELECT columns left-to-right within
-- a single query level. The LATERAL join guarantees this happens row-by-row,
-- and 'true' in the WHERE clause ensures set_config is called for every row.
-- This pattern mirrors GetViewsForSchema (line 959-963) for consistency.
--
-- Alternative considered: Create a custom PostgreSQL function wrapping pg_get_expr
-- with search_path control. Rejected because:
-- 1. Requires creating database objects (function) on target database
-- 2. pgschema operates in read-only inspection mode
-- 3. LATERAL join pattern is PostgreSQL-native and well-documented
ge.generated_expr
FROM column_base cb
LEFT JOIN LATERAL (
SELECT
set_config('search_path', cb.table_schema || ', pg_catalog', true) as dummy,
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The search_path is constructed using string concatenation: cb.table_schema || ', pg_catalog'. While schema names from information_schema.columns are generally safe, PostgreSQL allows schema names with special characters, quotes, or commas. If a schema name contains a comma or other special characters, this could lead to unexpected behavior or potentially a security issue. Consider using proper quoting for the schema name, such as using quote_ident() or validating that the schema name doesn't contain problematic characters.

Suggested change
set_config('search_path', cb.table_schema || ', pg_catalog', true) as dummy,
set_config('search_path', format('%I, pg_catalog', cb.table_schema), true) as dummy,

Copilot uses AI. Check for mistakes.
CASE
WHEN cb.attgenerated = 's' THEN pg_get_expr(cb.adbin, cb.adrelid)
ELSE NULL
END as generated_expr
) ge ON true
ORDER BY cb.table_name, cb.ordinal_position;

-- GetConstraints retrieves all table constraints
-- name: GetConstraints :many
Expand Down
173 changes: 108 additions & 65 deletions ir/queries/queries.sql.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions testdata/dump/tenant/pgschema.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ CREATE TABLE IF NOT EXISTS users (
id SERIAL,
username varchar(100) NOT NULL,
email varchar(100) NOT NULL,
website varchar(255),
user_code text DEFAULT util.generate_id(),
domain text GENERATED ALWAYS AS (util.extract_domain((website)::text)) STORED,
role user_role DEFAULT 'user',
status status DEFAULT 'active',
created_at timestamp DEFAULT now(),
Expand Down
Loading