@supabase/pg-delta 0.0.0 → 1.0.0-alpha.0

package/dist/core/objects/table/table.model.d.ts

@@ -0,0 +1,341 @@
+import type { Sql } from "postgres";
+import z from "zod";
+import { BasePgModel, type TableLikeObject } from "../base.model.ts";
+import { type PrivilegeProps } from "../base.privilege-diff.ts";
+export declare const ReplicaIdentitySchema: z.ZodEnum<{
+    n: "n";
+    i: "i";
+    d: "d";
+    f: "f";
+}>;
+declare const tableConstraintPropsSchema: z.ZodObject<{
+    name: z.ZodString;
+    constraint_type: z.ZodEnum<{
+        u: "u";
+        c: "c";
+        p: "p";
+        f: "f";
+        x: "x";
+    }>;
+    deferrable: z.ZodBoolean;
+    initially_deferred: z.ZodBoolean;
+    validated: z.ZodBoolean;
+    is_local: z.ZodBoolean;
+    no_inherit: z.ZodBoolean;
+    is_partition_clone: z.ZodBoolean;
+    parent_constraint_schema: z.ZodNullable<z.ZodString>;
+    parent_constraint_name: z.ZodNullable<z.ZodString>;
+    parent_table_schema: z.ZodNullable<z.ZodString>;
+    parent_table_name: z.ZodNullable<z.ZodString>;
+    key_columns: z.ZodArray<z.ZodString>;
+    foreign_key_columns: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    foreign_key_table: z.ZodNullable<z.ZodString>;
+    foreign_key_schema: z.ZodNullable<z.ZodString>;
+    foreign_key_table_is_partition: z.ZodNullable<z.ZodBoolean>;
+    foreign_key_parent_schema: z.ZodNullable<z.ZodString>;
+    foreign_key_parent_table: z.ZodNullable<z.ZodString>;
+    foreign_key_effective_schema: z.ZodNullable<z.ZodString>;
+    foreign_key_effective_table: z.ZodNullable<z.ZodString>;
+    on_update: z.ZodNullable<z.ZodEnum<{
+        n: "n";
+        a: "a";
+        r: "r";
+        d: "d";
+        c: "c";
+    }>>;
+    on_delete: z.ZodNullable<z.ZodEnum<{
+        n: "n";
+        a: "a";
+        r: "r";
+        d: "d";
+        c: "c";
+    }>>;
+    match_type: z.ZodNullable<z.ZodEnum<{
+        u: "u";
+        s: "s";
+        p: "p";
+        f: "f";
+    }>>;
+    check_expression: z.ZodNullable<z.ZodString>;
+    owner: z.ZodString;
+    definition: z.ZodString;
+    comment: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.z.core.$strip>;
+export type TableConstraintProps = z.infer<typeof tableConstraintPropsSchema>;
+declare const tablePropsSchema: z.ZodObject<{
+    schema: z.ZodString;
+    name: z.ZodString;
+    persistence: z.ZodEnum<{
+        u: "u";
+        t: "t";
+        p: "p";
+    }>;
+    row_security: z.ZodBoolean;
+    force_row_security: z.ZodBoolean;
+    has_indexes: z.ZodBoolean;
+    has_rules: z.ZodBoolean;
+    has_triggers: z.ZodBoolean;
+    has_subclasses: z.ZodBoolean;
+    is_populated: z.ZodBoolean;
+    replica_identity: z.ZodEnum<{
+        n: "n";
+        i: "i";
+        d: "d";
+        f: "f";
+    }>;
+    is_partition: z.ZodBoolean;
+    options: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    partition_bound: z.ZodNullable<z.ZodString>;
+    partition_by: z.ZodNullable<z.ZodString>;
+    owner: z.ZodString;
+    comment: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    parent_schema: z.ZodNullable<z.ZodString>;
+    parent_name: z.ZodNullable<z.ZodString>;
+    columns: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        position: z.ZodNumber;
+        data_type: z.ZodString;
+        data_type_str: z.ZodString;
+        is_custom_type: z.ZodBoolean;
+        custom_type_type: z.ZodNullable<z.ZodString>;
+        custom_type_category: z.ZodNullable<z.ZodString>;
+        custom_type_schema: z.ZodNullable<z.ZodString>;
+        custom_type_name: z.ZodNullable<z.ZodString>;
+        not_null: z.ZodBoolean;
+        is_identity: z.ZodBoolean;
+        is_identity_always: z.ZodBoolean;
+        is_generated: z.ZodBoolean;
+        collation: z.ZodNullable<z.ZodString>;
+        default: z.ZodNullable<z.ZodString>;
+        comment: z.ZodNullable<z.ZodString>;
+    }, z.z.core.$strip>>;
+    constraints: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        constraint_type: z.ZodEnum<{
+            u: "u";
+            c: "c";
+            p: "p";
+            f: "f";
+            x: "x";
+        }>;
+        deferrable: z.ZodBoolean;
+        initially_deferred: z.ZodBoolean;
+        validated: z.ZodBoolean;
+        is_local: z.ZodBoolean;
+        no_inherit: z.ZodBoolean;
+        is_partition_clone: z.ZodBoolean;
+        parent_constraint_schema: z.ZodNullable<z.ZodString>;
+        parent_constraint_name: z.ZodNullable<z.ZodString>;
+        parent_table_schema: z.ZodNullable<z.ZodString>;
+        parent_table_name: z.ZodNullable<z.ZodString>;
+        key_columns: z.ZodArray<z.ZodString>;
+        foreign_key_columns: z.ZodNullable<z.ZodArray<z.ZodString>>;
+        foreign_key_table: z.ZodNullable<z.ZodString>;
+        foreign_key_schema: z.ZodNullable<z.ZodString>;
+        foreign_key_table_is_partition: z.ZodNullable<z.ZodBoolean>;
+        foreign_key_parent_schema: z.ZodNullable<z.ZodString>;
+        foreign_key_parent_table: z.ZodNullable<z.ZodString>;
+        foreign_key_effective_schema: z.ZodNullable<z.ZodString>;
+        foreign_key_effective_table: z.ZodNullable<z.ZodString>;
+        on_update: z.ZodNullable<z.ZodEnum<{
+            n: "n";
+            a: "a";
+            r: "r";
+            d: "d";
+            c: "c";
+        }>>;
+        on_delete: z.ZodNullable<z.ZodEnum<{
+            n: "n";
+            a: "a";
+            r: "r";
+            d: "d";
+            c: "c";
+        }>>;
+        match_type: z.ZodNullable<z.ZodEnum<{
+            u: "u";
+            s: "s";
+            p: "p";
+            f: "f";
+        }>>;
+        check_expression: z.ZodNullable<z.ZodString>;
+        owner: z.ZodString;
+        definition: z.ZodString;
+        comment: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.z.core.$strip>>>;
+    privileges: z.ZodArray<z.ZodObject<{
+        grantee: z.ZodString;
+        privilege: z.ZodString;
+        grantable: z.ZodBoolean;
+        columns: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    }, z.z.core.$strip>>;
+}, z.z.core.$strip>;
+type TablePrivilegeProps = PrivilegeProps;
+export type TableProps = z.infer<typeof tablePropsSchema>;
+export declare class Table extends BasePgModel implements TableLikeObject {
+    readonly schema: TableProps["schema"];
+    readonly name: TableProps["name"];
+    readonly persistence: TableProps["persistence"];
+    readonly row_security: TableProps["row_security"];
+    readonly force_row_security: TableProps["force_row_security"];
+    readonly has_indexes: TableProps["has_indexes"];
+    readonly has_rules: TableProps["has_rules"];
+    readonly has_triggers: TableProps["has_triggers"];
+    readonly has_subclasses: TableProps["has_subclasses"];
+    readonly is_populated: TableProps["is_populated"];
+    readonly replica_identity: TableProps["replica_identity"];
+    readonly is_partition: TableProps["is_partition"];
+    readonly options: TableProps["options"];
+    readonly partition_bound: TableProps["partition_bound"];
+    readonly partition_by: TableProps["partition_by"];
+    readonly owner: TableProps["owner"];
+    readonly comment: TableProps["comment"];
+    readonly parent_schema: TableProps["parent_schema"];
+    readonly parent_name: TableProps["parent_name"];
+    readonly columns: TableProps["columns"];
+    readonly constraints: TableConstraintProps[];
+    readonly privileges: TablePrivilegeProps[];
+    constructor(props: TableProps);
+    get stableId(): `table:${string}`;
+    get identityFields(): {
+        schema: string;
+        name: string;
+    };
+    get dataFields(): {
+        persistence: "u" | "t" | "p";
+        row_security: boolean;
+        force_row_security: boolean;
+        replica_identity: "n" | "i" | "d" | "f";
+        options: string[] | null;
+        parent_schema: string | null;
+        parent_name: string | null;
+        partition_bound: string | null;
+        owner: string;
+        comment: string | null | undefined;
+        columns: {
+            name: string;
+            position: number;
+            data_type: string;
+            data_type_str: string;
+            is_custom_type: boolean;
+            custom_type_type: string | null;
+            custom_type_category: string | null;
+            custom_type_schema: string | null;
+            custom_type_name: string | null;
+            not_null: boolean;
+            is_identity: boolean;
+            is_identity_always: boolean;
+            is_generated: boolean;
+            collation: string | null;
+            default: string | null;
+            comment: string | null;
+        }[];
+        constraints: {
+            name: string;
+            constraint_type: "u" | "c" | "p" | "f" | "x";
+            deferrable: boolean;
+            initially_deferred: boolean;
+            validated: boolean;
+            is_local: boolean;
+            no_inherit: boolean;
+            is_partition_clone: boolean;
+            parent_constraint_schema: string | null;
+            parent_constraint_name: string | null;
+            parent_table_schema: string | null;
+            parent_table_name: string | null;
+            key_columns: string[];
+            foreign_key_columns: string[] | null;
+            foreign_key_table: string | null;
+            foreign_key_schema: string | null;
+            foreign_key_table_is_partition: boolean | null;
+            foreign_key_parent_schema: string | null;
+            foreign_key_parent_table: string | null;
+            foreign_key_effective_schema: string | null;
+            foreign_key_effective_table: string | null;
+            on_update: "n" | "a" | "r" | "d" | "c" | null;
+            on_delete: "n" | "a" | "r" | "d" | "c" | null;
+            match_type: "u" | "s" | "p" | "f" | null;
+            check_expression: string | null;
+            owner: string;
+            definition: string;
+            comment?: string | null | undefined;
+        }[];
+        privileges: {
+            grantee: string;
+            privilege: string;
+            grantable: boolean;
+            columns?: string[] | null | undefined;
+        }[];
+    };
+    stableSnapshot(): {
+        identity: {
+            schema: string;
+            name: string;
+        };
+        data: {
+            columns: {
+                name: string;
+                data_type: string;
+                data_type_str: string;
+                is_custom_type: boolean;
+                custom_type_type: string | null;
+                custom_type_category: string | null;
+                custom_type_schema: string | null;
+                custom_type_name: string | null;
+                not_null: boolean;
+                is_identity: boolean;
+                is_identity_always: boolean;
+                is_generated: boolean;
+                collation: string | null;
+                default: string | null;
+                comment: string | null;
+            }[];
+            options: string[] | null;
+            constraints: {
+                name: string;
+                constraint_type: "u" | "c" | "p" | "f" | "x";
+                deferrable: boolean;
+                initially_deferred: boolean;
+                validated: boolean;
+                is_local: boolean;
+                no_inherit: boolean;
+                is_partition_clone: boolean;
+                parent_constraint_schema: string | null;
+                parent_constraint_name: string | null;
+                parent_table_schema: string | null;
+                parent_table_name: string | null;
+                key_columns: string[];
+                foreign_key_columns: string[] | null;
+                foreign_key_table: string | null;
+                foreign_key_schema: string | null;
+                foreign_key_table_is_partition: boolean | null;
+                foreign_key_parent_schema: string | null;
+                foreign_key_parent_table: string | null;
+                foreign_key_effective_schema: string | null;
+                foreign_key_effective_table: string | null;
+                on_update: "n" | "a" | "r" | "d" | "c" | null;
+                on_delete: "n" | "a" | "r" | "d" | "c" | null;
+                match_type: "u" | "s" | "p" | "f" | null;
+                check_expression: string | null;
+                owner: string;
+                definition: string;
+                comment?: string | null | undefined;
+            }[];
+            privileges: {
+                grantee: string;
+                privilege: string;
+                grantable: boolean;
+            }[];
+            persistence: "u" | "t" | "p";
+            row_security: boolean;
+            force_row_security: boolean;
+            replica_identity: "n" | "i" | "d" | "f";
+            parent_schema: string | null;
+            parent_name: string | null;
+            partition_bound: string | null;
+            owner: string;
+            comment: string | null | undefined;
+        };
+    };
+}
+export declare function extractTables(sql: Sql): Promise<Table[]>;
+export {};