9.12.8 db-doc
Generates JavaDoc documentation for the existing database and
changelogs.
Syntax
Liquibase|lb db-doc|dbd {OPTIONS}Options
| Option | Description | Default |
|---|---|---|
| Required | ||
-changelog-file|-chf
<changelog-file> |
The root changelog file. | - |
-output-directory|-oud
<output-directory> |
The directory where the documentation is generated. | - |
| Optional | ||
-database-changelog-table-name|-dactn
<database-changelog-table-name> |
Name of table to use for tracking change history. | - |
-debug|-de |
Enable debug output. | - |
-default-schema-name|-desn
<default-schema-name> |
The default schema name to use for the database connection. | - |
-defaults-file|-def
<defaults-file> {FILE} |
Fully qualified path to the properties file you want
to use. Example:
-defaults-file/tmp/liquibase.properties |
- |
-liquibase-schema-name|-lbsn
<liquibase-schema-name> |
Schema to use for Liquibase objects. | - |
-liquibase-tablespace-name|-lbtn
<liquibase-tablespace-name> |
Tablespace to use for Liquibase objects. | - |
-log|-lo |
Enable logging. Standard logging is Debug logging is |
- |
-search-path|-sep
<search-path> |
Complete list of locations to search for files such as changelog files. You can specify multiple paths by separating them with commas. |
- |
-secure-parsing|-scp
<secure-parsing> |
If true, remove functionality from file parsers that could be used insecurely. An example is disabling remote XML entity support. |
True |
-output-default-schema|-ouds
<output-default-schema> |
Controls whether names of objects in the default schema are fully qualified or not. If false, only objects outside the default schema are fully qualified. | False |
Example
Generate db documentation:
-- Set default output path
SQL> cd <output-files-path>
-- Generate doc
SQL> lb db-doc -output-directory ./dbdoc -changelog-file controller.xml