From 85d420397c19468dfe32c3e4547a7d9732f9ab89 Mon Sep 17 00:00:00 2001 From: jackton1 Date: Sat, 2 Dec 2023 11:59:16 +0000 Subject: [PATCH] Updated README.md --- README.md | 294 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 245 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index c34501815..d542b5a3c 100644 --- a/README.md +++ b/README.md @@ -28,55 +28,251 @@ View example documentation here: https://tj-actions.github.io/schemaspy/ -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------------------------------------------------------------------------------------------|--------|----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [all](#input_all) | string | false | `"false"` | Analyze all schemas in the
database | -| [anomalies\_length\_change](#input_anomalies_length_change) | string | false | `"false"` | Whether users can change the
page length for anomalies | -| [anomalies\_page\_length](#input_anomalies_page_length) | string | false | `"10"` | The DataTables pageLength for anomalies | -| [catalog](#input_catalog) | string | false | | Filter using a specific catalog
this is usually the root
of the database and contains
schemas. | -| [check\_length\_change](#input_check_length_change) | string | false | `"false"` | Whether users can change the
page length for check constraints | -| [check\_page\_length](#input_check_page_length) | string | false | `"10"` | The DataTables pageLength for check
constraints | -| [column\_length\_change](#input_column_length_change) | string | false | `"false"` | Whether users can change the
page length for routines | -| [column\_page\_length](#input_column_page_length) | string | false | `"50"` | The DataTables pageLength for routines | -| [database\_name](#input_database_name) | string | false | | Name of the database to
connect to | -| [database\_type](#input_database_type) | string | false | `"ora"` | Type of database to connect
to | -| [db\_object\_length\_change](#input_db_object_length_change) | string | false | `"false"` | Whether users can change the
page length for database objects | -| [db\_object\_page\_length](#input_db_object_page_length) | string | false | `"50"` | The DataTables pageLength for database
objects | -| [debug](#input_debug) | string | false | `"false"` | Enable debug logging | -| [degree](#input_degree) | string | false | `"2"` | Limit the degree of separation,
allowed values 1 or 2,
defaults to 2 | -| [driver\_path](#input_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](#input_fk_length_change) | string | false | `"false"` | Whether users can change the
page length for foreign keys | -| [fk\_page\_length](#input_fk_page_length) | string | false | `"10"` | The DataTables pageLength for foreign
keys | -| [graphviz\_dir](#input_graphviz_dir) | string | false | | Path to directory containing graphviz
bin folder. /bin/dot will be
appended | -| [host](#input_host) | string | false | | Hostname/ip to connect to, if
required by databaseType. | -| [image\_format](#input_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](#input_index_length_change) | string | false | `"false"` | Whether users can change the
page length for indexes | -| [index\_page\_length](#input_index_page_length) | string | false | `"10"` | The DataTables pageLength for indexes | -| [license](#input_license) | string | false | `"false"` | Print license, it will first
print GPL and then LGPL
(LGPL is addition to GPL) | -| [low\_quality](#input_low_quality) | string | false | `"false"` | Try to generate low quality
diagrams, depending on renderers/Graphviz installation
might not be available | -| [no\_anomalies\_paging](#input_no_anomalies_paging) | string | false | `"false"` | Whether DataTables for anomalies should
have pagination | -| [no\_check\_paging](#input_no_check_paging) | string | false | `"false"` | Whether DataTables for check constraints
should have pagination | -| [no\_column\_paging](#input_no_column_paging) | string | false | `"false"` | Whether DataTables for routines should
have pagination | -| [no\_db\_object\_paging](#input_no_db_object_paging) | string | false | `"false"` | Whether DataTables for database objects
should have pagination | -| [no\_fk\_paging](#input_no_fk_paging) | string | false | `"false"` | Whether DataTables for foreign keys
should have pagination | -| [no\_html](#input_no_html) | string | false | `"false"` | Skip html generation | -| [no\_implied](#input_no_implied) | string | false | `"false"` | Do not look for implied
relationships | -| [no\_index\_paging](#input_no_index_paging) | string | false | `"false"` | Whether DataTables for indexes should
have pagination | -| [no\_routine\_paging](#input_no_routine_paging) | string | false | `"false"` | Whether DataTables for routines should
have pagination | -| [no\_table\_paging](#input_no_table_paging) | string | false | `"false"` | Whether DataTables for database tables
should have pagination | -| [output\_dir](#input_output_dir) | string | false | `"docs"` | Directory to place the generated
files in | -| [password](#input_password) | string | false | | Password to connect to database,
if required by databaseType. | -| [port](#input_port) | string | false | | Port that dbms listens to,
if required by databaseType. | -| [renderer](#input_renderer) | string | false | | Specify which renderer to use
should be prefixed with `:`.
Example `:cairo` | -| [routine\_length\_change](#input_routine_length_change) | string | false | `"false"` | Whether users can change the
page length for routines | -| [routine\_page\_length](#input_routine_page_length) | string | false | `"50"` | The DataTables pageLength for routines | -| [schema](#input_schema) | string | false | | Name of the schema to
analyze (defaults to the specified user) | -| [schema\_meta](#input_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](#input_sso) | string | false | `"false"` | Use single sign on, if
required by databaseType. | -| [table\_length\_change](#input_table_length_change) | string | false | `"false"` | Whether users can change the
page length for database tables | -| [table\_page\_length](#input_table_page_length) | string | false | `"50"` | The DataTables pageLength for database
tables | -| [user](#input_user) | string | false | | Username to connect with, if
required by databaseType. | -| [vizjs](#input_vizjs) | string | false | `"false"` | Use vizjs instead of graphviz | +```yaml +- uses: tj-actions/schemaspy@v2 + id: schemaspy + with: + # Analyze all schemas in the database + # Type: boolean + # Default: "false" + all: '' + + # Whether users can change the page length for anomalies + # Type: boolean + # Default: "false" + anomalies_length_change: '' + + # The DataTables pageLength for anomalies + # Type: string + # Default: "10" + anomalies_page_length: '' + + # Filter using a specific catalog this is usually the + # root of the database and contains schemas. + # Type: string + catalog: '' + + # Whether users can change the page length for check + # constraints + # Type: boolean + # Default: "false" + check_length_change: '' + + # The DataTables pageLength for check constraints + # Type: string + # Default: "10" + check_page_length: '' + + # Whether users can change the page length for routines + # Type: boolean + # Default: "false" + column_length_change: '' + + # The DataTables pageLength for routines + # Type: string + # Default: "50" + column_page_length: '' + + # Name of the database to connect to + # Type: string + database_name: '' + + # Type of database to connect to + # Type: string + # Default: "ora" + database_type: '' + + # Whether users can change the page length for database + # objects + # Type: boolean + # Default: "false" + db_object_length_change: '' + + # The DataTables pageLength for database objects + # Type: string + # Default: "50" + db_object_page_length: '' + + # Enable debug logging + # Type: boolean + # Default: "false" + debug: '' + + # Limit the degree of separation, allowed values 1 or + # 2, defaults to 2 + # Type: string + # Default: "2" + degree: '' + + # 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. + # Type: string + driver_path: '' + + # Whether users can change the page length for foreign + # keys + # Type: boolean + # Default: "false" + fk_length_change: '' + + # The DataTables pageLength for foreign keys + # Type: string + # Default: "10" + fk_page_length: '' + + # Path to directory containing graphviz bin folder. /bin/dot will + # be appended + # Type: string + graphviz_dir: '' + + # Hostname/ip to connect to, if required by databaseType. + # Type: string + host: '' + + # The format of the image that gets generated. Supported + # formats are svg and png. Defaults to png. + # Type: string + # Default: "png" + image_format: '' + + # Whether users can change the page length for indexes + # Type: boolean + # Default: "false" + index_length_change: '' + + # The DataTables pageLength for indexes + # Type: string + # Default: "10" + index_page_length: '' + + # Print license, it will first print GPL and then + # LGPL (LGPL is addition to GPL) + # Type: boolean + # Default: "false" + license: '' + + # Try to generate low quality diagrams, depending on renderers/Graphviz + # installation might not be available + # Type: boolean + # Default: "false" + low_quality: '' + + # Whether DataTables for anomalies should have pagination + # Type: boolean + # Default: "false" + no_anomalies_paging: '' + + # Whether DataTables for check constraints should have pagination + # Type: boolean + # Default: "false" + no_check_paging: '' + + # Whether DataTables for routines should have pagination + # Type: boolean + # Default: "false" + no_column_paging: '' + + # Whether DataTables for database objects should have pagination + # Type: boolean + # Default: "false" + no_db_object_paging: '' + + # Whether DataTables for foreign keys should have pagination + # Type: boolean + # Default: "false" + no_fk_paging: '' + + # Skip html generation + # Type: boolean + # Default: "false" + no_html: '' + + # Do not look for implied relationships + # Type: boolean + # Default: "false" + no_implied: '' + + # Whether DataTables for indexes should have pagination + # Type: boolean + # Default: "false" + no_index_paging: '' + + # Whether DataTables for routines should have pagination + # Type: boolean + # Default: "false" + no_routine_paging: '' + + # Whether DataTables for database tables should have pagination + # Type: boolean + # Default: "false" + no_table_paging: '' + + # Directory to place the generated files in + # Type: string + # Default: "docs" + output_dir: '' + + # Password to connect to database, if required by databaseType. + # Type: string + password: '' + + # Port that dbms listens to, if required by databaseType. + # Type: string + port: '' + + # Specify which renderer to use should be prefixed with + # `:`. Example `:cairo` + # Type: string + renderer: '' + + # Whether users can change the page length for routines + # Type: boolean + # Default: "false" + routine_length_change: '' + + # The DataTables pageLength for routines + # Type: string + # Default: "50" + routine_page_length: '' + + # Name of the schema to analyze (defaults to the specified user) + # Type: string + schema: '' + + # 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 + # Type: string + schema_meta: '' + + # Use single sign on, if required by databaseType. + # Type: boolean + # Default: "false" + sso: '' + + # Whether users can change the page length for database + # tables + # Type: boolean + # Default: "false" + table_length_change: '' + + # The DataTables pageLength for database tables + # Type: string + # Default: "50" + table_page_length: '' + + # Username to connect with, if required by databaseType. + # Type: string + user: '' + + # Use vizjs instead of graphviz + # Type: boolean + # Default: "false" + vizjs: '' + +```