ddl-manager/lib/database/schema/Index.ts

store postgres procedures and triggers in files

import { TableID } from "./TableID";
import { Comment } from "./Comment";
import { MAX_NAME_LENGTH } from "../postgres/constants";

interface IndexParams {
    name: string;
    table: TableID;
    index: string;
    columns: string[];
    comment?: Comment;
}

export class Index {
    readonly name: string;
    readonly table: TableID;
    readonly index: string;
    readonly columns: readonly string[];
    readonly comment: Comment;

    constructor(params: IndexParams) {
        this.name = params.name.slice(0, MAX_NAME_LENGTH);
        this.table = params.table;
        this.index = params.index;
        this.columns = params.columns;
        this.comment = params.comment || Comment.frozen("index");
    }

    equal(otherIndex: Index) {
        return (
            this.name === otherIndex.name &&
            this.index === otherIndex.index &&
            this.table.equal(otherIndex.table) &&
            this.comment.equal(otherIndex.comment) &&
            this.columns.toString() == otherIndex.columns.toString()
        );
    }

    getSignature() {
        return this.table.schema + "." + this.name;
    }

    toSQL() {
        return `
            create index ${ this.name }
            on ${ this.table }
            using ${ this.index }
            ( ${ this.columns.join(", ") } )
        `;
    }
}