SchemaSpy

Quickly run SchemaSpy on a Postgres, MySQL, SQLite3, Microsoft SQL Server, or Oracle database in order to generate a browsable visualization of the tables, columns, and relationships.

Based on eclipse-temurin:21-jre-alpine-3.22 the resulting image generates the database documentation using SchemaSpy and serves the resulting html using Caddy, and is compatible with OpenShift.

The open source SchemaSpy project is located here: https://github.com/schemaspy/schemaspy

The open source Caddy project is located here; https://github.com/mholt/caddy

Official Docker Images

Official SchemaSpy container images are published to the GitHub Container Registry at SchemaSpy Container Images. You do not need to build the image yourself; you can use the pre-built images directly.

Local Docker environment

Want to try SchemaSpy out quickly without setting up your own database? The docker folder contains a ready-to-run Docker Compose stack with example Postgres, MySQL, and SQL Server databases, sample schemas, and support for pointing at your own database initialization scripts.

See the Local Docker Environment documentation for setup steps, example usage, how to import your own schema, and how the generated documentation can be exported and shared without needing the container or source database.

Configuration

Configuration is performed using environment varables.

Name	Description	Example
DATABASE_TYPE	The database type being documented. Defaults to pgsql.	One of mysql, pgsql, sqlite, mssql, or oracle. The JDBC connector libraries for all these databases are included in the image.
DATABASE_NAME	The name of the database to document.	MyDatabase
DATABASE_HOST	The hostname of the server	postgresql
DATABASE_SCHEMA	OPTIONAL - The schema in the database to document. Defaults to public.	my_schema
DATABASE_CATALOG	OPTIONAL - The catalog in the database to document. With some databases this is used to define the name of the database.	my_catalog
DATABASE_DRIVER	OPTIONAL - Used to override the default JDBC driver. The scripts attempt to set the driver base on convention using DATABASE_TYPE	/app/lib/pgsql-jdbc.jar
DATABASE_USER	The username to use when logging into the database. When using OpenShift this should be configured as a secrete.	my_user
DATABASE_PASSWORD	The password to use when logging into the database. When using OpenShift this should be configured as a secrete.	my_password
SCHEMASPY_ARGUMENTS	OPTIONAL - Allows you to define additional command line arguments for SchemaSpy	-hq to generate high quality output.
SCHEMASPY_COMMAND_OVERRIDE	OPTIONAL - Use this to override the SchemaSpy commands and define the commands explicitly. This is intended as a testing and troubleshooting tool.	lib/schemaspy.jar -t "pgsql" -db "TheOrgBook_Database" -dp "lib/postgresql-jdbc.jar" -hq -s "public" -u "TheOrgBook_User" -p "*****" -host "postgresql" -o /var/www/html
SCHEMASPY_PORT	OPTIONAL - Defaults to 8080. Changing this requires additional code and configuration changes, so it's best to leave it alone.	8080
OUTPUT_PATH	OPTIONAL - The output folder for the documentation. Defaults to /var/www/html, which is used by Caddy. Changing this requires additional code and configuration changes, so it's best to leave it alone.	/var/www/html
SCHEMASPY_PATH	OPTIONAL - The path to the SchemaSpy jar file. Defaults to lib/schemaspy.jar. Changing this requires additional code and configuration changes, so it's best to leave it alone.	lib/schemaspy.jar

Configuration - Backward Compatibility

The following environment variables are provided for drop-in backward compatibility with the previous SchemaSpy container implementation that only supported PostgreSQl databases (https://github.com/bcgov/SchemaSpy).

Name	Description	Example
DATABASE_SERVICE_NAME	Use DATABASE_HOST moving forward. The hostname of the server	postgresql
POSTGRESQL_USER	Use DATABASE_USER moving forward. The username to use when logging into the database. When using OpenShift this should be configured as a secrete.	my_user
POSTGRESQL_PASSWORD	Use DATABASE_PASSWORD moving forward. The password to use when logging into the database. When using OpenShift this should be configured as a secrete.	my_password
POSTGRESQL_DATABASE	Use DATABASE_NAME moving forward. The name of the database to document.	MyDatabase

Running in OpenShift

The Dockerfile was designed to generate an image that can be used in OpenShift.

As a quick-start (example), the following command will create a BuildConfig, DeploymentConfig, and ancillary resources (service, etc.) in your current OpenShift project.

oc new-app https://github.com/bcgov/SchemaSpy -e DATABASE_TYPE=pgsql -e DATABASE_NAME=default -e DATABASE_HOST=postgresql -e DATABASE_USER=django -e DATABASE_PASSWORD=xyz1234

For more a more structured build and deployment environment, OpenShift templates can be found in the OpenShift templates folder.

Use on other databases

Oracle

The Oracle JDBC drivers are downloaded from Maven Central and built into the image automatically, so no separate image or manual driver download is required.

Using the Oracle Thin drivers it is easy to connect to an Oracle database.

docker build -t 'schema-spy' .

You can then use the oc-push-image.sh from OpenShift Scripts to push the image to your OpenShift project.

For example:

oc-push-image.sh -i schema-spy -n devex-von-bc-registries-agent-tools

Configuration:

Name	Value	Description
DATABASE_TYPE	orathin
DATABASE_NAME	CUAT	The Oracle SID
DATABASE_SCHEMA	COLIN_MGR_UAT	The Oracle Schema
DATABASE_CATALOG	CUAT.bcgov	The Oracle Listener Service Name
DATABASE_USER	username
DATABASE_PASSWORD	*****
DATABASE_HOST	hostname:portnumber	Hostname and port number MUST be specified.
DATABASE_DRIVER	lib/ora-jdbc.jar

The resulting SchemaSpy command looks something like this;

java -jar lib/schemaspy.jar -t "orathin" -db "CUAT" -dp "lib/ora-jdbc.jar" -s "COLIN_MGR_UAT" -cat "CUAT.bcgov" -u "username" -p "*****" -host "hostname:portnumber" -o /var/www/html

Oracle - Through PostgreSQL oracle-fdw

Work in progress ...

A custom database configuration, pgsql-oracle-fdw.properties, has been started for this purpose.

This allows SchemaSpy to query and graph the Foreign tables imported into PostgreSQL by oracle-fdw.

Current Limitations

The oracle-fdw import process does not import any of the table constraints/relationships for any of the imported tables: since it wouldn't make sense to have constraints on the foreign tables, because PostgreSQL cannot guarantee that these constraints would be satisfied.

Therefore, SchemaSpy will see the tables, but will be unable to wire up the relationships between the tables. The result is a set of orphaned tables.

The recommended approach to fix this issue is to define a set of foreign tables on Oracle's catalog tables. From there it should be possible to write a custom selectCheckConstraintsSql query for the pgsql-oracle-fdw.properties file that can provide SchemaSpy with the information it requires to wire the relationships between the tables.

This requires updates to the following projects;

• openshift-postgresql-oracle_fdw

  • Update to import the Oracle catalog tables.

• SchemaSpy - this project

  • Write and test a custom selectCheckConstraintsSql query for the pgsql-oracle-fdw.properties file.

Example Configuration:

Name	Value	Description
DATABASE_TYPE	pgsql-oracle-fdw	Tells SchemaSpy to use the pgsql-oracle-fdw.properties configuration file.
DATABASE_NAME	BC_REGISTRIES	The name of the database from the PostgrSQL perspective.
DATABASE_SCHEMA	bc_registries	The name of the schema from the PostgrSQL perspective.
DATABASE_USER	username	The username for the related PostgrSQL database.
DATABASE_PASSWORD	*****	The password for the related PostgrSQL database.
DATABASE_HOST	postgresql-oracle-fdw	The host of the PostgrSQL database.

Code of Conduct

Please refer to the Code of Conduct

Contributing

What to add support for additional database types, or add additional features?

For information on how to contribute, refer to Contributing

License

The source code contained in this repository is released under the Apache License, Version 2.0.