---
title: "lintMigration"
description: "Lint a migration"
canonical: "https://pgbeam.com/docs/ts-sdk/migrations/lintMigration"
last-updated: "2026-10-30T16:47:52.000Z"
---

# lintMigration

> Lint a migration

URL: https://pgbeam.com/docs/ts-sdk/migrations/lintMigration

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

Analyzes a migration script for unsafe schema changes and returns findings.

## Usage

```typescript
const result = await api.migrations.lintMigration({
  pathParams: { project_id: "prj_xxx" },
  body: {
    sql: "...",
  },
});
```

## Parameters

| Parameter             | Type     | Required | Description                                                    |
| --------------------- | -------- | -------- | -------------------------------------------------------------- |
| pathParams.project_id | `string` | Yes      | Unique project identifier (prefixed, e.g. prj_xxx).            |
| body.sql              | `string` | Yes      | The migration SQL to analyze. May contain multiple statements. |
| body.database_id      | `string` | No       | Optional database to scope the lint to.                        |

## Response

`Promise<MigrationLintResponse>`: lint results.

## Example

```typescript
import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbu_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.migrations.lintMigration({
  pathParams: { project_id: "prj_xxx" },
  body: {
    sql: "...",
  },
});
```

## 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`.                                                                                                                                                                                               |
| 413    | The request body exceeds the 2 MB limit. `code` is `PAYLOAD_TOO_LARGE`.                                                                                                                                                                                                                               |
| 415    | The request body is not JSON, or carries a body without declaring a Content-Type. `code` is `UNSUPPORTED_MEDIA_TYPE`.                                                                                                                                                                                 |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                                                                                                                                                                                        |