Skip to content

Commit 1fd1613

Browse files
committed
docs(eql): explain how to install EQL
1 parent b54d4f5 commit 1fd1613

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,27 @@ TODO: Add instructions for running Proxy locally
208208

209209
### Setting up the database schema
210210

211-
TODO: Add instructions for setting up the database schema
211+
Under the hood, Proxy uses [CipherStash Encrypt Query Language](https://github.com/cipherstash/encrypt-query-language/) to index and search encrypted data.
212+
213+
When you start the Proxy container, you can install EQL by setting the `CS_DATABASE__INSTALL_EQL` environment variable:
214+
215+
```bash
216+
CS_DATABASE__INSTALL_EQL=true
217+
```
218+
219+
This will install the version of EQL bundled with the Proxy container.
220+
The version of EQL bundled with the Proxy container is tested to work with that version of Proxy.
221+
222+
If you are following the [getting started](#getting-started) guide above, EQL is automatically installed for you.
223+
You can also install EQL by running [the installation script](https://github.com/cipherstash/encrypt-query-language/releases) as a database migration in your application.
224+
225+
Once you have installed EQL, you can see what version is installed by querying the database:
226+
227+
```sql
228+
SELECT cs_eql_version();
229+
```
230+
231+
This will output the version of EQL installed.
212232

213233
#### Creating columns with the right types
214234

0 commit comments

Comments
 (0)