[OPEN-ILS-DOCUMENTATION] Schema Documentation

[Ben Shum]

Hi Josh,

I started looking to see if I could find it and all I can gather so
far is that it's probably still using some variation on postgresql
autodoc.

Some links to older versions / discussions:

http://markmail.org/thread/kmkqi5alz26qnnqs
http://markmail.org/message/nsvvt35vl2ltaym5

And slightly more recently, I found this in a DIG meeting minutes for
Evergreen 2.3 (see 4.g):

http://evergreen-ils.org/meetings/evergreen/2013/evergreen.2013-01-10-14.00.html

Looking back to those earlier 2.3 schema, I can see that they also had
that odd .table in the reference link, but it was also an actual link
to the real table.  So that too has changed over time.

Guess we'll have to check with Robert / Yamil to see how this is all
handled with more modern versions.

-- Ben


On Fri, Apr 8, 2016 at 9:52 AM, Josh Stompro <stomproj at exchange.larl.org> wrote:
> Hello, does anyone have docs on how the schema documentation is generated.
> I’m curious about two things.
>
> http://docs.evergreen-ils.org/2.8/schema/
>
>
>
> Why are the REFERENCES lines the way they are.  For example in the
> asset.copy docs – status shows up as
>
> status integer NOT NULL REFERENCES config.table.copy-status
>
>
>
> Why is “.table” added and why are underscores changed to dashes.  The actual
> table is “config.copy_status” not “config.table.copy-status”.  This adds
> extra work if you want to copy and paste the table into a join statement for
> example.
>
>
>
> Second question: would SQL COMMENTS on each field and table be able to be
> shown in the schema docs.  I’ve worked on adding comments long ago to the
> schema (http://markmail.org/message/ooiea4nyclnul3cs) and it would be great
> if those comments could be displayed if I ever start that project back up
> again.
>
>
>
> Josh
>
>
>
> Lake Agassiz Regional Library - Moorhead MN larl.org
>
> Josh Stompro     | Office 218.233.3757 EXT-139
>
> LARL IT Director | Cell 218.790.2110
>
>
>
>
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
>