Function commentOn

packages/node-core/src/db/sync-helper.ts:88–96

(
  type: 'CONSTRAINT' | 'TABLE' | 'COLUMN' | 'FUNCTION',
  entity: string,
  comment: string,
  constraint?: string
)

}

function commentOn(
  type: 'CONSTRAINT' | 'TABLE' | 'COLUMN' | 'FUNCTION',
  entity: string,
  comment: string,
  constraint?: string
): Query {
  const constraintPart = constraint ? `${constraint} ON ` : '';
  return {sql: `COMMENT ON ${type} ${constraintPart}${entity} IS ?;`, replacements: [comment]};
}

export function commentConstraintQuery(schema: string, table: string, constraint: string, comment: string): Query {
  return commentOn('CONSTRAINT', escapedName(schema, table), comment, constraint);