From 89aa0b2b4a65abc7650b559d0343b3087d086f0f Mon Sep 17 00:00:00 2001 From: Matt Marshall Date: Tue, 6 Aug 2024 11:55:51 +0100 Subject: [PATCH 1/2] Docs: New page for signposting sql files Added a new page for signposting the sql files which bootstrap HSDS-compatible databases. Page emphasises that HSDS is primarily designed for *exchange* and therefore database internals are left up to the implementor. --- docs/hsds/database_schemas.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/hsds/database_schemas.md diff --git a/docs/hsds/database_schemas.md b/docs/hsds/database_schemas.md new file mode 100644 index 0000000..6a40be3 --- /dev/null +++ b/docs/hsds/database_schemas.md @@ -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) From 00e3e367a615e66e2af276ee90eb41da5a6b6725 Mon Sep 17 00:00:00 2001 From: Matt Marshall Date: Tue, 6 Aug 2024 12:01:15 +0100 Subject: [PATCH 2/2] Docs: Add new page to main toc --- docs/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.md b/docs/index.md index 79eff0b..31e81bd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -86,6 +86,7 @@ Contents: hsds/extending hsds/using_profiles hsds/field_guidance + hsds/database_schemas .. toctree:: :maxdepth: 1