Hosting for SchemaSpy (currently hosted on phoenix.dataverse.org)

[pdurbin]

Long ago I configured http://phoenix.dataverse.org/schemaspy/latest/index.html to host schema information about the Dataverse database. I often link to this site when helping people understand something about the database. I also wrote it up in the dev guide at http://guides.dataverse.org/en/4.20/developers/tips.html#schemaspy

The phoenix server is being shut down at some point so we need to find alternative hosting for these docs.

As indicated in the screenshot above, the script to build the SchemaSpy docs can be found at https://github.com/IQSS/dataverse/blob/v4.20/scripts/deploy/phoenix.dataverse.org/post#L15 . It's a oneliner: java -jar downloads/schemaSpy_5.0.0.jar -t pgsql -host localhost -db dvndb -u postgres -p secret -s public -dp scripts/installer/pgdriver/postgresql-42.2.9.jar -o /var/www/html/schemaspy/latest

[donsizemore]

@pdurbin Permanent web-hosting would be great, but this strikes me as an excellent workflow to Dockerize.

[pdurbin]

People seem to like the SchemaSpy diagrams. @BPeuch just said, "Wow, that ER diagram of Dataverse's database rocks, Philip! Thanks for posting it."

One thing I didn't mention when I opened this issue is that builds are no longer happening on the phoenix server so the diagrams hosted there are increasing out of date as the database evolves.

[BPeuch]

That's good to know, @pdurbin. Thanks for tagging me. We hope an alternative representation system can be found.

[donsizemore]

@pdurbin if it just needs to live somewhere, how about off the root of guides.dataverse.org?

[donsizemore]

@BPeuch I generated this today from a Dataverse 5.4 DB, if you'd like to take a look: https://guides.dataverse.org/en/5.4/schemaspy/

[djbrooke]

Thanks @donsizemore, this is great. I talked with @pdurbin about this a little while ago and he confirmed to me it was most important to have it for a specific version - I was thinking that it needed to be provided on demand for any branches in progress but he said this isn't usually the case. I think if it could be included on the guides server I think it'd be great, thanks for adding it for 5.4!

[pdurbin]

Yeah, @donsizemore and I were discussing this yesterday and I've very happy that once again there is a publicly accessible version of the schemaspy output (I had built my own local version for now). Thanks, Don!

[BPeuch]

Oh this is very practical! Thanks a lot @donsizemore!

I like the network (ER) model, but this is also very handy, especially the neat presentation of columns with the sorting out of IDs and other such categories. 🔧

[pdurbin]

@donsizemore published a version for 5.14: https://guides.dataverse.org/en/5.14/schemaspy/

Thank you, Don!

See also https://groups.google.com/g/dataverse-community/c/f95DQU-wlVM/m/9HcRbaSVBQAJ

[poikilotherm]

This reminds me of https://blog.esciencecenter.nl/versioned-documentation-using-only-github-actions-and-github-pages-1825296e31aa and how we could add such a thing to not just host our guides on Pages, but also include OpenAPI docs, SchemaSpy, JSON Schemas etc etc etc.