Skip to content

Commit ae034fc

Browse files
CDThomasCDThomas
committed
Remove mention of "websearch_to_match" as q (for query) value
This change removes the mention of `"websearch_to_match"` as a possible value for the `q` (for query) field in the EQL plaintext payload. We're considering adding `"websearch_to_match"` to support functionality similar to PG's built in `websearch_to_tsquery` function, but this hasn't been implemented.
1 parent e44b9a2 commit ae034fc

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

‎README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -643,20 +643,20 @@ The format is defined as a [JSON Schema](./cs_encrypted_v1.schema.json).
643643
It should never be necessary to directly interact with the stored `jsonb`.
644644
CipherStash Proxy handles the encoding, and EQL provides the functions.
645645
646-
| Field | Name | Description |
647-
| ----- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
648-
| s | Schema version | JSON Schema version of this json document. |
649-
| v | Version | The configuration version that generated this stored value. |
650-
| k | Kind | The kind of the data (plaintext/pt, ciphertext/ct, encrypting/et). |
651-
| i.t | Table identifier | Name of the table containing encrypted column. |
652-
| i.c | Column identifier | Name of the encrypted column. |
653-
| p | Plaintext | Plaintext value sent by database client. Required if kind is plaintext/pt or encrypting/et. |
654-
| q | For query | Specifies that the plaintext should be encrypted for a specific query operation. If `null`, source encryption and encryption for all indexes will be performed. Valid values are `"match"`, `"ore"`, `"unique"`, `"ste_vec"`, `"ejson_path"`, and `"websearch_to_match"`. |
655-
| c | Ciphertext | Ciphertext value. Encrypted by Proxy. Required if kind is plaintext/pt or encrypting/et. |
656-
| m | Match index | Ciphertext index value. Encrypted by Proxy. |
657-
| o | ORE index | Ciphertext index value. Encrypted by Proxy. |
658-
| u | Unique index | Ciphertext index value. Encrypted by Proxy. |
659-
| sv | STE vector index | Ciphertext index value. Encrypted by Proxy. |
646+
| Field | Name | Description |
647+
| ----- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
648+
| s | Schema version | JSON Schema version of this json document. |
649+
| v | Version | The configuration version that generated this stored value. |
650+
| k | Kind | The kind of the data (plaintext/pt, ciphertext/ct, encrypting/et). |
651+
| i.t | Table identifier | Name of the table containing encrypted column. |
652+
| i.c | Column identifier | Name of the encrypted column. |
653+
| p | Plaintext | Plaintext value sent by database client. Required if kind is plaintext/pt or encrypting/et. |
654+
| q | For query | Specifies that the plaintext should be encrypted for a specific query operation. If `null`, source encryption and encryption for all indexes will be performed. Valid values are `"match"`, `"ore"`, `"unique"`, `"ste_vec"`, and `"ejson_path"`. |
655+
| c | Ciphertext | Ciphertext value. Encrypted by Proxy. Required if kind is plaintext/pt or encrypting/et. |
656+
| m | Match index | Ciphertext index value. Encrypted by Proxy. |
657+
| o | ORE index | Ciphertext index value. Encrypted by Proxy. |
658+
| u | Unique index | Ciphertext index value. Encrypted by Proxy. |
659+
| sv | STE vector index | Ciphertext index value. Encrypted by Proxy. |
660660
661661
## Helper packages
662662

0 commit comments

Comments
 (0)