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 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 | |
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 |
| -l, --log-level | |
Log level for yb-voyager. Accepted values: trace, debug, info, warn, error, fatal, panic Default: info |
| --log-max-size-mb | |
Maximum size in MB of a yb-voyager log file before it is rotated. Also applies to the Debezium log file during live migration. Default: 200 |
| --log-max-backups | |
Maximum number of rotated log files to retain. Older files are deleted. Use -1 to retain all rotated log files. Default: 10 |
| -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. |
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