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

Propose changes to record summaries for beta #114

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

seancolsen
Copy link
Contributor

@seancolsen seancolsen commented May 7, 2024

This PR describes my plans for the changes to record summaries for beta.

Rendered

@seancolsen
Copy link
Contributor Author

seancolsen commented May 7, 2024

@kgodey @mathemancer @pavish I've assigned you so that you can review these plans. Let me know if you have any questions, concerns, or critique.

Copy link
Contributor

@kgodey kgodey left a comment

Choose a reason for hiding this comment

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

This all seems fine to me. I think the syntax changes are fine as long as the UX makes sense. I know the UX is still TBD, but when we do have it figured out, I want to make sure the UX does the following:
(1) provides the user a GUI way to select columns, including transitive columns.
(2) explains the syntax to the user in case they just want to enter text.

A nice to have would be helping the user understand how their syntax is wrong if there's some sort of syntactical error.

@kgodey kgodey removed their assignment May 10, 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.

I remember having some arguments collegial discussions at the beginning of the record summary work wherein my position was that the data needed to fill record summaries was already gettable though the joinable_tables and associated infrastructure in the data explorer. That's still true, and I still think we should reuse as much of that stuff as possible. I think, unless I'm missing some important details, that this should be well aligned with your goals of making these more general and query-like for extensibility in the long run. It also avoids having two big heavy machines dedicated to automatically joining tables together and using the results for some kind of display.

For this spec specifically, the only change (I think) needed is to use the current join path data structure for the join specifications, and to emphasize that the front end is responsible for putting names to IDs for showing the user (using info returned from the back end, of course). Then, if we're doing that, then SQL-style quoting and escaping isn't necessary.

Comment on lines +62 to +72
```json
[
[2],
", by ",
[10, 2],
" ",
[10, 3]
]
```

That means: first include a reference to the column in the base table having attnum 2; then include a string literal, then include a reference to a column that can be found by joining on the FK at column 10 and finding column with attnum 2 in the joined table... and so on.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should reuse the fkey_path and/or jp_path structures we already have defined for holding this info. Out of curiosity , are you planning to be able to go multiple joins deep? In that case I really think we should use the more involved structures. They're more flexible in the long-run since they can handle arbitrary joins (at least in the case of jp_path). It also lets us reuse some machinery we've already build for getting the needed info (see 1_msar_joinable_tables.sql for example).

Copy link
Member

@pavish pavish 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. I do not have any concerns.

@pavish pavish removed their assignment May 27, 2024
Copy link

This pull request has not been updated in 45 days and is being marked as stale. It will automatically be closed in 30 days if not updated by then.

@github-actions github-actions bot added the stale May be out of date label Jul 11, 2024
@mathemancer mathemancer removed the stale May be out of date label Jul 29, 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
No open projects
Development

Successfully merging this pull request may close these issues.

4 participants