---
title: "annotations set"
description: "Create or replace a schema annotation"
canonical: "https://pgbeam.com/docs/cli/annotations/set"
last-updated: "2026-09-13T16:16:22.000Z"
---

# annotations set

> Create or replace a schema annotation

URL: https://pgbeam.com/docs/cli/annotations/set

Attaches an operator-written description to a table (omit column\_name) or a column. Keyed by (schema\_name, table\_name, column\_name); an existing annotation with the same key is replaced.

## Usage

## Options

Option

Description

Required

Default

`--schema-name <value>`

Optional schema. Null or empty matches the unqualified form.

No

-

`--table-name <value>`

Relation (table or view) the annotation describes.

Yes

-

`--column-name <value>`

Optional column. Null describes the table itself.

No

-

`--description <value>`

The operator-written description text.

Yes

-

All global options (`--token`, `--profile`,
`--project`, `--org`, `--json`, `--no-color`, `--no-trunc`, `--debug`) are
also available on this command.

## Examples

## Output

Renders a human-readable table or detail view by default; pass `--json` for the raw API response.