Back to Yugabyte Db

analyze schema reference

docs/content/stable/yugabyte-voyager/reference/schema-migration/analyze-schema.md

2026.1.0.0-b252.0 KB
Original Source

Analyse the PostgreSQL schema dumped in the export schema step.

Syntax

sh
yb-voyager analyze-schema [ <arguments> ... ]

Arguments

The following table lists the valid CLI flags and parameters for analyze-schema command.

When run at the same time, flags take precedence over configuration flag settings.

{{<table>}}

<div style="width:150px">CLI flag</div>Config file parameterDescription
--output-format
yaml{.nocopy}
analyze-schema:
  output-format:

|Format for the status report. One of html, txt, json, or xml. If not provided, reports are generated in both json and html formats by default. | | --target-db-version |

yaml{.nocopy}
analyze-schema:
  target-db-version:

|Specifies the target version of YugabyteDB in the format A.B.C.D. Default: latest stable version | | -e, --export-dir |

yaml{.nocopy}
export-dir:

|Path to the export directory. This directory is a workspace used to store exported schema DDL files, export data files, migration state, and a log file.| | --send-diagnostics |

yaml{.nocopy}
send-diagnostics:

|Enable or disable sending diagnostics information to Yugabyte. Default: true Accepted parameters: true, false, yes, no, 0, 1 |

| -l, --log-level |

yaml
log-level:

| Log level for yb-voyager. Accepted values: trace, debug, info, warn, error, fatal, panic Default: info | | -h, --help | — |Command line help. | | -y, --yes | — |Answer yes to all prompts during the export schema operation. Default: false Accepted parameters: true, false, yes, no, 0, 1 | | -c, --config-file | — | Path to a configuration file. |

{{</table>}}

Example

Configuration file:

sh
yb-voyager analyze-schema --config-file <path-to-config-file>

CLI:

sh
yb-voyager analyze-schema --export-dir /dir/export-dir --output-format txt