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

Records grouping #3721

Merged
merged 15 commits into from
Aug 6, 2024
Merged

Records grouping #3721

merged 15 commits into from
Aug 6, 2024

Conversation

mathemancer
Copy link
Contributor

Related to #3690

Adds a number of SQL functions that produce groupings of records when required. The grouping object submitted should have the keys columns and (optionally) preproc.

The resulting grouping object will have the keys columns, preproc, and groups.

The values associated with each of these keys are the same as in the REST API.

Technical details

The new functionality is documented, and if the documentation is insufficient to understand how this works, or the needed request format, please request an improvement.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@mathemancer mathemancer requested a review from Anish9901 August 1, 2024 15:22
@mathemancer mathemancer added this to the Beta milestone Aug 1, 2024
@mathemancer mathemancer added the pr-status: review A PR awaiting review label Aug 1, 2024
@mathemancer
Copy link
Contributor Author

@Anish9901 This can be reviewed, I've just marked it as a draft since it depends on #3708, and should not be merged until after that one.

Base automatically changed from records_search_rank to develop August 2, 2024 10:51
@mathemancer mathemancer marked this pull request as ready for review August 5, 2024 01:06
Copy link
Member

@Anish9901 Anish9901 left a comment

Choose a reason for hiding this comment

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

This looks great @mathemancer, I've requested some minor changes after which this can be merged.

mathesar/rpc/records.py Outdated Show resolved Hide resolved
db/sql/test_00_msar.sql Outdated Show resolved Hide resolved
db/sql/00_msar.sql Show resolved Hide resolved
@Anish9901
Copy link
Member

@mathemancer we should probabaly also metion somewhere that ordering is nessasary for grouping to work as intended.

Copy link
Contributor Author

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

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

Review comment so my pending comments will show 💩 💩

db/sql/00_msar.sql Show resolved Hide resolved
db/sql/test_00_msar.sql Outdated Show resolved Hide resolved
@mathemancer
Copy link
Contributor Author

@mathemancer we should probabaly also metion somewhere that ordering is nessasary for grouping to work as intended.

I'm not sure. The REST API works the same way, and (in my mind) these operations should be thought of separately. There are other possible UIs that would (for example) just annotate each row with its group ID and/or count.

@mathemancer mathemancer enabled auto-merge August 6, 2024 04:35
@mathemancer mathemancer added this pull request to the merge queue Aug 6, 2024
Merged via the queue into develop with commit 77e5f9b Aug 6, 2024
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: review A PR awaiting review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants