diff --git a/README.md b/README.md index bd60c4fde..5882a930b 100644 --- a/README.md +++ b/README.md @@ -28,55 +28,55 @@ View example documentation here: https://tj-actions.github.io/schemaspy/ -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------------|--------|----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| all | string | false | `"false"` | Analyze all schemas in the database | -| anomalies\_length\_change | string | false | `"false"` | Whether users can change the page length
for anomalies | -| anomalies\_page\_length | string | false | `"10"` | The DataTables pageLength for anomalies | -| catalog | string | false | | Filter using a specific catalog this is
usually the root of the database and
contains schemas. | -| check\_length\_change | string | false | `"false"` | Whether users can change the page length
for check constraints | -| check\_page\_length | string | false | `"10"` | The DataTables pageLength for check constraints | -| column\_length\_change | string | false | `"false"` | Whether users can change the page length
for routines | -| column\_page\_length | string | false | `"50"` | The DataTables pageLength for routines | -| database\_name | string | false | | Name of the database to connect to
| -| database\_type | string | false | `"ora"` | Type of database to connect to | -| db\_object\_length\_change | string | false | `"false"` | Whether users can change the page length
for database objects | -| db\_object\_page\_length | string | false | `"50"` | The DataTables pageLength for database objects | -| debug | string | false | `"false"` | Enable debug logging | -| degree | string | false | `"2"` | Limit the degree of separation, allowed values
1 or 2, defaults to 2 | -| driver\_path | string | false | | Path to look for JDBC drivers overrides
driverPath in \[databaseType].properties, supports directory, will add
directory and recurse to add all content.
Supports multiple paths using os dependent pathSeparator.
| -| fk\_length\_change | string | false | `"false"` | Whether users can change the page length
for foreign keys | -| fk\_page\_length | string | false | `"10"` | The DataTables pageLength for foreign keys | -| graphviz\_dir | string | false | | Path to directory containing graphviz bin folder.
/bin/dot will be appended | -| host | string | false | | Hostname/ip to connect to, if required by
databaseType. | -| image\_format | string | false | `"png"` | The format of the image that gets
generated. Supported formats are svg and png.
Defaults to png. | -| index\_length\_change | string | false | `"false"` | Whether users can change the page length
for indexes | -| index\_page\_length | string | false | `"10"` | The DataTables pageLength for indexes | -| license | string | false | `"false"` | Print license, it will first print GPL
and then LGPL (LGPL is addition to
GPL) | -| low\_quality | string | false | `"false"` | Try to generate low quality diagrams, depending
on renderers/Graphviz installation might not be available
| -| no\_anomalies\_paging | string | false | `"false"` | Whether DataTables for anomalies should have pagination
| -| no\_check\_paging | string | false | `"false"` | Whether DataTables for check constraints should have
pagination | -| no\_column\_paging | string | false | `"false"` | Whether DataTables for routines should have pagination
| -| no\_db\_object\_paging | string | false | `"false"` | Whether DataTables for database objects should have
pagination | -| no\_fk\_paging | string | false | `"false"` | Whether DataTables for foreign keys should have
pagination | -| no\_html | string | false | `"false"` | Skip html generation | -| no\_implied | string | false | `"false"` | Do not look for implied relationships | -| no\_index\_paging | string | false | `"false"` | Whether DataTables for indexes should have pagination
| -| no\_routine\_paging | string | false | `"false"` | Whether DataTables for routines should have pagination
| -| no\_table\_paging | string | false | `"false"` | Whether DataTables for database tables should have
pagination | -| output\_dir | string | false | `"docs"` | Directory to place the generated files in
| -| password | string | false | | Password to connect to database, if required
by databaseType. | -| port | string | false | | Port that dbms listens to, if required
by databaseType. | -| renderer | string | false | | Specify which renderer to use should be
prefixed with `:`. Example `:cairo` | -| routine\_length\_change | string | false | `"false"` | Whether users can change the page length
for routines | -| routine\_page\_length | string | false | `"50"` | The DataTables pageLength for routines | -| schema | string | false | | Name of the schema to analyze (defaults
to the specified user) | -| schema\_meta | string | false | | Single schema analysis file path to SchemaMeta\_xml,
when running `_all` or `_schemas` path to
directory containing SchemaMeta\_xmls with pattern (DatabaseName|Schema).meta.xml | -| sso | string | false | `"false"` | Use single sign on, if required by
databaseType. | -| table\_length\_change | string | false | `"false"` | Whether users can change the page length
for database tables | -| table\_page\_length | string | false | `"50"` | The DataTables pageLength for database tables | -| user | string | false | | Username to connect with, if required by
databaseType. | -| vizjs | string | false | `"false"` | Use vizjs instead of graphviz | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|-------------------------|--------|----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| all | string | false | `"false"` | Analyze all schemas in the database | +| anomalies\_length\_change | string | false | `"false"` | Whether users can change the page
length for anomalies | +| anomalies\_page\_length | string | false | `"10"` | The DataTables pageLength for anomalies | +| catalog | string | false | | Filter using a specific catalog this
is usually the root of the
database and contains schemas. | +| check\_length\_change | string | false | `"false"` | Whether users can change the page
length for check constraints | +| check\_page\_length | string | false | `"10"` | The DataTables pageLength for check constraints | +| column\_length\_change | string | false | `"false"` | Whether users can change the page
length for routines | +| column\_page\_length | string | false | `"50"` | The DataTables pageLength for routines | +| database\_name | string | false | | Name of the database to connect
to | +| database\_type | string | false | `"ora"` | Type of database to connect to | +| db\_object\_length\_change | string | false | `"false"` | Whether users can change the page
length for database objects | +| db\_object\_page\_length | string | false | `"50"` | The DataTables pageLength for database objects | +| debug | string | false | `"false"` | Enable debug logging | +| degree | string | false | `"2"` | Limit the degree of separation, allowed
values 1 or 2, defaults to
2 | +| driver\_path | string | false | | Path to look for JDBC drivers
overrides driverPath in \[databaseType].properties, supports directory,
will add directory and recurse to
add all content. Supports multiple paths
using os dependent pathSeparator. | +| fk\_length\_change | string | false | `"false"` | Whether users can change the page
length for foreign keys | +| fk\_page\_length | string | false | `"10"` | The DataTables pageLength for foreign keys | +| graphviz\_dir | string | false | | Path to directory containing graphviz bin
folder. /bin/dot will be appended | +| host | string | false | | Hostname/ip to connect to, if required
by databaseType. | +| image\_format | string | false | `"png"` | The format of the image that
gets generated. Supported formats are svg
and png. Defaults to png. | +| index\_length\_change | string | false | `"false"` | Whether users can change the page
length for indexes | +| index\_page\_length | string | false | `"10"` | The DataTables pageLength for indexes | +| license | string | false | `"false"` | Print license, it will first print
GPL and then LGPL (LGPL is
addition to GPL) | +| low\_quality | string | false | `"false"` | Try to generate low quality diagrams,
depending on renderers/Graphviz installation might not
be available | +| no\_anomalies\_paging | string | false | `"false"` | Whether DataTables for anomalies should have
pagination | +| no\_check\_paging | string | false | `"false"` | Whether DataTables for check constraints should
have pagination | +| no\_column\_paging | string | false | `"false"` | Whether DataTables for routines should have
pagination | +| no\_db\_object\_paging | string | false | `"false"` | Whether DataTables for database objects should
have pagination | +| no\_fk\_paging | string | false | `"false"` | Whether DataTables for foreign keys should
have pagination | +| no\_html | string | false | `"false"` | Skip html generation | +| no\_implied | string | false | `"false"` | Do not look for implied relationships | +| no\_index\_paging | string | false | `"false"` | Whether DataTables for indexes should have
pagination | +| no\_routine\_paging | string | false | `"false"` | Whether DataTables for routines should have
pagination | +| no\_table\_paging | string | false | `"false"` | Whether DataTables for database tables should
have pagination | +| output\_dir | string | false | `"docs"` | Directory to place the generated files
in | +| password | string | false | | Password to connect to database, if
required by databaseType. | +| port | string | false | | Port that dbms listens to, if
required by databaseType. | +| renderer | string | false | | Specify which renderer to use should
be prefixed with `:`. Example `:cairo` | +| routine\_length\_change | string | false | `"false"` | Whether users can change the page
length for routines | +| routine\_page\_length | string | false | `"50"` | The DataTables pageLength for routines | +| schema | string | false | | Name of the schema to analyze
(defaults to the specified user) | +| schema\_meta | string | false | | Single schema analysis file path to
SchemaMeta\_xml, when running `_all` or `_schemas`
path to directory containing SchemaMeta\_xmls with
pattern (DatabaseName|Schema).meta.xml | +| sso | string | false | `"false"` | Use single sign on, if required
by databaseType. | +| table\_length\_change | string | false | `"false"` | Whether users can change the page
length for database tables | +| table\_page\_length | string | false | `"50"` | The DataTables pageLength for database tables | +| user | string | false | | Username to connect with, if required
by databaseType. | +| vizjs | string | false | `"false"` | Use vizjs instead of graphviz |