Skip to content

Commit 6c745a6

Browse files
committed
docs: add reference to postgres
1 parent a345884 commit 6c745a6

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Store encrypted data alongside your existing data.
4343

4444
## Installation
4545

46-
The simplest way to get up and running with EQL is to execute the install SQL file directly in your database.
46+
The simplest way to get up and running with EQL is to execute the install SQL file directly in your PostgreSQL database.
4747

4848
1. Download the latest EQL install script:
4949

@@ -68,7 +68,7 @@ You can read more about the EQL concepts and reference guides in the [documentat
6868

6969
## Getting started
7070

71-
Once the custom types and functions are installed, you can start using EQL in your queries.
71+
Once the custom types and functions are installed in your PostgreSQL database, you can start using EQL in your queries.
7272

7373
### Enable encrypted columns
7474

@@ -113,11 +113,11 @@ SELECT cs_refresh_encrypt_config();
113113
```
114114

115115
>Note: This statement must be executed when connected to CipherStash Proxy.
116-
When connected to the database directly, it is a no-op.
116+
When connected to the PostgreSQL database directly, it is a no-op.
117117

118118
## Storing data
119119

120-
Encrypted data is stored as `jsonb` values in the database, regardless of the original data type.
120+
Encrypted data is stored as `jsonb` values in the PostgreSQL database, regardless of the original data type.
121121

122122
You can read more about the data format [here](docs/reference/PAYLOAD.md).
123123

@@ -133,7 +133,7 @@ INSERT INTO users (encrypted_email) VALUES (
133133
);
134134
```
135135

136-
Data is stored in the database as:
136+
Data is stored in the PostgreSQL database as:
137137

138138
```json
139139
{
@@ -175,7 +175,7 @@ Data is returned as:
175175
}
176176
```
177177

178-
>Note: If you execute this query directly on the database, you will not see any plaintext data but rather the `jsonb` payload with the ciphertext.
178+
>Note: If you execute this query directly on the PostgreSQL database, you will not see any plaintext data but rather the `jsonb` payload with the ciphertext.
179179
180180
## Configuring indexes for searching data
181181

@@ -345,7 +345,7 @@ You can read more about the JSONB support in the [JSONB reference guide](docs/re
345345

346346
### How do I integrate CipherStash EQL with my application?
347347

348-
Use CipherStash Proxy to intercept database queries and handle encryption and decryption automatically.
348+
Use CipherStash Proxy to intercept PostgreSQL queries and handle encryption and decryption automatically.
349349
The proxy interacts with the database using the EQL functions and types defined in this documentation.
350350

351351
Use the [helper packages](#helper-packages) to integate EQL functions into your application.

0 commit comments

Comments
 (0)