Cip 1035 docs #11

coderdan · 2024-12-10T10:48:31Z

No description provided.

* exact matching strings * partial matching strings * ore comparison

* 'examples' is now 'customers' * fields are now age, is_citizen, start_date, weight, name, extra_info instead of encrypted_int etc

auxesis

Good progress, thanks @coderdan.

No problems with the structure, content, or tone.

Have left a bunch of suggested changes to the Markdown to improve readability and maintainability.

I agree with your changes to the SQL to use a customers table. Makes it a bit more concrete and relatable.

README.md

auxesis · 2024-12-10T10:56:54Z

README.md

@@ -45,144 +54,87 @@ pip install eqlpy

 You can find the latest version on the [Python Package Index (PyPI)](https://pypi.org/project/eqlpy).

-## Usage
+TODO: How to install EQL itself?


We can use the instructions from the EQL repo.

README.md

auxesis · 2024-12-10T10:59:22Z

README.md


-Handles boolean values.
+`eqlpy` supports many different data types, including numbers, dates and JSON.
+See the [Reference](#) docs for more information.


Will need to link to the correct anchor.

auxesis · 2024-12-10T11:01:37Z

README.md


-```python
-from datetime import date
+`eqlpy` automatically encrypts values when saving to the database.


Are we describing the future state? Otherwise we'll need to explain this is done via CipherStash Proxy.

Hmm. Yeah good call. I might be getting ahead of myself.

README.md

reference/VALUE_CLASSES.md

Co-authored-by: Lindsay Holmwood <[email protected]>

README.md

yujiyokoo · 2024-12-11T01:59:19Z

README.md


-Handles date values.
+`eqlpy` supports many different data types, including numbers, dates and JSON.
+See the [Reference](#) docs for more information.


Suggested change

See the [Reference](#) docs for more information.

See the [Reference](reference/VALUE_CLASSES.md) docs for more information.

README.md

yujiyokoo · 2024-12-11T02:31:27Z

README.md

 ```

-#### EqlJsonb
+TODO: Show what is contained in the database at this stage.


Suggested change

TODO: Show what is contained in the database at this stage.

This record looks like this when accessed on Proxy:

# select * from customers;

id | is_citizen | start_date | weight | age | name | extra_info | visit_count

-----+------------+------------+--------+-----+----------------------------------------------------------------------------------+------------+-------------

446 | | | | | {"k":"pt","p":"Fred Flintstone","i":{"t":"customers","c":"name"},"v":1,"q":null} | |

(1 row)

and directly on PostgreSQL:

id | is_citizen | start_date | weight | age | name | extra_info | visit_count

-----+------------+------------+--------+-----+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+-------------

446 | | | | | {"c": "mBbL^r9sYr{**CKA_6C{IDN*%A*Hh3Y^S6yIkF*Ez{m&ib*gwg#*A)&{F6mjUwBj_aVx|i6EsZUQXbrN)(~iOu-@!cWr+e^P~2NpGTB?trC@Gwq;6qtWxx", "i": {"c": "name", "t": "customers"}, "k": "ct", "m": [77, 1666, 179, 786, 1429, 976, 2005, 1696, 182, 1317, 405, 1850, 1337, 768, 238, 253, 460, 443, 270, 779, 291, 1008, 1051, 1835, 1860, 1665, 538, 1067, 1914, 793, 272, 591, 684, 1861, 2037, 318, 525, 155, 672, 328, 1035, 853, 388, 1721, 1547, 1705, 613, 852, 1947, 1276, 481, 273, 1494, 1378, 1599, 1434, 319, 1794, 816, 1960, 379, 149, 1131, 1309, 204, 438, 1989, 1718, 29, 1413, 1965, 738, 1324, 2006, 802, 201, 251], "o": "(\"{\"\"(\\\\\"\"\\\\\\\\\\\\\\\\xe3596bf64b97d034fe0d967c6b224819467f41057f2fd61e8f2abb873e2c26b5e937781acd24165f09d73e810d516979bc295f66fa1aae86a457ce97d04e42680bb7160ae1f742ec865c06c1cafe6ad87c41bfdb6cda491e83061ca86f7a523c4edc033132370e51e5971bf3000c2a29a526f49d1323a224dfc782667d741a53c9b88936bef7e0fafb5b7d55cf9fdeb7e567a31ed53bde5b628b7f906421126f29bb5195e88fe8df669d5002bd2ed31db5cd8afe560d7dcbf5400c6e4b9eeba94a00078ee2ca5e138c37735648d2248c483156899c560a52fe7f1e41b6146d5382630bf2895dd0438d4de7f75c0c5ecb5f78f04736fff266a21713f701758c32b3dc8e17e01ea1406ad95c6c5cc950140f22e679b12d799b7a56890ded70188ab5c3a965d88bb9f9bb76d0d5f73746a5a048cbb78a8c18bdc5ebadf689ce881c566811fbf86243dd26ab6764656b86ad14358cf973ae99746ad24d7539362e69289a7de27920366bc619663cf5f7e401a6423eaff8699b95eccaf53989d7dd91af08f574932c1b79d89c95973d4dc45e0cfc3fdd0c7bf7dd\\\\\"\")\"\", \"\"(\\\\\"\"\\\\\\\\\\\\\\\\xe969121212121212714451b0a9ac6cd7de810a31ee27792a608ff20fb9d707c0d8de75fa2dd800f7b719322d123b4b314e9e08405426fcbb9ae8fb7e5a7ba009f4fa6f8f31d5e6b61fce62db66d1719390d6eae6aa60d89509de194056631376bad1c56db834982cd02cf69aaf7a8dfddeaab23f3ccf7fb0875d4ac3199188ea30b4d508f1e95810ac1274747298cb8afe20c6c8029811106392ce71683068c1b13c69474c9c81ec4a52b0631722d727bc02a801130369b73b38b4a1acf53cbc16c5773995a788fbc8d17f02945a3a95970aeaf4c08675adf13d29e5bca8e5ea09329e9fd41694a0af963c9a4158cac86257d9adbb66c4fa41b1878bec83394369545270e816a5212d6d5b7f18965c181040a3fcddf1b11d0ff90a5812840eaa8c9768705abae4de1749d9c7a2c608e4e7c9191b2501397e8b8566ae9f0b6ca82496ead7418fdc9d4ec243c8b941a67fae006c64022ada7e6679bffa4d557897ebfb488f795fd78032ff91de8cd186f1721ebf911beeac1810effabd0129a70199a609d79c5fbd8f6d24b3e7304c97358e7454d386f7c0f7\\\\\"\")\"\"}\")", "u": "bc9295f8303391f437f07b9298335347cc17a53a52025457456606e98955f7b8", "v": 1} | |

Not sure if you want the PostgreSQL version, but added it anyway. Also, I don't think I can use triple backticks (for code blocks) inside suggestions. So my suggestion is either copy or commit this, then edit as required if it helps...

Co-authored-by: Yuji Yokoo <[email protected]>

Co-authored-by: Lindsay Holmwood <[email protected]>

yujiyokoo · 2024-12-13T08:56:48Z

Token over by #13 so closing this

yujiyokoo and others added 10 commits December 6, 2024 18:01

WIP new query interface for Django

522f725

Add missing import

50c93ea

Add more import

a2e1bba

Remove redundant class definition

096b3bd

Implement ANDing multiple expressions in Django

782b791

Implement some custom lookup for Django

29c9a74

* exact matching strings * partial matching strings * ore comparison

Updathe test table to have more realistic names

edf1f17

* 'examples' is now 'customers' * fields are now age, is_citizen, start_date, weight, name, extra_info instead of encrypted_int etc

Apply formatting

1762c91

Add JSON containment custom lookup

ca3dd5e

Work on new README and start of reference docs

e22f8aa

auxesis reviewed Dec 10, 2024

View reviewed changes

coderdan and others added 5 commits December 10, 2024 22:12

Update README.md

09ef95e

Co-authored-by: Lindsay Holmwood <[email protected]>

Update README.md

5843645

Co-authored-by: Lindsay Holmwood <[email protected]>

Update README.md

fb37ddb

Co-authored-by: Lindsay Holmwood <[email protected]>

Update README.md

678b10d

Co-authored-by: Lindsay Holmwood <[email protected]>

Update reference/VALUE_CLASSES.md

6eb640f

Co-authored-by: Lindsay Holmwood <[email protected]>

yujiyokoo reviewed Dec 11, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

yujiyokoo reviewed Dec 11, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

yujiyokoo reviewed Dec 11, 2024

View reviewed changes

coderdan and others added 3 commits December 11, 2024 16:03

Update README.md

d90ad39

Co-authored-by: Yuji Yokoo <[email protected]>

Update README.md

a1fce6f

Co-authored-by: Yuji Yokoo <[email protected]>

Update README.md

8d1d767

Co-authored-by: Lindsay Holmwood <[email protected]>

yujiyokoo closed this Dec 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cip 1035 docs #11

Cip 1035 docs #11

coderdan commented Dec 10, 2024

auxesis left a comment

auxesis Dec 10, 2024

auxesis Dec 10, 2024

auxesis Dec 10, 2024

coderdan Dec 10, 2024

yujiyokoo Dec 11, 2024

yujiyokoo Dec 11, 2024 •

edited

Loading

yujiyokoo commented Dec 13, 2024

	See the [Reference](#) docs for more information.
	See the [Reference](reference/VALUE_CLASSES.md) docs for more information.

-TODO: Show what is contained in the database at this stage.
+This record looks like this when accessed on Proxy:
+# select * from customers;
+ id  | is_citizen | start_date | weight | age |                                       name                                       | extra_info | visit_count
+ -----+------------+------------+--------+-----+----------------------------------------------------------------------------------+------------+-------------
+|            |            |        |     | {"k":"pt","p":"Fred Flintstone","i":{"t":"customers","c":"name"},"v":1,"q":null} |            |
+  (1 row)
+and directly on PostgreSQL:
+ id  | is_citizen | start_date | weight | age |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | extra_info | visit_count
+-----+------------+------------+--------+-----+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+-------------
+|            |            |        |     | {"c": "mBbL^r9sYr{**CKA_6C{IDN*%A*Hh3Y^S6yIkF*Ez{m&ib*gwg#*A)&{F6mjUwBj_aVx|i6EsZUQXbrN)(~iOu-@!cWr+e^P~2NpGTB?trC@Gwq;6qtWxx", "i": {"c": "name", "t": "customers"}, "k": "ct", "m": [77, 1666, 179, 786, 1429, 976, 2005, 1696, 182, 1317, 405, 1850, 1337, 768, 238, 253, 460, 443, 270, 779, 291, 1008, 1051, 1835, 1860, 1665, 538, 1067, 1914, 793, 272, 591, 684, 1861, 2037, 318, 525, 155, 672, 328, 1035, 853, 388, 1721, 1547, 1705, 613, 852, 1947, 1276, 481, 273, 1494, 1378, 1599, 1434, 319, 1794, 816, 1960, 379, 149, 1131, 1309, 204, 438, 1989, 1718, 29, 1413, 1965, 738, 1324, 2006, 802, 201, 251], "o": "(\"{\"\"(\\\\\"\"\\\\\\\\\\\\\\\\xe3596bf64b97d034fe0d967c6b224819467f41057f2fd61e8f2abb873e2c26b5e937781acd24165f09d73e810d516979bc295f66fa1aae86a457ce97d04e42680bb7160ae1f742ec865c06c1cafe6ad87c41bfdb6cda491e83061ca86f7a523c4edc033132370e51e5971bf3000c2a29a526f49d1323a224dfc782667d741a53c9b88936bef7e0fafb5b7d55cf9fdeb7e567a31ed53bde5b628b7f906421126f29bb5195e88fe8df669d5002bd2ed31db5cd8afe560d7dcbf5400c6e4b9eeba94a00078ee2ca5e138c37735648d2248c483156899c560a52fe7f1e41b6146d5382630bf2895dd0438d4de7f75c0c5ecb5f78f04736fff266a21713f701758c32b3dc8e17e01ea1406ad95c6c5cc950140f22e679b12d799b7a56890ded70188ab5c3a965d88bb9f9bb76d0d5f73746a5a048cbb78a8c18bdc5ebadf689ce881c566811fbf86243dd26ab6764656b86ad14358cf973ae99746ad24d7539362e69289a7de27920366bc619663cf5f7e401a6423eaff8699b95eccaf53989d7dd91af08f574932c1b79d89c95973d4dc45e0cfc3fdd0c7bf7dd\\\\\"\")\"\", \"\"(\\\\\"\"\\\\\\\\\\\\\\\\xe969121212121212714451b0a9ac6cd7de810a31ee27792a608ff20fb9d707c0d8de75fa2dd800f7b719322d123b4b314e9e08405426fcbb9ae8fb7e5a7ba009f4fa6f8f31d5e6b61fce62db66d1719390d6eae6aa60d89509de194056631376bad1c56db834982cd02cf69aaf7a8dfddeaab23f3ccf7fb0875d4ac3199188ea30b4d508f1e95810ac1274747298cb8afe20c6c8029811106392ce71683068c1b13c69474c9c81ec4a52b0631722d727bc02a801130369b73b38b4a1acf53cbc16c5773995a788fbc8d17f02945a3a95970aeaf4c08675adf13d29e5bca8e5ea09329e9fd41694a0af963c9a4158cac86257d9adbb66c4fa41b1878bec83394369545270e816a5212d6d5b7f18965c181040a3fcddf1b11d0ff90a5812840eaa8c9768705abae4de1749d9c7a2c608e4e7c9191b2501397e8b8566ae9f0b6ca82496ead7418fdc9d4ec243c8b941a67fae006c64022ada7e6679bffa4d557897ebfb488f795fd78032ff91de8cd186f1721ebf911beeac1810effabd0129a70199a609d79c5fbd8f6d24b3e7304c97358e7454d386f7c0f7\\\\\"\")\"\"}\")", "u": "bc9295f8303391f437f07b9298335347cc17a53a52025457456606e98955f7b8", "v": 1} |            |

Cip 1035 docs #11

Cip 1035 docs #11

Conversation

coderdan commented Dec 10, 2024

auxesis left a comment

Choose a reason for hiding this comment

auxesis Dec 10, 2024

Choose a reason for hiding this comment

auxesis Dec 10, 2024

Choose a reason for hiding this comment

auxesis Dec 10, 2024

Choose a reason for hiding this comment

coderdan Dec 10, 2024

Choose a reason for hiding this comment

yujiyokoo Dec 11, 2024

Choose a reason for hiding this comment

yujiyokoo Dec 11, 2024 • edited Loading

Choose a reason for hiding this comment

yujiyokoo commented Dec 13, 2024

yujiyokoo Dec 11, 2024 •

edited

Loading