Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add defaults for inputs and added all option. #17

Merged
merged 10 commits into from
Oct 31, 2022
Merged

feat: add defaults for inputs and added all option. #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f2c40a8
Updated README.md
jackton1 Oct 31, 2022
39b8352
feat: add defaults for inputs and added all option.
jackton1 Oct 31, 2022
bebe85a
Merge 39b8352bb4782410dd1db9210cd09dea3989f298 into 1ccaa1589a03640ba…
jackton1 Oct 31, 2022
2fabc0c
Merge pull request #16 from tj-actions/chore/update-readme
jackton1 Oct 31, 2022
a246346
Updated Schema docs.
github-actions[bot] Oct 31, 2022
1541919
Merge a2463464eb58b6fb04a09f512d900f2effc1c3d9 into 2fabc0c3c21407cdd…
jackton1 Oct 31, 2022
5e1c90b
Updated Schema docs.
github-actions[bot] Oct 31, 2022
db934de
Update test.yml
jackton1 Oct 31, 2022
ebd7fca
Merge db934de949a4fc958cd3176b55b449567cfcdab7 into 2fabc0c3c21407cdd…
jackton1 Oct 31, 2022
535b5fd
Updated Schema docs.
github-actions[bot] Oct 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@ jobs:
id: verify-changed-files
with:
files: |
docs/**
!docs/index.html
!docs/columns.html
!docs/info-html.html
!docs/info-html.txt
docs/**

- name: Commit Schema docs changes
if: steps.verify-changed-files.outputs.files_changed == 'true'
Expand Down
7 changes: 1 addition & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ Example documentation available here: https://tj-actions.github.io/schemaspy/

<!-- AUTO-DOC-INPUT:END -->


## Using Docker image

Run
Expand All @@ -91,16 +90,12 @@ docker pull ghcr.io/tj-actions/schemaspy:2.1

> NOTE: The entrypoint is the `entrypoint.sh` script which requires certain environment variables to be set.


### Example usage with environment variables

```
docker run -v "$PWD:/docs" ghcr.io/tj-actions/schemaspy:2.1 -e INPUT_HOST=localhost -e INPUT_PORT=5432 -e INPUT_DATABASE_TYPE=pgsql -e INPUT_USER=test_user -e INPUT_PASSWORD=test_user_password -e INPUT_ALL=true
```
docker run -v "$PWD:/docs" ghcr.io/tj-actions/schemaspy:2.1 -e INPUT_HOST=localhost -e INPUT_PORT=5432 -e INPUT_DATABASE_TYPE=pgsql -e INPUT_USER=test_user -e INPUT_PASSWORD=test_user_password -e INPUT_ALL=true

For more information on each environment variable please refer to the [inputs](#inputs). A general rule would be to prefix the environment variable with `INPUT_` and uppercase of any specific input separated by underscores.


* Free software: [MIT license](LICENSE)

If you feel generous and want to show some extra appreciation:
Expand Down
161 changes: 20 additions & 141 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,126 +42,18 @@
<!-- ADD THE CLASS layout-top-nav TO REMOVE THE SIDEBAR. -->
<body class="hold-transition skin-blue layout-top-nav">
<div class="wrapper">
<header class="main-header">
<nav class="navbar navbar-static-top">
<div class="container">
<div class="navbar-header">
<a href="index.html" class="navbar-brand"><b>testdb</b> Database</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-collapse"><i class="fa fa-bars"></i></button>
</div>

<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse pull-left" id="navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="index.html">Tables <span class="sr-only">(current)</span></a></li>
<li><a href="columns.html" title="All of the columns in the schema">Columns</a></li>
<li><a href="constraints.html" title="Useful for diagnosing error messages that just give constraint name or number">Constraints</a></li>
<li><a href="relationships.html" title="Diagram of table relationships">Relationships</a></li>
<li><a href="orphans.html" title="View of tables with neither parents nor children">Orphan&nbsp;Tables</a></li>
<li><a href="anomalies.html" title="Things that might not be quite right">Anomalies</a></li>
<li><a href="routines.html" title="Procedures and functions">Routines</a></li>
</ul>
</div>
<!-- /.navbar-collapse -->
<!-- Navbar Right Menu -->
</div>
<!-- /.container-fluid -->
</nav>
</header>
<!-- Main content -->
<!-- Full Width Column -->
<div class="content-wrapper">
<!-- Content Header (Page header) -->
<section class="content-header">
<h1>Tables</h1><br />
<div class="row">
<div class="col-md-12">
<div class="callout callout-info">
<h4>SchemaSpy Analysis of testdb</h4>
<p>Generated on Sun Oct 30 09:45 GMT 2022</p>
</div>
</div>
<div class="callout callout-info">
<h4>SchemaSpy Analysis of testdb</h4>
<p>Generated on Mon Oct 31 17:00 GMT 2022</p>
</div>
<a href="testdb.public.xml" title="XML Representation">XML Representation</a><br />
<a href="insertionOrder.txt" title="Useful for loading data into a database">Insertion Order</a>
<a href="deletionOrder.txt" title="Useful for purging data from a database">Deletion Order</a>
</section>
<!-- Main content -->
<section class="content">
<div class="row">
<div class="col-md-2 col-sm-4 col-xs-12">
<div class="info-box">
<span class="info-box-icon bg-aqua"><i class="fa fa-table"></i></span>
<div class="info-box-content">
<span class="info-box-text">TABLES</span>
<span class="info-box-number">1</span>
</div>
<!-- /.info-box-content -->
</div>
<!-- /.info-box -->
</div>
<!-- /.col -->
<div class="col-md-2 col-sm-4 col-xs-12">
<div class="info-box">
<span class="info-box-icon bg-teal"><i class="fa fa-table"></i></span>
<div class="info-box-content">
<span class="info-box-text">VIEWS</span>
<span class="info-box-number">0</span>
</div>
<!-- /.info-box-content -->
</div>
<!-- /.info-box -->
</div>
<!-- /.col -->
<div class="col-md-2 col-sm-4 col-xs-12">
<div class="info-box">
<span class="info-box-icon bg-green"><span class="glyphicon glyphicon-list-alt" aria-hidden="true"></span></span>
<div class="info-box-content">
<span class="info-box-text">COLUMNS</span>
<span class="info-box-number">6</span>
</div>
<!-- /.info-box-content -->
</div>
<!-- /.info-box -->
</div>
<!-- /.col -->
<div class="col-md-2 col-sm-4 col-xs-12">
<div class="info-box">
<span class="info-box-icon bg-yellow"><i class="ion ion-key"></i></span>
<div class="info-box-content">
<span class="info-box-text">Constraints</span>
<span class="info-box-number">0</span>
</div>
<!-- /.info-box-content -->
</div>
<!-- /.info-box -->
</div>
<!-- /.col -->
<div class="col-md-2 col-sm-4 col-xs-12">
<div class="info-box">
<span class="info-box-icon bg-red-active"><i class="fa fa-question" aria-hidden="true"></i></span>
<div class="info-box-content">
<span class="info-box-text">Anomalies</span>
<span class="info-box-number">0</span>
</div>
<!-- /.info-box-content -->
</div>
<!-- /.info-box -->
</div>
<!-- /.col -->
<div class="col-md-2 col-sm-4 col-xs-12">
<div class="info-box">
<span class="info-box-icon bg-navy"><i class="fa fa-file-code-o" aria-hidden="true"></i></span>
<div class="info-box-content">
<span class="info-box-text">Routines</span>
<span class="info-box-number">0</span>
</div>
<!-- /.info-box-content -->
</div>
<!-- /.info-box -->
</div>
<!-- /.col -->
</div>
<div class="box box-primary">
<div class="box-header with-border">
<h3 class="box-title">Database Properties</h3>
Expand All @@ -173,51 +65,38 @@ <h3 class="box-title">Database Properties</h3>
</div>
<div class="box box-primary">
<div class="box-header with-border">
<h3 class="box-title">Schema public</h3>
<span class="label label-primary pull-right"><i class="fa fa-cog fa-2x"></i></span>
</div><!-- /.box-header -->
<div class="box-body">
<p> <p>standard public schema</p> </p>
</div><!-- /.box-body -->
</div>
<div class="box box-primary">
<div class="box-header with-border">
<h3 class="box-title">Tables</h3>
<h3 class="box-title">3 Schemas</h3>
<span class="label label-primary pull-right"><i class="fa fa-database fa-2x"></i></span>
</div><!-- /.box-header -->
<div class="box-body">
<table id="database_objects" class="table table-bordered table-striped dataTable" role="grid">
<thead>
<tr>
<th valign="bottom">Table / View</th>
<th align="right" valign="bottom">Children</th>
<th align="right" valign="bottom">Parents</th>
<th align="right" valign="bottom">Columns</th>
<th align="right" valign="bottom">Rows</th>
<th align="right" valign="bottom">Type</th>
<th class="toggle">Comments</th>
<th valign="bottom">Schema</th>
<th valign="bottom">Comments</th>
</tr>
</thead>
<tbody>
<tr class="tbl even" valign="top">
<td class="detail"><a href="tables/accounts.html">accounts</a></td>
<td class="detail" align="right">0</td>
<td class="detail" align="right">0</td>
<td class="detail" align="right">6</td>
<td class="detail" align="right">0</td>
<td class="detail" align="right">Table</td>
<td class="detail"><a href="information_schema/index.html">information_schema</a></td>
<td class="comment detail" style="display: table-cell;"></td>
</tr>
<tr class="tbl even" valign="top">
<td class="detail"><a href="pg_catalog/index.html">pg_catalog</a></td>
<td class="comment detail" style="display: table-cell;"><p>system catalog schema</p></td>
</tr>
<tr class="tbl even" valign="top">
<td class="detail"><a href="public/index.html">public</a></td>
<td class="comment detail" style="display: table-cell;"><p>standard public schema</p></td>
</tr>
</tbody>
</table>
</div>
</div><!-- /.box-body -->
<!-- /.box-body -->
</div>
</section>
<!-- /.content -->
<script>
var config = {
pagination: true
}
</script>

</div>
<!-- /.content-wrapper -->
<footer class="main-footer">
Expand Down Expand Up @@ -264,7 +143,7 @@ <h3 class="box-title">Tables</h3>
<script src="bower/codemirror/sql.js"></script>
<!-- AdminLTE App -->
<script src="bower/admin-lte/dist/js/app.min.js"></script>
<script src="main.js"></script>
<script src=""></script>
<script src="schemaSpy.js"></script>
</body>
</html>
Loading