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

Implement explorations.run RPC endpoint #3696

Merged
merged 13 commits into from
Aug 1, 2024
Merged

Conversation

Anish9901
Copy link
Member

@Anish9901 Anish9901 commented Jul 18, 2024

Fixes #3715

Important

Some notable changes to the request object.

  • base_table -> base_table_oid
  • id -> attnum
  • jp_path -> join_path
  • join_path should be an ordered list of in the form [[left_table_oid, attnum], [right_table_oid, attnum]]
Request
{
  "base_table_oid": 2254329,
  "initial_columns": [
    {"attnum": 2, "alias": "Checkouts_Item"},
    {
      "attnum": 5,
      "alias": "Books_Page Count",
      "join_path": [
        [ [2254329, 2], [2254334, 1] ],
        [ [2254334, 5], [2254321, 1] ]
      ]
    }
  ],
  "transformations": [],
  "display_names": {
    "Checkouts_Item"  : "Checkouts_Item"  ,
    "Books_Page Count": "Books_Page Count"
  }
}
Response
{
  "query": {
    "base_table_oid": 2254329,
    "initial_columns": [
      {"attnum": 2, "alias": "Checkouts_Item"},
      {
        "attnum": 5,
        "alias": "Books_Page Count",
        "join_path": [
          [ [2254329, 2], [2254334, 1] ],
          [ [2254334, 5], [2254321, 1] ]
        ]
      }
    ],
    "transformations": [],
    "display_names": {
      "Checkouts_Item"  : "Checkouts_Item"  ,
      "Books_Page Count": "Books_Page Count"
    }
  },
  "records": {
    "count": 14929,
    "results": [
      {"Checkouts_Item":  1, "Books_Page Count": 368},
      {"Checkouts_Item":  1, "Books_Page Count": 368},
      {"Checkouts_Item":  1, "Books_Page Count": 368},
      {"Checkouts_Item":  1, "Books_Page Count": 368},
      {"Checkouts_Item":  1, "Books_Page Count": 368},
      {"Checkouts_Item":  1, "Books_Page Count": 368},
      {"Checkouts_Item":  1, "Books_Page Count": 368},
      [...more]
    ]
  },
  "output_columns": ["Checkouts_Item", "Books_Page Count"],
  "column_metadata": {
    "Checkouts_Item": {
      "alias": "Checkouts_Item",
      "display_name": "Checkouts_Item",
      "type": "integer",
      "type_options": null,
      "display_options": null,
      "is_initial_column": true,
      "input_column_name": "Item",
      "input_table_name": "Checkouts",
      "input_table_id": 2254329,
      "input_alias": null
    },
    "Books_Page Count": {
      "alias": "Books_Page Count",
      "display_name": "Books_Page Count",
      "type": "integer",
      "type_options": null,
      "display_options": null,
      "is_initial_column": true,
      "input_column_name": "Page Count",
      "input_table_name": "Books",
      "input_table_id": 2254321,
      "input_alias": null
    }
  },
  "parameters": {}
}

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.

@Anish9901 Anish9901 requested a review from mathemancer July 30, 2024 18:34
@Anish9901 Anish9901 added the pr-status: review A PR awaiting review label Jul 30, 2024
@Anish9901 Anish9901 marked this pull request as ready for review July 30, 2024 18:36
Copy link
Contributor

@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.

Overall, things look good and I like the methodology. I did request a change which should be pretty simple for the API-facing function signature. The reason is that I'd like to align this with the records.list call style when it's easy, and that seems like low-hanging fruit.

mathesar/rpc/explorations.py Outdated Show resolved Hide resolved
mathesar/rpc/explorations.py Outdated Show resolved Hide resolved
mathesar/rpc/explorations.py Outdated Show resolved Hide resolved
mathesar/utils/explorations.py Outdated Show resolved Hide resolved
@Anish9901
Copy link
Member Author

I do think that we should make the documentation for the transformations better but I don't have enough context on how its used by the frontend.

@Anish9901 Anish9901 requested a review from mathemancer July 31, 2024 21:14
Copy link
Contributor

@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.

This looks good to me.

@mathemancer mathemancer added this pull request to the merge queue Aug 1, 2024
Merged via the queue into develop with commit 2cc1223 Aug 1, 2024
37 checks passed
@mathemancer mathemancer deleted the explorations_run branch August 1, 2024 05:17
@kgodey kgodey added this to the Pre-beta test build #1 milestone Sep 18, 2024
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.

Implement explorations.run RPC method
3 participants