Database documentation

[Péter Király]

Dear Dataverse users and developers,

I am interested if there is a documentation about the PostgreSQL database?
I haven't found a systematic documentation just some references to
some tables here and there.
Since I would like to understand the system, I started to create a
graph showing the connections of the "important" tables (~ important
for me regarding to the question how Dataverse stores the data).
I don't want to do anything which is duplication of some existing
work, neither over-engeneering. I attached the graph I've created. It
is not very precise in some aspects, at least I don't know what is the
exact relationship between the dvobject.id and datafile.id, and the
graph does not display the cardinality of the relationships.
The entities contain '...' if not all the fields are displayed. They
never contain ids and external identifiers pointing to other tables
(they are displayed as labels of the relationship).

Best,
Péter

--
Péter Király
software developer
GWDG, Göttingen - Europeana - eXtensible Catalog - The Code4Lib Journal
http://linkedin.com/in/peterkiraly

[Sherry Lake]

Hi Peter,

Here are a couple of links I have found, not sure where I got them:

dvndb schematic:

http://phoenix.dataverse.org/schemaspy/latest/index.html

Useful queries for dataverse Postgres database:

https://docs.google.com/document/d/1-Y_iUduSxdDNeK1yiGUxe7t-Md7Fy965jp4o4m1XEoE/edit

Any other documentation, IQSS-dataverse team?

--

Sherry

[Péter Király]

Dear Sherry,

thanks a lot for both links. They are super useful for me, and I was
not aware of them.

Best,
Péter

> --
> You received this message because you are subscribed to the Google Groups "Dataverse Users Community" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to dataverse-commu...@googlegroups.com.
> To post to this group, send email to dataverse...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/dataverse-community/6fad29a0-b012-4e2a-b5ea-0ceacbe27340%40googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

[Philip Durbin]

I recently added the SchemaSpy link to http://guides.dataverse.org/en/4.9.4/developers/tips.html#schemaspy so I guess it's official. :) Feedback on what I wrote there is welcome! I find the SchemaSpy output incredibly useful and I'm glad some others are getting value out of it.

The  "useful queries" doc is pretty awesome and linked from https://github.com/IQSS/dataverse/issues/4169 but I'm not sure what the "definition of done" is for that issue. For now, people should make suggestions to the doc directly.

There are some diagrams under "doc/Architecture" but all of these are years old and might mislead you:

- https://github.com/IQSS/dataverse/blob/v4.9.4/doc/Architecture/DataverseModel-agreed.png

- https://github.com/IQSS/dataverse/blob/v4.9.4/doc/Architecture/UsersAndGroups.png

- https://github.com/IQSS/dataverse/blob/v4.9.4/doc/Architecture/auth-classes.png

If you think we should maintain a few diagrams of important tables, please feel free to create a GitHub issue about this. SchemaSpy requires no manual effort, which is nice. It's triggered every time we run our integration test suite on the "phoenix" server.

dvobject.id and datafile.id should be the same for any file and the same is true for the dataverse and dataset table. This is a JPA thing and you can have a read through https://github.com/IQSS/dataverse/issues/733 if you'd like a deep dive but rather than leaving comments there (which we may not read since the issue is closed) a better place would be a new issue or a new thread on https://groups.google.com/forum/#!forum/dataverse-dev

Thanks,

Phil

To view this discussion on the web visit https://groups.google.com/d/msgid/dataverse-community/CABFhGtkw_ro47q5k7ujCY7EPmOJ2spobnSMZeArVH1P3z%2BPELQ%40mail.gmail.com.

For more options, visit https://groups.google.com/d/optout.

--

Philip Durbin
Software Developer for http://dataverse.org
http://www.iq.harvard.edu/people/philip-durbin

[Péter Király]

Thanks Phill,

you gave me lot to think about.

Best,
Péter
Philip Durbin <philip...@harvard.edu> ezt írta (időpont: 2018.
nov. 15., Cs, 19:24):

> To view this discussion on the web visit https://groups.google.com/d/msgid/dataverse-community/CABbxx8FU%3D1nBpWHyV2bsvezkwLWuhM%3Dv7o%3DBDoNvNXsDhZpDVw%40mail.gmail.com.