Skip to content

Versioning

Initial release🔗

During the initial design and development phase of ehrQL, Data Builder has a v0 major version. With v0, there are no guarantees about backwards compatibility between versions.

Once ehrQL's design has stabilised, and it is suitable for users to use more widely, we will release a ehrQL with version v1.

Any further change to the major version from v1 onwards indicates backwards incompatible changes. For example, a v1 compatible study may require some modification to work with v2 of ehrQL.

Specifying a ehrQL version to use🔗

With ehrQL, specify an available version in your project.yaml, in one of the following formats:

  • major, for example, ehrql:v0
  • minor, for example, ehrql:v0.1

  • patch, for example, ehrql:v0.1.2

  • By specifying a patch version, your code will use the same version of ehrQL.

  • By specifying a major or minor version, your code may run a newer version of ehrQL, once a newer major or minor version becomes available.
  • If running locally, you can update Docker images via the OpenSAFELY CLI.

Changes in the use of latest version🔗

Warning

Research studies often specified cohort-extractor's version as latest.

We no longer support specifying latest as a version.

This change avoids ambiguity over precisely which ehrQL version was used by a given study.

If you do specify latest by mistake, you will instead see an error mentioning manifest unknown. This error tells you that the version is not available.