supabase/apps/studio/data/database/database-table-definition.ts

import minify from 'pg-minify'

// Derived from https://github.com/MichaelDBA/pg_get_tabledef
// NOTE: when updating, \n must be replaced with \\n in the SQL below
// public.x is replaced with pg_temp.x

// REMOVE (as it breaks the encoding for some reason):
// SELECT REPLACE(REPLACE(setting, '"$user"', '$user'), '$user', '"$user"') INTO search_path_old
// FROM pg_settings
// WHERE name = 'search_path';

export const CREATE_PG_GET_TABLEDEF_SQL = minify(
  /* SQL */ `
      DROP TYPE IF EXISTS pg_temp.tabledefs CASCADE;
      CREATE TYPE pg_temp.tabledefs AS ENUM ('PKEY_INTERNAL','PKEY_EXTERNAL','FKEYS_INTERNAL', 'FKEYS_EXTERNAL', 'COMMENTS', 'FKEYS_NONE', 'INCLUDE_TRIGGERS', 'NO_TRIGGERS');

      -- SELECT * FROM pg_temp.pg_get_coldef('sample','orders','id');
      -- DROP FUNCTION pg_temp.pg_get_coldef(text,text,text,boolean);
      CREATE OR REPLACE FUNCTION pg_temp.pg_get_coldef(
        in_schema text,
        in_table  text,
        in_column text,
        oldway    boolean default False
      )
      RETURNS text
      LANGUAGE plpgsql VOLATILE
      AS
      $$
      DECLARE
      v_coldef     text;
      v_dt1        text;
      v_dt2        text;
      v_dt3        text;
      v_nullable   boolean;
      v_position   int;
      v_identity   text;
      v_generated  text;
      v_hasdflt    boolean;
      v_dfltexpr   text;

      BEGIN
        IF oldway THEN
          SELECT pg_catalog.format_type(a.atttypid, a.atttypmod) INTO v_coldef FROM pg_namespace n, pg_class c, pg_attribute a, pg_type t
          WHERE n.nspname = in_schema AND n.oid = c.relnamespace AND c.relname = in_table AND a.attname = in_column and a.attnum > 0 AND a.attrelid = c.oid AND a.atttypid = t.oid ORDER BY a.attnum;
          -- RAISE NOTICE 'DEBUG: oldway=%',v_coldef;
        ELSE
          -- a.attrelid::regclass::text, a.attname
          SELECT CASE WHEN a.atttypid = ANY ('{int,int8,int2}'::regtype[]) AND EXISTS (SELECT FROM pg_attrdef ad WHERE ad.adrelid = a.attrelid AND ad.adnum   = a.attnum AND
          pg_get_expr(ad.adbin, ad.adrelid) = 'nextval(''' || (pg_get_serial_sequence (a.attrelid::regclass::text, a.attname))::regclass || '''::regclass)') THEN CASE a.atttypid
          WHEN 'int'::regtype  THEN 'serial' WHEN 'int8'::regtype THEN 'bigserial' WHEN 'int2'::regtype THEN 'smallserial' END ELSE format_type(a.atttypid, a.atttypmod) END AS data_type
          INTO v_coldef FROM pg_namespace n, pg_class c, pg_attribute a, pg_type t
          WHERE n.nspname = in_schema AND n.oid = c.relnamespace AND c.relname = in_table AND a.attname = in_column and a.attnum > 0 AND a.attrelid = c.oid AND a.atttypid = t.oid ORDER BY a.attnum;
          -- RAISE NOTICE 'DEBUG: newway=%',v_coldef;

          -- Issue#24: not implemented yet
          -- might replace with this below to do more detailed parsing...
          -- SELECT a.atttypid::regtype AS dt1, format_type(a.atttypid, a.atttypmod) as dt2, t.typname as dt3, CASE WHEN not(a.attnotnull) THEN True ELSE False END AS nullable,
          -- a.attnum, a.attidentity, a.attgenerated, a.atthasdef, pg_get_expr(ad.adbin, ad.adrelid) dfltexpr
          -- INTO v_dt1, v_dt2, v_dt3, v_nullable, v_position, v_identity, v_generated, v_hasdflt, v_dfltexpr
          -- FROM pg_attribute a JOIN pg_class c ON (a.attrelid = c.oid) JOIN pg_type t ON (a.atttypid = t.oid) LEFT JOIN pg_attrdef ad ON (a.attrelid = ad.adrelid AND a.attnum = ad.adnum)
          -- WHERE c.relkind in ('r','p') AND a.attnum > 0 AND NOT a.attisdropped AND c.relnamespace::regnamespace::text = in_schema AND c.relname = in_table AND a.attname = in_column;
          -- RAISE NOTICE 'schema=%  table=%  column=%  dt1=%  dt2=%  dt3=%  nullable=%  pos=%  identity=%   generated=%  HasDefault=%  DeftExpr=%', in_schema, in_table, in_column, v_dt1,v_dt2,v_dt3,v_nullable,v_position,v_identity,v_generated,v_hasdflt,v_dfltexpr;
        END IF;
        RETURN v_coldef;
      END;
      $$;

      -- SELECT * FROM pg_temp.pg_get_tabledef('sample', 'address', false);
      DROP FUNCTION IF EXISTS pg_temp.pg_get_tabledef(character varying,character varying,boolean,tabledefs[]);
      CREATE OR REPLACE FUNCTION pg_temp.pg_get_tabledef(
        in_schema varchar,
        in_table varchar,
        _verbose boolean,
        VARIADIC arr pg_temp.tabledefs[] DEFAULT '{}':: pg_temp.tabledefs[]
      )
      RETURNS text
      LANGUAGE plpgsql VOLATILE
      AS
      $$
        DECLARE
          v_qualified text := '';
          v_table_ddl text;
          v_table_oid int;
          v_colrec record;
          v_constraintrec record;
          v_trigrec       record;
          v_indexrec record;
          v_rec           record;
          v_constraint_name text;
          v_constraint_def  text;
          v_pkey_def        text := '';
          v_fkey_def        text := '';
          v_fkey_defs       text := '';
          v_trigger text := '';
          v_partition_key text := '';
          v_partbound text;
          v_parent text;
          v_parent_schema text;
          v_persist text;
          v_temp  text := '';
          v_temp2 text;
          v_relopts text;
          v_tablespace text;
          v_pgversion int;
          bSerial boolean;
          bPartition boolean;
          bInheritance boolean;
          bRelispartition boolean;
          constraintarr text[] := '{}';
          constraintelement text;
          bSkip boolean;
          bVerbose boolean := False;
          v_cnt1   integer;
          v_cnt2   integer;
          search_path_old text := '';
          search_path_new text := '';
          v_partial    boolean;
          v_pos        integer;

          -- assume defaults for ENUMs at the getgo
          pkcnt            int := 0;
          fkcnt            int := 0;
          trigcnt          int := 0;
          cmtcnt           int := 0;
          pktype           pg_temp.tabledefs := 'PKEY_INTERNAL';
          fktype           pg_temp.tabledefs := 'FKEYS_INTERNAL';
          trigtype         pg_temp.tabledefs := 'NO_TRIGGERS';
          arglen           integer;
          vargs            text;
          avarg            pg_temp.tabledefs;

          -- exception variables
          v_ret            text;
          v_diag1          text;
          v_diag2          text;
          v_diag3          text;
          v_diag4          text;
          v_diag5          text;
          v_diag6          text;

        BEGIN
          SET client_min_messages = 'notice';
          IF _verbose THEN bVerbose = True; END IF;

          -- v17 fix: handle case-sensitive
          -- v_qualified = in_schema || '.' || in_table;

          arglen := array_length($4, 1);
          IF arglen IS NULL THEN
              -- nothing to do, so assume defaults
              NULL;
          ELSE
              -- loop thru args
              -- IF 'NO_TRIGGERS' = ANY ($4)
              -- select array_to_string($4, ',', '***') INTO vargs;
              IF bVerbose THEN RAISE NOTICE 'arguments=%', $4; END IF;
              FOREACH avarg IN ARRAY $4 LOOP
                  IF bVerbose THEN RAISE NOTICE 'arg=%', avarg; END IF;
                  IF avarg = 'FKEYS_INTERNAL' OR avarg = 'FKEYS_EXTERNAL' OR avarg = 'FKEYS_NONE' THEN
                      fkcnt = fkcnt + 1;
                      fktype = avarg;
                  ELSEIF avarg = 'INCLUDE_TRIGGERS' OR avarg = 'NO_TRIGGERS' THEN
                      trigcnt = trigcnt + 1;
                      trigtype = avarg;
                  ELSEIF avarg = 'PKEY_EXTERNAL' THEN
                      pkcnt = pkcnt + 1;
                      pktype = avarg;
                  ELSEIF avarg = 'COMMENTS' THEN
                      cmtcnt = cmtcnt + 1;

                  END IF;
              END LOOP;
              IF fkcnt > 1 THEN
                  RAISE WARNING 'Only one foreign key option can be provided. You provided %', fkcnt;
                  RETURN '';
              ELSEIF trigcnt > 1 THEN
                  RAISE WARNING 'Only one trigger option can be provided. You provided %', trigcnt;
                  RETURN '';
              ELSEIF pkcnt > 1 THEN
                  RAISE WARNING 'Only one pkey option can be provided. You provided %', pkcnt;
                  RETURN '';
              ELSEIF cmtcnt > 1 THEN
                  RAISE WARNING 'Only one comments option can be provided. You provided %', cmtcnt;
                  RETURN '';

              END IF;
          END IF;

          SELECT c.oid, (select setting from pg_settings where name = 'server_version_num') INTO v_table_oid, v_pgversion FROM pg_catalog.pg_class c LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
          WHERE c.relkind in ('r','p') AND c.relname = in_table AND n.nspname = in_schema;

        -- set search_path = public before we do anything to force explicit schema qualification but dont forget to set it back before exiting...
          SELECT setting INTO search_path_old FROM pg_settings WHERE name = 'search_path';

          -- RAISE NOTICE 'DEBUG tableddl: saving old search_path: ***%***', search_path_old;
          EXECUTE 'SET search_path = "public"';
          SELECT setting INTO search_path_new FROM pg_settings WHERE name = 'search_path';
          -- RAISE NOTICE 'DEBUG tableddl: using new search path=***%***', search_path_new;

          -- throw an error if table was not found
          IF (v_table_oid IS NULL) THEN
            RAISE EXCEPTION 'table does not exist';
          END IF;

          -- get user-defined tablespaces if applicable
          SELECT tablespace INTO v_temp FROM pg_tables WHERE schemaname = in_schema and tablename = in_table and tablespace IS NOT NULL;
          IF v_temp IS NULL THEN
            v_tablespace := 'TABLESPACE pg_default';
          ELSE
            v_tablespace := 'TABLESPACE ' || v_temp;
          END IF;

          -- also see if there are any SET commands for this table, ie, autovacuum_enabled=off, fillfactor=70
          WITH relopts AS (SELECT unnest(c.reloptions) relopts FROM pg_class c, pg_namespace n WHERE n.nspname = in_schema and n.oid = c.relnamespace and c.relname = in_table)
          SELECT string_agg(r.relopts, ', ') as relopts INTO v_temp from relopts r;
          IF v_temp IS NULL THEN
            v_relopts := '';
          ELSE
            v_relopts := ' WITH (' || v_temp || ')';
          END IF;

          -- -----------------------------------------------------------------------------------
          -- Create table defs for partitions/children using inheritance or declarative methods.
          -- inheritance: pg_class.relkind = 'r'   pg_class.relispartition=false   pg_class.relpartbound is NULL
          -- declarative: pg_class.relkind = 'r'   pg_class.relispartition=true    pg_class.relpartbound is NOT NULL
          -- -----------------------------------------------------------------------------------
          v_partbound := '';
          bPartition := False;
          bInheritance := False;
          IF v_pgversion < 100000 THEN
            -- Issue#11: handle parent schema
            SELECT c2.relname parent, c2.relnamespace::regnamespace INTO v_parent, v_parent_schema from pg_class c1, pg_namespace n, pg_inherits i, pg_class c2
            WHERE n.nspname = in_schema and n.oid = c1.relnamespace and c1.relname = in_table and c1.oid = i.inhrelid and i.inhparent = c2.oid and c1.relkind = 'r';
            IF (v_parent IS NOT NULL) THEN
              bPartition   := True;
              bInheritance := True;
            END IF;
          ELSE
            -- Issue#11: handle parent schema
            SELECT c2.relname parent, c1.relispartition, pg_get_expr(c1.relpartbound, c1.oid, true), c2.relnamespace::regnamespace INTO v_parent, bRelispartition, v_partbound, v_parent_schema from pg_class c1, pg_namespace n, pg_inherits i, pg_class c2
            WHERE n.nspname = in_schema and n.oid = c1.relnamespace and c1.relname = in_table and c1.oid = i.inhrelid and i.inhparent = c2.oid and c1.relkind = 'r';
            IF (v_parent IS NOT NULL) THEN
              bPartition   := True;
              IF bRelispartition THEN
                bInheritance := False;
              ELSE
                bInheritance := True;
              END IF;
            END IF;
          END IF;
          IF bPartition THEN
            --Issue#17 fix for case-sensitive tables
            -- SELECT count(*) INTO v_cnt1 FROM information_schema.tables t WHERE EXISTS (SELECT REGEXP_MATCHES(s.table_name, '([A-Z]+)','g') FROM information_schema.tables s
            -- WHERE t.table_schema=s.table_schema AND t.table_name=s.table_name AND t.table_schema = quote_ident(in_schema) AND t.table_name = quote_ident(in_table) AND t.table_type = 'BASE TABLE');
            SELECT count(*) INTO v_cnt1 FROM information_schema.tables t WHERE EXISTS (SELECT REGEXP_MATCHES(s.table_name, '([A-Z]+)','g') FROM information_schema.tables s
            WHERE t.table_schema=s.table_schema AND t.table_name=s.table_name AND t.table_schema = in_schema AND t.table_name = in_table AND t.table_type = 'BASE TABLE');

            --Issue#19 put double-quotes around SQL keyword column names
            -- Issue#121: fix keyword lookup for table name not column name that does not apply here
            -- SELECT COUNT(*) INTO v_cnt2 FROM pg_get_keywords() WHERE word = v_colrec.column_name AND catcode = 'R';
            SELECT COUNT(*) INTO v_cnt2 FROM pg_get_keywords() WHERE word = in_table AND catcode = 'R';

            IF bInheritance THEN
              -- inheritance-based
              IF v_cnt1 > 0 OR v_cnt2 > 0 THEN
                v_table_ddl := 'CREATE TABLE ' || in_schema || '."' || in_table || '"( '|| E'\\n';
              ELSE
                v_table_ddl := 'CREATE TABLE ' || in_schema || '.' || in_table || '( '|| E'\\n';
              END IF;

              -- Jump to constraints section to add the check constraints
            ELSE
              -- declarative-based
              IF v_relopts <> '' THEN
                IF v_cnt1 > 0 OR v_cnt2 > 0 THEN
                  v_table_ddl := 'CREATE TABLE ' || in_schema || '."' || in_table || '" PARTITION OF ' || in_schema || '.' || v_parent || ' ' || v_partbound || v_relopts || ' ' || v_tablespace || '; ' || E'\\n';
                ELSE
                  v_table_ddl := 'CREATE TABLE ' || in_schema || '.' || in_table || ' PARTITION OF ' || in_schema || '.' || v_parent || ' ' || v_partbound || v_relopts || ' ' || v_tablespace || '; ' || E'\\n';
                END IF;
              ELSE
                IF v_cnt1 > 0 OR v_cnt2 > 0 THEN
                  v_table_ddl := 'CREATE TABLE ' || in_schema || '."' || in_table || '" PARTITION OF ' || in_schema || '.' || v_parent || ' ' || v_partbound || ' ' || v_tablespace || '; ' || E'\\n';
                ELSE
                  v_table_ddl := 'CREATE TABLE ' || in_schema || '.' || in_table || ' PARTITION OF ' || in_schema || '.' || v_parent || ' ' || v_partbound || ' ' || v_tablespace || '; ' || E'\\n';
                END IF;
              END IF;
              -- Jump to constraints and index section to add the check constraints and indexes and perhaps FKeys
            END IF;
          END IF;
          IF bVerbose THEN RAISE NOTICE '(1)tabledef so far: %', v_table_ddl; END IF;

          IF NOT bPartition THEN
            -- see if this is unlogged or temporary table
            select c.relpersistence into v_persist from pg_class c, pg_namespace n where n.nspname = in_schema and n.oid = c.relnamespace and c.relname = in_table and c.relkind = 'r';
            IF v_persist = 'u' THEN
              v_temp := 'UNLOGGED';
            ELSIF v_persist = 't' THEN
              v_temp := 'TEMPORARY';
            ELSE
              v_temp := '';
            END IF;
          END IF;

          -- start the create definition for regular tables unless we are in progress creating an inheritance-based child table
          IF NOT bPartition THEN
            --Issue#17 fix for case-sensitive tables
            -- SELECT count(*) INTO v_cnt1 FROM information_schema.tables t WHERE EXISTS (SELECT REGEXP_MATCHES(s.table_name, '([A-Z]+)','g') FROM information_schema.tables s
            -- WHERE t.table_schema=s.table_schema AND t.table_name=s.table_name AND t.table_schema = quote_ident(in_schema) AND t.table_name = quote_ident(in_table) AND t.table_type = 'BASE TABLE');
            SELECT count(*) INTO v_cnt1 FROM information_schema.tables t WHERE EXISTS (SELECT REGEXP_MATCHES(s.table_name, '([A-Z]+)','g') FROM information_schema.tables s
            WHERE t.table_schema=s.table_schema AND t.table_name=s.table_name AND t.table_schema = in_schema AND t.table_name = in_table AND t.table_type = 'BASE TABLE');
            IF v_cnt1 > 0 THEN
              v_table_ddl := 'CREATE ' || v_temp || ' TABLE ' || in_schema || '."' || in_table || '" (' || E'\\n';
            ELSE
              v_table_ddl := 'CREATE ' || v_temp || ' TABLE ' || in_schema || '.' || in_table || ' (' || E'\\n';
            END IF;
          END IF;
          -- RAISE NOTICE 'DEBUG2: tabledef so far: %', v_table_ddl;
          -- define all of the columns in the table unless we are in progress creating an inheritance-based child table
          IF NOT bPartition THEN
            FOR v_colrec IN
              SELECT c.column_name, c.data_type, c.udt_name, c.udt_schema, c.character_maximum_length, c.is_nullable, c.column_default, c.numeric_precision, c.numeric_scale, c.is_identity, c.identity_generation, c.is_generated, c.generation_expression
              FROM information_schema.columns c WHERE (table_schema, table_name) = (in_schema, in_table) ORDER BY ordinal_position
            LOOP
              IF bVerbose THEN RAISE NOTICE '(col loop) name=%  type=%  udt_name=%  default=%  is_generated=%  gen_expr=%', v_colrec.column_name, v_colrec.data_type, v_colrec.udt_name, v_colrec.column_default, v_colrec.is_generated, v_colrec.generation_expression; END IF;

              -- v17 fix: handle case-sensitive for pg_get_serial_sequence that requires SQL Identifier handling
              -- SELECT CASE WHEN pg_get_serial_sequence(v_qualified, v_colrec.column_name) IS NOT NULL THEN True ELSE False END into bSerial;
              SELECT CASE WHEN pg_get_serial_sequence(quote_ident(in_schema) || '.' || quote_ident(in_table), v_colrec.column_name) IS NOT NULL THEN True ELSE False END into bSerial;
              IF bVerbose THEN
                -- v17 fix: handle case-sensitive for pg_get_serial_sequence that requires SQL Identifier handling
                -- SELECT pg_get_serial_sequence(v_qualified, v_colrec.column_name) into v_temp;
                SELECT pg_get_serial_sequence(quote_ident(in_schema) || '.' || quote_ident(in_table), v_colrec.column_name) into v_temp;
                IF v_temp IS NULL THEN v_temp = 'NA'; END IF;
                SELECT pg_temp.pg_get_coldef(in_schema, in_table,v_colrec.column_name) INTO v_diag1;
                RAISE NOTICE 'DEBUG table: %  Column: %  datatype: %  Serial=%  serialval=%  coldef=%', v_qualified, v_colrec.column_name, v_colrec.data_type, bSerial, v_temp, v_diag1;
                RAISE NOTICE 'DEBUG tabledef: %', v_table_ddl;
              END IF;

              --Issue#17 put double-quotes around case-sensitive column names
              SELECT COUNT(*) INTO v_cnt1 FROM information_schema.columns t WHERE EXISTS (SELECT REGEXP_MATCHES(s.column_name, '([A-Z]+)','g') FROM information_schema.columns s
              WHERE t.table_schema=s.table_schema and t.table_name=s.table_name and t.column_name=s.column_name AND t.table_schema = quote_ident(in_schema) AND column_name = v_colrec.column_name);

              --Issue#19 put double-quotes around SQL keyword column names
              SELECT COUNT(*) INTO v_cnt2 FROM pg_get_keywords() WHERE word = v_colrec.column_name AND catcode = 'R';

              IF v_cnt1 > 0 OR v_cnt2 > 0 THEN
                v_table_ddl := v_table_ddl || '  "' || v_colrec.column_name || '" ';
              ELSE
                v_table_ddl := v_table_ddl || '  ' || v_colrec.column_name || ' ';
              END IF;

              -- Issue#23: Handle autogenerated columns and rewrite as a simpler IF THEN ELSE branch instead of a much more complex embedded CASE STATEMENT
              IF v_colrec.is_generated = 'ALWAYS' and v_colrec.generation_expression IS NOT NULL THEN
                  -- searchable tsvector GENERATED ALWAYS AS (to_tsvector('simple'::regconfig, COALESCE(translate(email, '@.-'::citext, ' '::text), ''::text)) ) STORED
                  v_temp = v_colrec.data_type || ' GENERATED ALWAYS AS (' || v_colrec.generation_expression || ') STORED ';
              ELSEIF v_colrec.udt_name in ('geometry', 'box2d', 'box2df', 'box3d', 'geography', 'geometry_dump', 'gidx', 'spheroid', 'valid_detail') THEN
                  v_temp = v_colrec.udt_name;
              ELSEIF v_colrec.data_type = 'USER-DEFINED' THEN
                  v_temp = v_colrec.udt_schema || '.' || v_colrec.udt_name;
              ELSEIF v_colrec.data_type = 'ARRAY' THEN
                    -- Issue#6 fix: handle arrays
                  v_temp = pg_temp.pg_get_coldef(in_schema, in_table,v_colrec.column_name);
                  -- v17 fix: handle case-sensitive for pg_get_serial_sequence that requires SQL Identifier handling
                  -- WHEN pg_get_serial_sequence(v_qualified, v_colrec.column_name) IS NOT NULL
              ELSEIF pg_get_serial_sequence(quote_ident(in_schema) || '.' || quote_ident(in_table), v_colrec.column_name) IS NOT NULL THEN
                  -- Issue#8 fix: handle serial. Note: NOT NULL is implied so no need to declare it explicitly
                  v_temp = pg_temp.pg_get_coldef(in_schema, in_table,v_colrec.column_name);
              ELSE
                  v_temp = v_colrec.data_type;
              END IF;
              -- RAISE NOTICE 'column def1=%', v_temp;

              -- handle IDENTITY columns
              IF v_colrec.is_identity = 'YES' THEN
                  IF v_colrec.identity_generation = 'ALWAYS' THEN
                      v_temp = v_temp || ' GENERATED ALWAYS AS IDENTITY';
                  ELSE
                      v_temp = v_temp || ' GENERATED BY DEFAULT AS IDENTITY';
                  END IF;
              ELSEIF v_colrec.character_maximum_length IS NOT NULL THEN
                  v_temp = v_temp || ('(' || v_colrec.character_maximum_length || ')');
              ELSEIF v_colrec.numeric_precision > 0 AND v_colrec.numeric_scale > 0 THEN
                  v_temp = v_temp || '(' || v_colrec.numeric_precision || ',' || v_colrec.numeric_scale || ')';
              END IF;

              -- Handle NULL/NOT NULL
              IF bSerial THEN
                  v_temp = v_temp || ' NOT NULL';
              ELSEIF v_colrec.is_nullable = 'NO' THEN
                  v_temp = v_temp || ' NOT NULL';
              ELSEIF v_colrec.is_nullable = 'YES' THEN
                  v_temp = v_temp || ' NULL';
              END IF;

              -- Handle defaults
              IF v_colrec.column_default IS NOT null AND NOT bSerial THEN
                  -- RAISE NOTICE 'Setting default for column, %', v_colrec.column_name;
                  v_temp = v_temp || (' DEFAULT ' || v_colrec.column_default);
              END IF;
              v_temp = v_temp || ',' || E'\\n';
              -- RAISE NOTICE 'column def2=%', v_temp;
              v_table_ddl := v_table_ddl || v_temp;
              -- RAISE NOTICE 'tabledef=%', v_table_ddl;

            END LOOP;
          END IF;
          IF bVerbose THEN RAISE NOTICE '(2)tabledef so far: %', v_table_ddl; END IF;

          -- define all the constraints: conparentid does not exist pre PGv11
          IF v_pgversion < 110000 THEN
            FOR v_constraintrec IN
              SELECT con.conname as constraint_name, con.contype as constraint_type,
                CASE
                  WHEN con.contype = 'p' THEN 1 -- primary key constraint
                  WHEN con.contype = 'u' THEN 2 -- unique constraint
                  WHEN con.contype = 'f' THEN 3 -- foreign key constraint
                  WHEN con.contype = 'c' THEN 4
                  ELSE 5
                END as type_rank,
                pg_get_constraintdef(con.oid) as constraint_definition
              FROM pg_catalog.pg_constraint con JOIN pg_catalog.pg_class rel ON rel.oid = con.conrelid JOIN pg_catalog.pg_namespace nsp ON nsp.oid = connamespace
              WHERE nsp.nspname = in_schema AND rel.relname = in_table ORDER BY type_rank
            LOOP
              v_constraint_name := v_constraintrec.constraint_name;
              v_constraint_def  := v_constraintrec.constraint_definition;
              IF v_constraintrec.type_rank = 1 THEN
                  IF pkcnt = 0 OR pktype = 'PKEY_INTERNAL' THEN
                      -- internal def
                      v_constraint_name := v_constraintrec.constraint_name;
                      v_constraint_def  := v_constraintrec.constraint_definition;
                      v_table_ddl := v_table_ddl || '  ' -- note: two char spacer to start, to indent the column
                        || 'CONSTRAINT' || ' '
                        || v_constraint_name || ' '
                        || v_constraint_def
                        || ',' || E'\\n';
                  ELSE
                    -- Issue#16 handle external PG def
                    SELECT 'ALTER TABLE ONLY ' || in_schema || '.' || c.relname || ' ADD CONSTRAINT ' || r.conname || ' ' || pg_catalog.pg_get_constraintdef(r.oid, true) || ';' INTO v_pkey_def
                    FROM pg_catalog.pg_constraint r, pg_class c, pg_namespace n where r.conrelid = c.oid and  r.contype = 'p' and n.oid = r.connamespace and n.nspname = in_schema AND c.relname = in_table and r.conname = v_constraint_name;
                  END IF;
                  IF bPartition THEN
                    continue;
                  END IF;
              ELSIF v_constraintrec.type_rank = 3 THEN
                  -- handle foreign key constraints
                  --Issue#22 fix: added FKEY_NONE check
                  IF fktype = 'FKEYS_NONE' THEN
                      -- skip
                      continue;
                  ELSIF fkcnt = 0 OR fktype = 'FKEYS_INTERNAL' THEN
                      -- internal def
                      v_table_ddl := v_table_ddl || '  ' -- note: two char spacer to start, to indent the column
                        || 'CONSTRAINT' || ' '
                        || v_constraint_name || ' '
                        || v_constraint_def
                        || ',' || E'\\n';
                  ELSE
                      -- external def
                      SELECT 'ALTER TABLE ONLY ' || n.nspname || '.' || c2.relname || ' ADD CONSTRAINT ' || r.conname || ' ' || pg_catalog.pg_get_constraintdef(r.oid, true) || ';' INTO v_fkey_def
                      FROM pg_constraint r, pg_class c1, pg_namespace n, pg_class c2 where r.conrelid = c1.oid and  r.contype = 'f' and n.nspname = in_schema and n.oid = r.connamespace and r.conrelid = c2.oid and c2.relname = in_table;
                      v_fkey_defs = v_fkey_defs || v_fkey_def || E'\\n';
                  END IF;
              ELSE
                  -- handle all other constraints besides PKEY and FKEYS as internal defs by default
                  v_table_ddl := v_table_ddl || '  ' -- note: two char spacer to start, to indent the column
                    || 'CONSTRAINT' || ' '
                    || v_constraint_name || ' '
                    || v_constraint_def
                    || ',' || E'\\n';
              END IF;
              if bVerbose THEN RAISE NOTICE 'DEBUG4: constraint name=% constraint_def=%', v_constraint_name,v_constraint_def; END IF;
              constraintarr := constraintarr || v_constraintrec.constraint_name:: text;

            END LOOP;
          ELSE
            -- handle PG versions 11 and up
            -- Issue#20: Fix logic for external PKEY and FKEYS
            FOR v_constraintrec IN
              SELECT con.conname as constraint_name, con.contype as constraint_type,
                CASE
                  WHEN con.contype = 'p' THEN 1 -- primary key constraint
                  WHEN con.contype = 'u' THEN 2 -- unique constraint
                  WHEN con.contype = 'f' THEN 3 -- foreign key constraint
                  WHEN con.contype = 'c' THEN 4
                  ELSE 5
                END as type_rank,
                pg_get_constraintdef(con.oid) as constraint_definition
              FROM pg_catalog.pg_constraint con JOIN pg_catalog.pg_class rel ON rel.oid = con.conrelid JOIN pg_catalog.pg_namespace nsp ON nsp.oid = connamespace
              WHERE nsp.nspname = in_schema AND rel.relname = in_table
                    --Issue#13 added this condition:
                    AND con.conparentid = 0
                    ORDER BY type_rank
            LOOP
              v_constraint_name := v_constraintrec.constraint_name;
              v_constraint_def  := v_constraintrec.constraint_definition;
              IF v_constraintrec.type_rank = 1 THEN
                  IF pkcnt = 0 OR pktype = 'PKEY_INTERNAL' THEN
                      -- internal def
                      v_constraint_name := v_constraintrec.constraint_name;
                      v_constraint_def  := v_constraintrec.constraint_definition;
                      v_table_ddl := v_table_ddl || '  ' -- note: two char spacer to start, to indent the column
                        || 'CONSTRAINT' || ' '
                        || v_constraint_name || ' '
                        || v_constraint_def
                        || ',' || E'\\n';
                  ELSE
                    -- Issue#16 handle external PG def
                    SELECT 'ALTER TABLE ONLY ' || in_schema || '.' || c.relname || ' ADD CONSTRAINT ' || r.conname || ' ' || pg_catalog.pg_get_constraintdef(r.oid, true) || ';' INTO v_pkey_def
                    FROM pg_catalog.pg_constraint r, pg_class c, pg_namespace n where r.conrelid = c.oid and  r.contype = 'p' and n.oid = r.connamespace and n.nspname = in_schema AND c.relname = in_table;
                  END IF;
                  IF bPartition THEN
                    continue;
                  END IF;
              ELSIF v_constraintrec.type_rank = 3 THEN
                  -- handle foreign key constraints
                  --Issue#22 fix: added FKEY_NONE check
                  IF fktype = 'FKEYS_NONE' THEN
                      -- skip
                      continue;
                  ELSIF fkcnt = 0 OR fktype = 'FKEYS_INTERNAL' THEN
                      -- internal def
                      v_table_ddl := v_table_ddl || '  ' -- note: two char spacer to start, to indent the column
                        || 'CONSTRAINT' || ' '
                        || v_constraint_name || ' '
                        || v_constraint_def
                        || ',' || E'\\n';
                  ELSE
                      -- external def
                      SELECT 'ALTER TABLE ONLY ' || n.nspname || '.' || c2.relname || ' ADD CONSTRAINT ' || r.conname || ' ' || pg_catalog.pg_get_constraintdef(r.oid, true) || ';' INTO v_fkey_def
                      FROM pg_constraint r, pg_class c1, pg_namespace n, pg_class c2 where r.conrelid = c1.oid and  r.contype = 'f' and n.nspname = in_schema and n.oid = r.connamespace and r.conrelid = c2.oid and c2.relname = in_table and
                      r.conname = v_constraint_name and r.conparentid = 0;
                      v_fkey_defs = v_fkey_defs || v_fkey_def || E'\\n';
                  END IF;
              ELSE
                  -- handle all other constraints besides PKEY and FKEYS as internal defs by default
                  v_table_ddl := v_table_ddl || '  ' -- note: two char spacer to start, to indent the column
                    || 'CONSTRAINT' || ' '
                    || v_constraint_name || ' '
                    || v_constraint_def
                    || ',' || E'\\n';
              END IF;
              if bVerbose THEN RAISE NOTICE 'DEBUG4: constraint name=% constraint_def=%', v_constraint_name,v_constraint_def; END IF;
              constraintarr := constraintarr || v_constraintrec.constraint_name:: text;

            END LOOP;
          END IF;

          -- drop the last comma before ending the create statement, which should be right before the carriage return character
          -- Issue#24: make sure the comma is there before removing it
          select substring(v_table_ddl, length(v_table_ddl) - 1, 1) INTO v_temp;
          IF v_temp = ',' THEN
              v_table_ddl = substr(v_table_ddl, 0, length(v_table_ddl) - 1) || E'\\n';
          END IF;
          IF bVerbose THEN RAISE NOTICE '(3)tabledef so far: %', trim(v_table_ddl); END IF;

          -- ---------------------------------------------------------------------------
          -- at this point we have everything up to the last table-enclosing parenthesis
          -- ---------------------------------------------------------------------------
          IF bVerbose THEN RAISE NOTICE '(4)tabledef so far: %', v_table_ddl; END IF;

          -- See if this is an inheritance-based child table and finish up the table create.
          IF bPartition and bInheritance THEN
            -- Issue#11: handle parent schema
            -- v_table_ddl := v_table_ddl || ') INHERITS (' || in_schema || '.' || v_parent || ') ' || E'\\n' || v_relopts || ' ' || v_tablespace || ';' || E'\\n';
            IF v_parent_schema = '' OR v_parent_schema IS NULL THEN v_parent_schema = in_schema; END IF;
            v_table_ddl := v_table_ddl || ') INHERITS (' || v_parent_schema || '.' || v_parent || ') ' || E'\\n' || v_relopts || ' ' || v_tablespace || ';' || E'\\n';
          END IF;

          IF v_pgversion >= 100000 AND NOT bPartition and NOT bInheritance THEN
            -- See if this is a partitioned table (pg_class.relkind = 'p') and add the partitioned key
            SELECT pg_get_partkeydef(c1.oid) as partition_key INTO v_partition_key FROM pg_class c1 JOIN pg_namespace n ON (n.oid = c1.relnamespace) LEFT JOIN pg_partitioned_table p ON (c1.oid = p.partrelid)
            WHERE n.nspname = in_schema and n.oid = c1.relnamespace and c1.relname = in_table and c1.relkind = 'p';

            IF v_partition_key IS NOT NULL AND v_partition_key <> '' THEN
              -- add partition clause
              -- NOTE:  cannot specify default tablespace for partitioned relations
              -- v_table_ddl := v_table_ddl || ') PARTITION BY ' || v_partition_key || ' ' || v_tablespace || ';' || E'\\n';
              v_table_ddl := v_table_ddl || ') PARTITION BY ' || v_partition_key || ';' || E'\\n';
            ELSEIF v_relopts <> '' THEN
              v_table_ddl := v_table_ddl || ') ' || v_relopts || ' ' || v_tablespace || ';' || E'\\n';
            ELSE
              -- end the create definition
              v_table_ddl := v_table_ddl || ') ' || v_tablespace || ';' || E'\\n';
            END IF;
          END IF;

          IF bVerbose THEN RAISE NOTICE '(5)tabledef so far: %', v_table_ddl; END IF;

          -- Add closing paren for regular tables
          -- IF NOT bPartition THEN
          -- v_table_ddl := v_table_ddl || ') ' || v_relopts || ' ' || v_tablespace || E';\\n';
          -- END IF;
          -- RAISE NOTICE 'ddlsofar3: %', v_table_ddl;

          -- Issue#16 create the external PKEY def if indicated
          IF v_pkey_def <> '' THEN
              v_table_ddl := v_table_ddl || v_pkey_def || E'\\n';
          END IF;

          -- Issue#20
          IF v_fkey_defs <> '' THEN
                v_table_ddl := v_table_ddl || v_fkey_defs || E'\\n';
          END IF;

          IF bVerbose THEN RAISE NOTICE '(6)tabledef so far: %', v_table_ddl; END IF;

          -- create indexes
          FOR v_indexrec IN
            SELECT indexdef, COALESCE(tablespace, 'pg_default') as tablespace, indexname FROM pg_indexes WHERE (schemaname, tablename) = (in_schema, in_table)
          LOOP
            -- RAISE NOTICE 'DEBUG6: indexname=%  indexdef=%', v_indexrec.indexname, v_indexrec.indexdef;
            -- loop through constraints and skip ones already defined
            bSkip = False;
            FOREACH constraintelement IN ARRAY constraintarr
            LOOP
              IF constraintelement = v_indexrec.indexname THEN
                  -- RAISE NOTICE 'DEBUG7: skipping index, %', v_indexrec.indexname;
                  bSkip = True;
                  EXIT;
              END IF;
            END LOOP;
            if bSkip THEN CONTINUE; END IF;

            -- Add IF NOT EXISTS clause so partition index additions will not be created if declarative partition in effect and index already created on parent
            v_indexrec.indexdef := REPLACE(v_indexrec.indexdef, 'CREATE INDEX', 'CREATE INDEX IF NOT EXISTS');
            -- Fix Issue#26: do it for unique/primary key indexes as well
            v_indexrec.indexdef := REPLACE(v_indexrec.indexdef, 'CREATE UNIQUE INDEX', 'CREATE UNIQUE INDEX IF NOT EXISTS');
            -- RAISE NOTICE 'DEBUG8: adding index, %', v_indexrec.indexname;

            -- NOTE:  cannot specify default tablespace for partitioned relations
            IF v_partition_key IS NOT NULL AND v_partition_key <> '' THEN
                v_table_ddl := v_table_ddl || v_indexrec.indexdef || ';' || E'\\n';
            ELSE
                -- Issue#25: see if partial index or not
                select CASE WHEN i.indpred IS NOT NULL THEN True ELSE False END INTO v_partial
                FROM pg_index i JOIN pg_class c1 ON (i.indexrelid = c1.oid) JOIN pg_class c2 ON (i.indrelid = c2.oid)
                WHERE c1.relnamespace::regnamespace::text = in_schema AND c2.relnamespace::regnamespace::text = in_schema AND c2.relname = in_table AND c1.relname = v_indexrec.indexname;
                IF v_partial THEN
                    -- Put tablespace def before WHERE CLAUSE
                    v_temp = v_indexrec.indexdef;
                    v_pos = POSITION(' WHERE ' IN v_temp);
                    v_temp2 = SUBSTRING(v_temp, v_pos);
                    v_temp  = SUBSTRING(v_temp, 1, v_pos);
                    v_table_ddl := v_table_ddl || v_temp || ' TABLESPACE ' || v_indexrec.tablespace || v_temp2 || ';' || E'\\n';
                ELSE
                    v_table_ddl := v_table_ddl || v_indexrec.indexdef || ' TABLESPACE ' || v_indexrec.tablespace || ';' || E'\\n';
                END IF;
            END IF;

          END LOOP;
          IF bVerbose THEN RAISE NOTICE '(7)tabledef so far: %', v_table_ddl; END IF;

          -- Issue#20: added logic for table and column comments
          IF  cmtcnt > 0 THEN
              FOR v_rec IN
                SELECT c.relname, 'COMMENT ON ' || CASE WHEN c.relkind in ('r','p') AND a.attname IS NULL THEN 'TABLE ' WHEN c.relkind in ('r','p') AND a.attname IS NOT NULL THEN 'COLUMN ' WHEN c.relkind = 'f' THEN 'FOREIGN TABLE '
                      WHEN c.relkind = 'm' THEN 'MATERIALIZED VIEW ' WHEN c.relkind = 'v' THEN 'VIEW ' WHEN c.relkind = 'i' THEN 'INDEX ' WHEN c.relkind = 'S' THEN 'SEQUENCE ' ELSE 'XX' END || n.nspname || '.' ||
                      CASE WHEN c.relkind in ('r','p') AND a.attname IS NOT NULL THEN quote_ident(c.relname) || '.' || a.attname ELSE quote_ident(c.relname) END || ' IS '   || quote_literal(d.description) || ';' as ddl
                FROM pg_class c JOIN pg_namespace n ON (n.oid = c.relnamespace) LEFT JOIN pg_description d ON (c.oid = d.objoid) LEFT JOIN pg_attribute a ON (c.oid = a.attrelid AND a.attnum > 0 and a.attnum = d.objsubid)
                WHERE d.description IS NOT NULL AND n.nspname = in_schema AND c.relname = in_table ORDER BY 2 desc, ddl
              LOOP
                  --RAISE NOTICE 'comments:%', v_rec.ddl;
                  v_table_ddl = v_table_ddl || v_rec.ddl || E'\\n';
              END LOOP;
          END IF;
          IF bVerbose THEN RAISE NOTICE '(8)tabledef so far: %', v_table_ddl; END IF;

          IF trigtype = 'INCLUDE_TRIGGERS' THEN
            -- Issue#14: handle multiple triggers for a table
            FOR v_trigrec IN
                select pg_get_triggerdef(t.oid, True) || ';' as triggerdef FROM pg_trigger t, pg_class c, pg_namespace n
                WHERE n.nspname = in_schema and n.oid = c.relnamespace and c.relname = in_table and c.relkind = 'r' and t.tgrelid = c.oid and NOT t.tgisinternal
            LOOP
                v_table_ddl := v_table_ddl || v_trigrec.triggerdef;
                v_table_ddl := v_table_ddl || E'\\n';
                IF bVerbose THEN RAISE NOTICE 'triggerdef = %', v_trigrec.triggerdef; END IF;
            END LOOP;
          END IF;

          IF bVerbose THEN RAISE NOTICE '(9)tabledef so far: %', v_table_ddl; END IF;
          -- add empty line
          v_table_ddl := v_table_ddl || E'\\n';
          IF bVerbose THEN RAISE NOTICE '(10)tabledef so far: %', v_table_ddl; END IF;

          -- reset search_path back to what it was
          IF search_path_old = '' THEN
            SELECT set_config('search_path', '', false) into v_temp;
          ELSE
            EXECUTE 'SET search_path = ' || search_path_old;
          END IF;

          RETURN v_table_ddl;

          EXCEPTION
          WHEN others THEN
          BEGIN
            GET STACKED DIAGNOSTICS v_diag1 = MESSAGE_TEXT, v_diag2 = PG_EXCEPTION_DETAIL, v_diag3 = PG_EXCEPTION_HINT, v_diag4 = RETURNED_SQLSTATE, v_diag5 = PG_CONTEXT, v_diag6 = PG_EXCEPTION_CONTEXT;
            -- v_ret := 'line=' || v_diag6 || '. '|| v_diag4 || '. ' || v_diag1 || ' .' || v_diag2 || ' .' || v_diag3;
            v_ret := 'line=' || v_diag6 || '. '|| v_diag4 || '. ' || v_diag1;
            RAISE EXCEPTION '%', v_ret;
            -- put additional coding here if necessarY
            RETURN '';
          END;

        END;
      $$;`,
  { compress: true, removeAll: true }
)