4.6 Generate an Annotation Report

This command generates a Markdown report containing all tables and their column annotations.

Syntax

annotation report -output <output-file>

The -output option is required. It specifies the path to the Markdown file that SQLcl creates.

Examples

annotation report -output match-annotations.md

annotation report -output /path/to/match-annotations.md

These examples create a Markdown file named match-annotations.md containing the current table and associated column annotations.

This report is useful for reviewing the documentation stored with the schema, sharing annotations, or searching for annotations associated with a specific object outside the CLI.

Note:

SQLcl does not overwrite an existing report file. Therefore, if a file with the specified name already exists, specify a different file name or delete the existing file before generating the report.