|
a |
|
b/docs/reference/backends.md |
|
|
1 |
Dataset definitions written in ehrQL can be run inside different secure |
|
|
2 |
environments, managed by different providers of EHR data. |
|
|
3 |
|
|
|
4 |
For each such secure environment, there is a corresponding "backend" |
|
|
5 |
defined in ehrQL. Each ehrQL backend: |
|
|
6 |
|
|
|
7 |
* specifies the datasets available inside each secure environment |
|
|
8 |
* does the necessary translation work to allow the same |
|
|
9 |
dataset definition to run against data modelled in different ways and |
|
|
10 |
stored in different systems |
|
|
11 |
|
|
|
12 |
When writing a dataset definition you don't need to explicitly reference |
|
|
13 |
any particular backend. But, as not every dataset is available in every |
|
|
14 |
backend, the [table schema](schemas.md) you use to write your dataset |
|
|
15 |
definition will determine which backends it can be run against. |
|
|
16 |
|
|
|
17 |
Below are the backends currently supported in ehrQL, together with the |
|
|
18 |
list of [table schemas](schemas.md) each one supports. |
|
|
19 |
|
|
|
20 |
|
|
|
21 |
---8<-- 'includes/generated_docs/backends.md' |