SchemaAnnotations
deleteSchemaAnnotation
Delete a schema annotation
Removes a single annotation identified by its natural key. Omit column_name to delete a table-level annotation, and omit schema_name to match the unqualified form.
Usage
const result = await api.schemaannotations.deleteSchemaAnnotation({
pathParams: { project_id: "prj_xxx" },
queryParams: { table_name: "..." },
});Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| pathParams.project_id | string | Yes | Unique project identifier (prefixed, e.g. prj_xxx). |
| queryParams.table_name | string | Yes | Relation (table or view) the annotation describes. |
| queryParams.schema_name | string | No | Optional schema. Omit to match the unqualified form. |
| queryParams.column_name | string | No | Optional column. Omit to delete a table-level annotation. |
Response
Promise<void>: no content.
Example
import { PgBeamClient } from "pgbeam";
const client = new PgBeamClient({
token: "pbk_...",
baseUrl: "https://api.pgbeam.com",
});
const result = await client.api.schemaannotations.deleteSchemaAnnotation({
pathParams: { project_id: "prj_xxx" },
queryParams: { table_name: "...", schema_name: "...", column_name: "..." },
});Errors
| Status | Description |
|---|---|
| 400 | Invalid request parameters. |
| 401 | Missing or invalid authentication. |
| 403 | Operation not allowed by current plan limits. |
| 404 | Resource not found. |