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 tables.get_import_preview RPC endpoint #3635

Merged
merged 15 commits into from
Jun 27, 2024
Merged

Conversation

Anish9901
Copy link
Member

Fixes #3634

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 marked this pull request as ready for review June 24, 2024 22:07
@Anish9901 Anish9901 requested a review from mathemancer June 24, 2024 22:07
@Anish9901 Anish9901 added the pr-status: review A PR awaiting review label Jun 24, 2024
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, I think this PR is quite tidy, and well-put-together. I would request that you more closely replicate the logic from the Python version, since it shouldn't add too much difficulty and it avoids a class of error that we currently handle gracefully (i.e., the current python version handles gracefully).

Comment on lines 2506 to 2518
WITH preview_cte AS (
SELECT string_agg(
'CAST(' ||
__msar.build_cast_expr(
msar.get_column_name(tab_id, (col_cast ->> 'attnum')::integer), col_cast -> 'type' ->> 'name'
) ||
' AS ' ||
msar.build_type_text(col_cast -> 'type') ||
')'|| ' AS ' || msar.get_column_name(tab_id, (col_cast ->> 'attnum')::integer),
', '
) AS cast_expr
FROM jsonb_array_elements(col_cast_def) AS col_cast
WHERE NOT msar.is_mathesar_id_column(tab_id, (col_cast ->> 'attnum')::integer)
Copy link
Contributor

Choose a reason for hiding this comment

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

There's a bug here (or at least it throws an exception when the old function didn't) whenever the table doesn't have an id column. I think you should extract some kind of get column or cast expression function from this so you can sort that out more smoothly (similarly to the python version; it should just return the column name for its expression when appropriate, and the cast blob otherwise).

Copy link
Member Author

@Anish9901 Anish9901 Jun 25, 2024

Choose a reason for hiding this comment

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

I don't think I quite understand the bug you are referring to, since the function(get_preview) is meant to be able to preview a mathesar table which is guaranteed to have an id col, I've taken the liberty to assume that it'll always be present for a table which is being previewed. id is also essential as it provides as a means for the returned records to be uniquely identifiable.

it should just return the column name for its expression when appropriate, and the cast blob otherwise

What's the downside of having a cast blob for a column where both target and column_type are same? I guess it would be a little efficient if we only use column name in such case but is it worth giving up the readability?

Copy link
Contributor

Choose a reason for hiding this comment

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

I suppose I'm okay with just casting all columns (including id). I realize that in our current UI flow, the preview is only used for importing, but that's not enforced by the API, and the function itself is quite useful for previewing any proposed change to the column types of a table. Thus, I'd prefer avoiding breaking the current functionality that lets the function be used against any table regardless of whether it has an id column.

Copy link
Member Author

Choose a reason for hiding this comment

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

Cool, I've made the requested changes in a20e663.

Base automatically changed from table_import to develop June 26, 2024 08:08
@Anish9901 Anish9901 requested a review from mathemancer June 26, 2024 10:55
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.

Great, LGTM.

@mathemancer
Copy link
Contributor

@Anish9901 You can merge once the conflicts are resolved, or re-request review if you think the merge resolution is complicated enough to warrant it.

@Anish9901 Anish9901 enabled auto-merge June 27, 2024 09:53
@Anish9901 Anish9901 added this pull request to the merge queue Jun 27, 2024
Merged via the queue into develop with commit 6f003e5 Jun 27, 2024
39 checks passed
@Anish9901 Anish9901 deleted the import_preview branch June 27, 2024 10:20
@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 tables.get_import_preview RPC method
3 participants