mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 01:45:10 +03:00
Miranda Limonczenko
15a7b0ab18
Closes DOCS-1387 ## Problem The Postgres roles guide describes `dashboard_user` as "For running commands via the Supabase UI." That was the original intent, not current behavior. Dashboard queries run as `postgres` and carry a `-- source: dashboard` comment, which the [Postgres logs troubleshooting guide](https://supabase.com/docs/guides/troubleshooting/how-to-interpret-and-explore-the-postgres-logs-OuCIOj) already documents. The two pages contradict each other. Two smaller problems in the same list: - `supabase_storage_admin` is described as an Auth middleware role, copied from the `supabase_auth_admin` entry above it. - Studio ships both stale strings in its own role tooltips. The docs list and `QUERY_PERFORMANCE_ROLE_DESCRIPTION` are near-verbatim copies of each other. ## Solution - Replace the `dashboard_user` description with what the Dashboard connects as instead, and point readers to the `-- source: dashboard` comment for finding Dashboard queries in the logs. - Attribute `supabase_storage_admin` to the Storage middleware. - Apply both corrections to the Query Performance and Query Insights role tooltips. ## Manual testing 1. Open the [roles guide on the deploy preview](https://docs-git-docs-dashboard-user-role-supabase.vercel.app/docs/guides/database/postgres/roles). 2. Scroll to `dashboard_user`. It states that the Dashboard doesn't connect as the role, and that Dashboard queries execute as `postgres` with a `-- source: dashboard` comment. 3. Select **find them in the Postgres logs**. The Postgres logs troubleshooting guide loads. 4. Scroll to `supabase_storage_admin`. It reads "Used by the Storage middleware," not "Auth middleware." 5. In Studio, open **Observability > Query Performance** and hover a `dashboard_user` or `supabase_storage_admin` value in the **Role** column. The tooltip shows the same two corrected descriptions. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Corrected the description of the `supabase_storage_admin` role to reference Storage middleware. - Clarified that the Dashboard does not connect using the `dashboard_user` role. - Documented that Dashboard queries run as `postgres` and can be identified in Postgres logs with a `source: dashboard` comment. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
95 lines
3.4 KiB
TypeScript
95 lines
3.4 KiB
TypeScript
export enum QUERY_PERFORMANCE_REPORT_TYPES {
|
|
MOST_TIME_CONSUMING = 'most_time_consuming',
|
|
MOST_FREQUENT = 'most_frequent',
|
|
SLOWEST_EXECUTION = 'slowest_execution',
|
|
UNIFIED = 'unified',
|
|
}
|
|
|
|
export const QUERY_PERFORMANCE_PRESET_MAP = {
|
|
[QUERY_PERFORMANCE_REPORT_TYPES.MOST_TIME_CONSUMING]: 'mostTimeConsuming',
|
|
[QUERY_PERFORMANCE_REPORT_TYPES.MOST_FREQUENT]: 'mostFrequentlyInvoked',
|
|
[QUERY_PERFORMANCE_REPORT_TYPES.SLOWEST_EXECUTION]: 'slowestExecutionTime',
|
|
[QUERY_PERFORMANCE_REPORT_TYPES.UNIFIED]: 'unified',
|
|
} as const
|
|
|
|
export const QUERY_PERFORMANCE_COLUMNS = [
|
|
{ id: 'query', name: 'Query', description: undefined, minWidth: 450 },
|
|
{ id: 'prop_total_time', name: 'Time consumed', description: undefined, minWidth: 150 },
|
|
{ id: 'calls', name: 'Calls', description: undefined, minWidth: 100 },
|
|
{ id: 'max_time', name: 'Max time', description: undefined, minWidth: 100 },
|
|
{ id: 'mean_time', name: 'Mean time', description: undefined, minWidth: 100 },
|
|
{ id: 'min_time', name: 'Min time', description: undefined, minWidth: 100 },
|
|
{ id: 'rows_read', name: 'Rows processed', description: undefined, minWidth: 130 },
|
|
{ id: 'cache_hit_rate', name: 'Cache hit rate', description: undefined, minWidth: 130 },
|
|
{ id: 'rolname', name: 'Role', description: undefined, minWidth: 200 },
|
|
{ id: 'application_name', name: 'Application', description: undefined, minWidth: 150 },
|
|
] as const
|
|
|
|
export const QUERY_PERFORMANCE_ROLE_DESCRIPTION = [
|
|
{ name: 'postgres', description: 'The default Postgres role. This has admin privileges.' },
|
|
{
|
|
name: 'anon',
|
|
description:
|
|
'For unauthenticated, public access. This is the role which the API (PostgREST) will use when a user is not logged in.',
|
|
},
|
|
{
|
|
name: 'authenticator',
|
|
description:
|
|
'A special role for the API (PostgREST). It has very limited access, and is used to validate a JWT and then "change into" another role determined by the JWT verification.',
|
|
},
|
|
{
|
|
name: 'authenticated',
|
|
description:
|
|
'For "authenticated access." This is the role which the API (PostgREST) will use when a user is logged in.',
|
|
},
|
|
{
|
|
name: 'service_role',
|
|
description:
|
|
'For elevated access. This role is used by the API (PostgREST) to bypass Row Level Security.',
|
|
},
|
|
{
|
|
name: 'supabase_auth_admin',
|
|
description:
|
|
'Used by the Auth middleware to connect to the database and run migration. Access is scoped to the auth schema.',
|
|
},
|
|
{
|
|
name: 'supabase_storage_admin',
|
|
description:
|
|
'Used by the Storage middleware to connect to the database and run migration. Access is scoped to the storage schema.',
|
|
},
|
|
{
|
|
name: 'dashboard_user',
|
|
description:
|
|
'The Supabase Dashboard doesn\'t connect as this role. Dashboard queries execute as postgres and include a "-- source: dashboard" comment.',
|
|
},
|
|
{
|
|
name: 'supabase_admin',
|
|
description:
|
|
'An internal role Supabase uses for administrative tasks, such as running upgrades and automations.',
|
|
},
|
|
{
|
|
name: 'pgbouncer',
|
|
description:
|
|
'PgBouncer is a lightweight connection pooler for PostgreSQL. Available on paid plans only.',
|
|
},
|
|
] as const
|
|
|
|
export const QUERY_PERFORMANCE_CHART_TABS = [
|
|
{
|
|
id: 'query_latency',
|
|
label: 'Query latency',
|
|
},
|
|
{
|
|
id: 'rows_read',
|
|
label: 'Rows read',
|
|
},
|
|
{
|
|
id: 'calls',
|
|
label: 'Calls',
|
|
},
|
|
{
|
|
id: 'cache_hits',
|
|
label: 'Cache hits',
|
|
},
|
|
]
|