Skip to content

Commit

Permalink
Attempt to reword section on backward compatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyMcCormick committed Dec 11, 2024
1 parent e256231 commit 12238f4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/APDB.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The versioning system of the APDB is outlined in [DMTN-269](https://dmtn-269.lss
The deployed database schema is a product of the [schema in sdm_schemas](../python/lsst/sdm_schemas/schemas/apdb.yaml) and processing by tools in the [dax_apdb](https://github.com/lsst/dax_apdb) repository.
Compatibility of the client executable with the actual database schema is determined by the version number in `apdb.yaml` and that which is stored in the database metadata.

Backward compatibility in the context of the APDB implies that a client using an interface derived from a schema with a higher `MINOR` version number will be able to read and write into a database with a lower `MINOR` version -- in other words, an existing APDB need not be migrated to match newer clients.
But a client using a lower `MINOR` version number will not be compatible with a database that contains the changes from a higher version.
Backward compatibility in the context of the APDB implies that a client using a schema with a higher minor version will be able to read and write into a database with a lower minor version -- in other words, an existing database instance need not be migrated to match the newer client interface.
But a client using a schema with a lower minor version will be incompatible with a database that has a higher version number.
There may be cases where significant schema changes may still be compatible if the client can handle them transparently.

Typical Schema Changes
Expand Down

0 comments on commit 12238f4

Please sign in to comment.