analyze schema reference
yb-voyager analyze schema
Analyse the PostgreSQL schema dumped in the export schema step.
Syntax
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.
CLI flag |
Config file parameter | Description |
|---|---|---|
| --output-format | |
Format in which the report file is generated. One of html, txt, json, or xml. If not provided, reports are generated in both json and html formats by default. |
| --target-db-version | |
Specifies the target version of YugabyteDB in the format A.B.C.D.Default: latest stable version |
| -e, --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 | |
Enable or disable sending diagnostics information to Yugabyte. Default: true Accepted parameters: true, false, yes, no, 0, 1 |
| -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 |
Example
Configuration file:
yb-voyager analyze-schema --config-file <path-to-config-file>
CLI:
yb-voyager analyze-schema --export-dir /dir/export-dir --output-format txt