[FOLIO-2879] Collect schema.json and add to Source-code map Created: 17/Nov/20  Updated: 23/Nov/20  Resolved: 23/Nov/20

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: New Feature Priority: TBD
Reporter: Julian Ladisch Assignee: David Crossley
Resolution: Done Votes: 0
Labels: devdoc, devops, devops-backlog
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Sprint: DevOps: Sprint 102
Development Team: FOLIO DevOps

 Description   

RMB based storage module define database indexes and some data fields in the schema.json file. This is important information when created CQL queries.

Usually schema.json is at /blob/master/src/main/resources/templates/db_scripts/schema.json within the repository, there are a few exceptions with an additional subdirectory.

Some examples:

https://github.com/folio-org/mod-organizations-storage/blob/master/src/main/resources/templates/db_scripts/schema.json
https://github.com/folio-org/mod-calendar/blob/master/src/main/resources/templates/db_scripts/schema.json
https://github.com/folio-org/mod-circulation-storage/blob/master/src/main/resources/templates/db_scripts/schema.json
https://github.com/folio-org/mod-configuration/blob/master/mod-configuration-server/src/main/resources/templates/db_scripts/schema.json
https://github.com/folio-org/mod-courses/blob/master/src/main/resources/templates/db_scripts/schema.json
https://github.com/folio-org/mod-data-export/blob/master/src/main/resources/templates/db_scripts/schema.json
https://github.com/folio-org/mod-data-import/blob/master/src/main/resources/templates/db_scripts/schema.json
https://github.com/folio-org/mod-data-import-converter-storage/blob/master/mod-data-import-converter-storage-server/src/main/resources/templates/db_scripts/schema.json
https://github.com/folio-org/mod-email/blob/master/src/main/resources/templates/db_scripts/schema.json

A link to the schema.json file could be listed on the Source-code map page, example:

GitHub schema.json: https://github.com/folio-org/mod-email/blob/master/src/main/resources/templates/db_scripts/schema.json



 Comments   
Comment by David Crossley [ 17/Nov/20 ]

Good idea, thanks.

Comment by David Crossley [ 23/Nov/20 ]

Done.

See usage notes at https://dev.folio.org/source-code/map/#db-schema

See example at: https://dev.folio.org/source-code/map/#mod-inventory-storage

Comment by Julian Ladisch [ 23/Nov/20 ]

Very nice, thank you!

Generated at Thu Feb 08 23:23:56 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.