actions-marketplace-validations/Run SchemaSpy
Generate a database schema diagram from a live database.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| license | Print license, it will first print GPL and then LGPL (LGPL is addition to GPL) | no | false |
| graphviz_dir | Path to directory containing graphviz bin folder. /bin/dot will be appended | no | "" |
| low_quality | Try to generate low quality diagrams, depending on renderers/Graphviz installation might not be available | no | false |
| anomalies_length_change | Whether users can change the page length for anomalies | no | false |
| anomalies_page_length | The DataTables pageLength for anomalies | no | 10 |
| catalog | Filter using a specific catalog this is usually the root of the database and contains schemas. | no | "" |
| check_length_change | Whether users can change the page length for check constraints | no | false |
| check_page_length | The DataTables pageLength for check constraints | no | 10 |
| column_length_change | Whether users can change the page length for routines | no | false |
| column_page_length | The DataTables pageLength for routines | no | 50 |
| database_name | Name of the database to connect to | no | "" |
| database_type | Type of database to connect to | no | ora |
| db_object_length_change | Whether users can change the page length for database objects | no | false |
| db_object_page_length | The DataTables pageLength for database objects | no | 50 |
| debug | Enable debug logging | no | false |
| degree | Limit the degree of separation, allowed values 1 or 2, defaults to 2 | no | 2 |
| driver_path | 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. | no | "" |
| fk_length_change | Whether users can change the page length for foreign keys | no | false |
| fk_page_length | The DataTables pageLength for foreign keys | no | 10 |
| host | Hostname/ip to connect to, if required by databaseType. | no | "" |
| image_format | The format of the image that gets generated. Supported formats are svg and png. Defaults to png. | no | png |
| index_length_change | Whether users can change the page length for indexes | no | false |
| index_page_length | The DataTables pageLength for indexes | no | 10 |
| schema_meta | 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 | no | "" |
| no_anomalies_paging | Whether DataTables for anomalies should have pagination | no | false |
| no_check_paging | Whether DataTables for check constraints should have pagination | no | false |
| no_column_paging | Whether DataTables for routines should have pagination | no | false |
| no_db_object_paging | Whether DataTables for database objects should have pagination | no | false |
| no_fk_paging | Whether DataTables for foreign keys should have pagination | no | false |
| no_index_paging | Whether DataTables for indexes should have pagination | no | false |
| no_routine_paging | Whether DataTables for routines should have pagination | no | false |
| no_table_paging | Whether DataTables for database tables should have pagination | no | false |
| no_html | Skip html generation | no | false |
| no_implied | Do not look for implied relationships | no | false |
| output_dir | Directory to place the generated files in | no | docs |
| password | Password to connect to database, if required by databaseType. | no | "" |
| port | Port that dbms listens to, if required by databaseType. | no | "" |
| renderer | Specify which renderer to use should be prefixed with `:`. Example `:cairo` | no | "" |
| routine_length_change | Whether users can change the page length for routines | no | false |
| routine_page_length | The DataTables pageLength for routines | no | 50 |
| schema | Name of the schema to analyze (defaults to the specified user) | no | "" |
| sso | Use single sign on, if required by databaseType. | no | false |
| table_length_change | Whether users can change the page length for database tables | no | false |
| table_page_length | The DataTables pageLength for database tables | no | 50 |
| user | Username to connect with, if required by databaseType. | no | "" |
| vizjs | Use vizjs instead of graphviz | no | false |
| all | Analyze all schemas in the database | no | false |
Outputs
no outputs