The schema database diagram in documentation (Storage Layer#RDBMS/DatabaseStructure) is created using DbSchema (15-day free trial available).
During major DSpace version changes, the schema usually changes too. This page details the procedure to update the schema and generate the image to be included in documentation as part of the release procedure.
Connect to DSpace database
- menu Project -> New Project Connected to Database (Ctrl-N)
- Rdbms: Postgres
- Fill in Host name, Port, User, Password, Database name
- Connect
- Select the "public" schema
- A default layout will be generated
Add tables to groups
- Right-click on empty background and choose "Create group of tables" from the context menu
- Fill in group name as per key below (hierarchy, items, ...)
- Check "Override Tables Header Color"
- Click on color picker, RGB tab, fill in Color Code as per key below (ECE3C3, C3ECE3, ...), click OK
- Back in "New group" dialog, include tables from "Tables In No Group" to "Current Group Tables" as per key below
- Click OK
community community2community community_item_count communities2item community2item community2collection collection collection2item collection_item_count harvested_collection
item harvested_item requestitem tasklistitem versionitem workspaceitem workflowitem versionhistory
bundle bundle2bitstream bitstream bitstreamformatregistry fileextension item2bundle most_recent_checksum checksum_results checksum_history
eperson epersongroup epersongroup2eperson epersongroup2workspaceitem group2groupcache group2group registrationdata
metadataschemaregistry metadatafieldregistry metadatavalue dcvalue
handle doi
Rearrange groups and tables
Keep the main hierarchy horizontal (community, collection, item, bundle, bitstream and their mappings)
Export
- Project -> Export as... -> PNG Image
- Crop excessive white background in an image editor
- optipng -o9 dspace5.png
Examples
Example exported image:
DSpace 5 schema in DbSchema's editable .dbs format: dspace5.dbs
DSpace 6 schema in DbSchema's editable .dbs format: dspace6.dbs