Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start writing supported queries #17

Merged
merged 4 commits into from
Dec 20, 2024
Merged

Conversation

yujiyokoo
Copy link
Collaborator

This is an attempt at filling in the supported queries section

@yujiyokoo yujiyokoo force-pushed the update-supported-queries branch from bfacca6 to 3e8d5c4 Compare December 16, 2024 03:22
@yujiyokoo yujiyokoo marked this pull request as ready for review December 16, 2024 03:25

| EncryptedValue subclass | Supported lookups | Supported index type |
|-------------------------|----------------------------------|----------------------|
| EncryptedText | eq (EncryptedUniqueEquals) | "unique" |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest putting anything that is a class name or "symbol" in backticks. EncryptedText instead of EncryptedText.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EncryptedText also supports ORE but its only useful for ORDER BY. Maybe we could add that later because I think we don't yet support ordering in eqlpy, right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ORDER BY is supported ilke this: Customer.objects.order_by(CsOre648V1(F("name")).desc()).values().all() so we coulld add it but that may require further explanation. I don't know if we can make it simpler than that without doing a lot of work

Copy link
Contributor

@coderdan coderdan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small suggestions.

* use backticks for identifiers
* update example to use 'customers'
* add links to EQL value types
@yujiyokoo yujiyokoo merged commit eb3057f into updated-docs Dec 20, 2024
@yujiyokoo yujiyokoo deleted the update-supported-queries branch December 20, 2024 01:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants