-
Notifications
You must be signed in to change notification settings - Fork 9
Use‐cases grouped by role
Anton Standrik edited this page Jan 13, 2025
·
10 revisions
YDB UI is created for different types or users (roles):
- Application developer – uses YDB as database (or a dataplatform). Writes queries, creates tables, debugs query performance.
- Cluster or database administrator – uses UI for diagnostics and cluster maintenance. Controls access rights for different operations with cluster or database.
- YDB developer – contributes to the project, adds new features. Mainly uses Developer UI for testing and debugging.
This wiki enumerates use-cases for every role. Use-cases appear on the list in the order of the frequency of their usage.
-
Find cluster
- Find cluster by name
- Find cluster by nodename
-
Find database
- Find database by path
- View list of databases
- Go to database monitoring chart
- Choose database
-
Browse database scheme
-
View schema as a tree ✅
-
View schema object details in schema browser ✅
-
Preview schema object data ✅
-
View schema object ACL ✅
-
Create schema object from three buttons menu ✅
-
Copy path ✅
-
Create directory ✅
-
Refresh schema tree ✅
-
Collapse/Expand panels ✅
-
-
Edit and Run Queries
- Type and Run a query ✅
- Autocomplete based on grammar
- Autocomplete based on schema
- Highlight syntax of a query
- Tune query execution preferences ✅
- Run selected part of the query ✅
- Run query from templates ✅
- Copy results to the clipboard ✅
- View query history ✅
- Run query from history ✅
- Search history query ✅
- Expand results tab ✅
- View Trace of a Query in External Tracing
-
View Query Execution Plan
- View Query Plan and statistics ✅
- View simplified query plan ✅
-
Run saved query
- View list of saved queries ✅
- Open saved query in the Editor ✅
- Save a query from the Editor ✅
- Diagnose cluster
- Find cluster nodes with degraded storage groups
- Find cluster root system tablet (Hive, SchemeShard, BSC)
- View cluster storage groups
- Group list by state, etc
- View cluster storage nodes
- Group list by DC, Usage, etc
- View cluster versions
- Evict disk
- View cluster status dashboard (with resources consumption)
- View cluster health check status
- Constrol decomission status
- Diagnose database
- View database info ✅
- View resources utilisation ✅
- View HC status ✅
- Go to database monitoring chart
- View top queries for a specific period
- View running queries ✅
- View top shards for a specific period
- View describe for an particular schema object
- View database storage (groups, node) ✅
- View database compute nodes ✅
- View list of operations
- Forget chosen export
- View schema object tablets
- Go to database hive app
- View database configs
- Access Developer UI
- Access Developer UI via specific node
- Access Tablet Internal App
- Access Storage Component (pdisk, vdisk) Internal App