Skip to content

Commit

Permalink
Merge pull request #511 from openreferral/PATCH-signpost-database-sch…
Browse files Browse the repository at this point in the history
…emas

Guidance page on docs to signpost database schema files

Merging as no objections raised by the technical committee
  • Loading branch information
mrshll1001 authored Sep 5, 2024
2 parents 35abce1 + deea05f commit cb2271e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/hsds/database_schemas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Database Schemas
=================

```{note}
This page is *non-normative*, which means that it doesn't form part of the standard; if there is any ambiguity, the standard takes precedence. This page may be updated at any time in response to community demand.
```

HSDS is an exchange format designed to standardise the format for outputting machine-readable data about human services. Therefore systems which output HSDS are not expected to maintain a particular internal database or storage schema. As long as your published data matches HSDS – you can design your systems to operate however you wish.

This being established, we provide some pre-rolled database schemas in order to support people and organizations bootstrapping systems which will work with HSDS data. We provide these in the form of `.sql` query files which — when executed in an appropriate environment — will generate database schemas with tables useful for storing and retrieving HSDS data. We geneate these files directly from the HSDS schema files, so they update as we release new versions of the specification.

You can find the latest version of these files in the `/database` directory of the HSDS Specification Github repository. We provide versions for each SQL and PostgreSQL format databases. The files for HSDS version 3.1 are linked below:

* [Database schemas for HSDS 3.1](https://github.com/openreferral/specification/tree/3.1/database)
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ Contents:
hsds/extending
hsds/using_profiles
hsds/field_guidance
hsds/database_schemas
.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit cb2271e

Please sign in to comment.