---
title: "DeleteSchemaAnnotation"
description: "Delete a schema annotation"
canonical: "https://pgbeam.com/docs/go-sdk/schemaannotations/deleteSchemaAnnotation"
last-updated: "2026-10-24T21:15:09.000Z"
---

# DeleteSchemaAnnotation

> Delete a schema annotation

URL: https://pgbeam.com/docs/go-sdk/schemaannotations/deleteSchemaAnnotation

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

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

```go
err := client.Schemaannotations.DeleteSchemaAnnotation(ctx, "prj_xxx", &pgbeam.DeleteSchemaAnnotationParams{
    TableName: "...",
  })
```

## Parameters

| Parameter         | Type                                   | Required | Description                                               |
| ----------------- | -------------------------------------- | -------- | --------------------------------------------------------- |
| ctx               | `context.Context`                      | Yes      | Request context                                           |
| projectID         | `string`                               | Yes      | Unique project identifier (prefixed, e.g. prj_xxx).       |
| params            | `*pgbeam.DeleteSchemaAnnotationParams` | Yes      | Query parameters                                          |
| params.TableName  | `string`                               | Yes      | Relation (table or view) the annotation describes.        |
| params.SchemaName | `*string`                              | No       | Optional schema. Omit to match the unqualified form.      |
| params.ColumnName | `*string`                              | No       | Optional column. Omit to delete a table-level annotation. |

## Response

`error`: returns nil on success.

## Example

```go
import pgbeam "go.pgbeam.com/sdk"

client := pgbeam.NewClient(&pgbeam.ClientOptions{
  APIKey: "pbu_...",
})

err := client.Schemaannotations.DeleteSchemaAnnotation(ctx, "prj_xxx", &pgbeam.DeleteSchemaAnnotationParams{
    TableName: "...",
  })
if err != nil {
  log.Fatal(err)
}
```

## Errors

| Status | Description                                                                                                                                                                                                                                                                                           |
| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.                                                                                                                                                                   |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                                                                                                                                                                                          |
| 403    | The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status. |
| 404    | The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.                                                                                                                                                                                               |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                                                                                                                                                                                        |