prorm API Reference
    Preparing search index...

    Function buildCommentOnTableSQL

    • Attach a comment to a table.

      Comments live in the catalog, so they survive a restore and show up in every client — a better home for "why does this column exist" than a wiki.

      Passing null removes the comment.

      Parameters

      • table: string
      • comment: string | null
      • dialect: string
      • quoteTable: (t: string) => string

      Returns string