Listing Views Spec #16

ghislaineguerin · 2021-12-20T11:24:37Z

Specs to implement the design for Support for listing database views

seancolsen

Looking good. I have a few questions about Scenario 1 -- "Schema detail view"

What is the purpose of the "Schema detail view" page? Why do we need it?
How does the user navigate to this page?
What should the URL look like for this page?
What does "Last access" mean? The time I viewed it? The time anyone viewed it? The time someone modified it?

ghislaineguerin · 2021-12-21T16:28:49Z

@seancolsen thanks for the feedback.

What is the purpose of the "Schema detail view" page? Why do we need it?

At some point, as we've discussed in the issue for 'Listing Views' we'll have limits on how many views or tables we can show, and having an overview of the schema might be helpful for this.

How does the user navigate to this page?

The user can navigate to it by clicking on the top nav's schema name.

What should the URL look like for this page?

I'm assuming just database/schema without the selected object at the end. But now I'm wondering if the 'explorer' view allows a 'nothing selected' state and if that's a state that needs to be designed as well. I'll think about this and update.

What does "Last access" mean? The time I viewed it? The time anyone viewed it? The time someone modified it?

Last accessed was added in replacement for 'last updated' as we have no way of knowing that. Accessed would mean the object was opened in the explorer view.

seancolsen · 2021-12-21T17:25:44Z

@ghislaineguerin Here are some thoughts based on your above clarifications:

I don't think we need the "Schema detail view" page. Can we wait to add that page until the need for it becomes stronger? Broadly speaking, I can see the usefulness of the "last accessed" field as a way to quickly find the objects I've been working with recently. But I think we could safely defer this feature until after Alpha. Would you agree?
If we do add that page, then:
- You said:
  
  The user can navigate to it by clicking on the top nav's schema name.
  
  Currently clicking on the schema name will select the schema. So with your proposed functionality, the user would have no way to toggle between viewing separate schemas without first clicking through the "Schema detail view", correct? That seems like a (very minor) UX regression. Would the user have some other way to select a schema without navigating to the "Schema detail view" page?
- You said:
  
  Accessed would mean the object was opened in the explorer view.
  
  I have more questions:
  - Is it the time that the current user last opened the object in the explorer view? Or the time that any user last opened the object in the explorer view?
  - @kgodey do we already have support for this "last accessed" functionality at the API level? I'm curious what events we're using (or would plan to use) at the API level to qualify as as "accessing" the object for this purpose. Maybe we would rely on a GET request to the records API? Or would the be a different mechanism? Perhaps a dedicated endpoint? I'm sure we'll have a more detailed conversation at implementation time, but for now I'm just trying to understand the meaning behind "last accessed", for the purpose of UX.

ghislaineguerin · 2021-12-21T17:51:18Z

@seancolsen I've introduced the 'last accessed functionality based on this comment. The requirements specified 'last updated' which we couldn't determine.

kgodey

@ghislaineguerin Looks good! Please assign me again when it's ready for re-review.

design/specs.md

design/specs/listing-views.md

kgodey · 2022-01-04T19:50:13Z

design/specs/listing-views.md

+
+- User opens a schema and sees the [schema explorer sidebar](#schema-explorer-sidebar).
+- User sees a list of all tables and views for the current schema.
+  - The list shows both object types by default but can be filtered to only show tables or views using the [filter bar](#sidebar-filters) at the top of the sidebar.


I'm wondering if we might want to reuse the filter component (from tables/views) here rather than having tabs. That way, the user has the same experience for all filtering actions.

I think maybe the name filter is misleading. I'll update that to tabs instead. I'd be concerned about having multiple instances of filter and confusing users.

design/specs/listing-views.md

kgodey · 2022-01-04T20:00:31Z

design/specs/listing-views.md

@mathemancer The product goals for the alpha release are to ensure that materialized views that are already present in a database are shown as such to the user. We will not have any other functionality for creating or working with materialized views from the UI.

I don't think it is worth spending much design effort into materialized views until we have better support for them in the product.

Co-authored-by: Kriti Godey <kriti@kritigodey.com>

…thesar-wiki into listing-views-spec

kgodey

@ghislaineguerin Looks good, some minor changes requested.

kgodey · 2022-01-11T18:37:41Z

design/specs/listing-views.md

+
+### Schema Details Page
+
+The schema details page will be shown when a schema is open and notables are selected. It will contain the schema's name, the total number of tables and views, and additional sections that we can use to present the user with relevant information or links. Examples of content that could go into this section are:


Do you mean "no tables" instead of "notables"? I was trying to figure out what a "notable" was. :)

Yup, that was it, I'll fix it. Thanks

kgodey · 2022-01-11T18:38:24Z

design/specs/listing-views.md

+
+The schema details page will be shown when a schema is open and notables are selected. It will contain the schema's name, the total number of tables and views, and additional sections that we can use to present the user with relevant information or links. Examples of content that could go into this section are:
+
+- Recently opened views or tables


Can you add a note here that these are examples and not meant to be part of the implementation of this spec.

If any of these are not examples and should be implemented (maybe recently opened?), please indicate those.

kgodey · 2022-01-11T18:41:01Z

design/specs/listing-views.md

+
+### Regular vs. Materialized Views
+
+Regular views need to be differentiated from materialized views as the use cases might differ. However, we don't want to create a rigid distinction between both as it could confuse users being introduced to the concept of views. For this purpose, an indicator, such as the letter 'M' can be added next to the view icon to show that it is of the type 'Materialized'.


What does "can be added" mean here? Should it be added or not?

@kgodey I did add an indicator to the design. I believe it should be added, I will update the spec to remove the ambiguity.

kgodey

Looks good @ghislaineguerin!

ghislaineguerin added 6 commits December 20, 2021 12:21

add specs for listing views

9d3675d

add scenarios

cb55e74

add search views details

0f73f5f

add search instructions

673f8ee

add component details

393874c

add videos

cd45f16

ghislaineguerin assigned seancolsen, kgodey, dmos62, silentninja, mathemancer and pavish Dec 20, 2021

ghislaineguerin added the status: review In review label Dec 20, 2021

ghislaineguerin marked this pull request as ready for review December 20, 2021 19:29

ghislaineguerin requested a review from a team as a code owner December 20, 2021 19:29

github-actions bot requested review from eito-fis, kgodey, mathemancer, pavish, seancolsen and silentninja and removed request for a team December 20, 2021 19:30

ghislaineguerin added 3 commits December 20, 2021 20:31

add clarification for materialized views

9edb8a7

add listing views to specs list

d1c2c9a

remove null values spec

929530b

seancolsen reviewed Dec 21, 2021

View reviewed changes

seancolsen removed their assignment Dec 21, 2021

update videos

b523298

ghislaineguerin requested review from kgodey and pavish January 4, 2022 10:55

ghislaineguerin assigned kgodey and pavish Jan 4, 2022

ghislaineguerin and others added 3 commits January 4, 2022 11:57

Merge branch 'master' into listing-views-spec

956a9d7

add recent open description

961e827

Merge branch 'master' into listing-views-spec

56252ac

kgodey reviewed Jan 4, 2022

View reviewed changes

kgodey removed their assignment Jan 4, 2022

ghislaineguerin and others added 4 commits January 5, 2022 22:34

Update design/specs.md

86ef45b

Co-authored-by: Kriti Godey <kriti@kritigodey.com>

add notes about materialized views

dc446df

Merge branch 'master' into listing-views-spec

6739e24

Merge branch 'listing-views-spec' of https://github.com/centerofci/ma…

60214ed

…thesar-wiki into listing-views-spec

ghislaineguerin unassigned dmos62, silentninja, mathemancer and pavish Jan 7, 2022

ghislaineguerin requested a review from kgodey January 7, 2022 11:01

ghislaineguerin assigned kgodey Jan 7, 2022

kgodey requested changes Jan 11, 2022

View reviewed changes

kgodey removed their assignment Jan 11, 2022

kgodey added status: waiting A PR that needs follow-up work from its author after review and removed status: review In review labels Jan 11, 2022

kgodey assigned ghislaineguerin Jan 11, 2022

fix content

d724011

kgodey approved these changes Jan 11, 2022

View reviewed changes

ghislaineguerin merged commit 0fe054a into master Jan 11, 2022

ghislaineguerin deleted the listing-views-spec branch January 11, 2022 22:11

kgodey mentioned this pull request Jan 26, 2022

Create engineering implementation issues for Views mathesar-foundation/mathesar#1027

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Listing Views Spec #16

Listing Views Spec #16

ghislaineguerin commented Dec 20, 2021 •

edited

Loading

seancolsen left a comment •

edited

Loading

ghislaineguerin commented Dec 21, 2021

seancolsen commented Dec 21, 2021

ghislaineguerin commented Dec 21, 2021

kgodey left a comment

kgodey Jan 4, 2022

ghislaineguerin Jan 7, 2022

kgodey Jan 4, 2022

kgodey left a comment

kgodey Jan 11, 2022

ghislaineguerin Jan 11, 2022

kgodey Jan 11, 2022

kgodey Jan 11, 2022

kgodey Jan 11, 2022

ghislaineguerin Jan 11, 2022

kgodey left a comment


		### Schema Details Page

		The schema details page will be shown when a schema is open and notables are selected. It will contain the schema's name, the total number of tables and views, and additional sections that we can use to present the user with relevant information or links. Examples of content that could go into this section are:


		The schema details page will be shown when a schema is open and notables are selected. It will contain the schema's name, the total number of tables and views, and additional sections that we can use to present the user with relevant information or links. Examples of content that could go into this section are:

		- Recently opened views or tables


		### Regular vs. Materialized Views

		Regular views need to be differentiated from materialized views as the use cases might differ. However, we don't want to create a rigid distinction between both as it could confuse users being introduced to the concept of views. For this purpose, an indicator, such as the letter 'M' can be added next to the view icon to show that it is of the type 'Materialized'.

Listing Views Spec #16

Listing Views Spec #16

Conversation

ghislaineguerin commented Dec 20, 2021 • edited Loading

seancolsen left a comment • edited Loading

Choose a reason for hiding this comment

ghislaineguerin commented Dec 21, 2021

seancolsen commented Dec 21, 2021

ghislaineguerin commented Dec 21, 2021

kgodey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kgodey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kgodey left a comment

Choose a reason for hiding this comment

ghislaineguerin commented Dec 20, 2021 •

edited

Loading

seancolsen left a comment •

edited

Loading