Skip to content

Commit eb2d189

Browse files
Copilotadameat
andcommitted
feat: add issue templates for 11 feature requests
Co-authored-by: adameat <34044711+adameat@users.noreply.github.com>
1 parent 76f1618 commit eb2d189

File tree

1 file changed

+336
-0
lines changed

1 file changed

+336
-0
lines changed

ISSUES_TO_CREATE.md

Lines changed: 336 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,336 @@
1+
# GitHub Issues to Create
2+
3+
This document contains templates for 11 feature requests that need to be created as GitHub issues in the ydb-platform/ydb-embedded-ui repository.
4+
5+
---
6+
7+
## Issue 1: Save Query History
8+
9+
**Title:** feat: save query history
10+
11+
**Description:**
12+
13+
Implement functionality to save and persist query history in the SQL Editor.
14+
15+
**Requirements:**
16+
- Store executed queries in local storage or database
17+
- Display query history in the SQL Editor interface
18+
- Allow users to view and reuse previously executed queries
19+
- Include timestamps for when queries were executed
20+
- Provide search/filter capabilities for query history
21+
22+
**Benefits:**
23+
- Improves user productivity by allowing quick access to previously used queries
24+
- Reduces time spent rewriting common queries
25+
- Helps users track their work and debugging process
26+
27+
**Related Areas:**
28+
- SQL Editor
29+
- Query execution
30+
31+
---
32+
33+
## Issue 2: Download Query Results
34+
35+
**Title:** feat: download query results
36+
37+
**Description:**
38+
39+
Add ability to download query execution results in various formats.
40+
41+
**Requirements:**
42+
- Support multiple export formats (CSV, JSON, Excel)
43+
- Handle large result sets efficiently
44+
- Provide download button in query results interface
45+
- Allow users to choose which columns to export
46+
- Support pagination for large datasets
47+
48+
**Benefits:**
49+
- Enables offline analysis of query results
50+
- Facilitates data sharing and reporting
51+
- Improves data portability
52+
53+
**Related Areas:**
54+
- SQL Editor
55+
- Query results display
56+
57+
---
58+
59+
## Issue 3: Charts for Query Results
60+
61+
**Title:** feat: add charts for query results visualization
62+
63+
**Description:**
64+
65+
Implement charting capabilities to visualize query results directly in the UI.
66+
67+
**Requirements:**
68+
- Support common chart types (line, bar, pie, scatter)
69+
- Auto-detect suitable chart types based on data
70+
- Provide interactive chart configuration
71+
- Allow chart export/download
72+
- Integrate with existing query results display
73+
74+
**Benefits:**
75+
- Enables quick data analysis and pattern recognition
76+
- Reduces need for external visualization tools
77+
- Improves understanding of query results
78+
79+
**Related Areas:**
80+
- SQL Editor
81+
- Query results display
82+
- Data visualization
83+
84+
**Dependencies:**
85+
- Already using @gravity-ui/chartkit in the project
86+
87+
---
88+
89+
## Issue 4: Display Resource Pools
90+
91+
**Title:** feat: show resource pools information
92+
93+
**Description:**
94+
95+
Add interface to view and monitor resource pools in the cluster.
96+
97+
**Requirements:**
98+
- Display list of available resource pools
99+
- Show resource pool configuration and properties
100+
- Display current resource usage per pool
101+
- Provide filtering and sorting capabilities
102+
- Show resource pool assignment to databases/queries
103+
104+
**Benefits:**
105+
- Improves visibility into resource management
106+
- Helps administrators understand resource allocation
107+
- Facilitates capacity planning
108+
109+
**Related Areas:**
110+
- Cluster administration
111+
- Resource management
112+
- Diagnostics
113+
114+
---
115+
116+
## Issue 5: Specify Resource Pools for Query Execution
117+
118+
**Title:** feat: ability to specify resource pools when running queries
119+
120+
**Description:**
121+
122+
Allow users to select and specify resource pools when executing queries in the SQL Editor.
123+
124+
**Requirements:**
125+
- Add resource pool selector in query execution interface
126+
- Display available resource pools with their current status
127+
- Save user's resource pool preferences
128+
- Show feedback when query is executed with specific resource pool
129+
- Validate resource pool availability before query execution
130+
131+
**Benefits:**
132+
- Enables better resource management and query isolation
133+
- Allows users to control query priority and resource usage
134+
- Helps prevent resource contention
135+
136+
**Related Areas:**
137+
- SQL Editor
138+
- Query execution
139+
- Resource management
140+
141+
**Dependencies:**
142+
- Requires Issue #4 (Display Resource Pools) to be implemented first
143+
144+
---
145+
146+
## Issue 6: Display Column Compression Coefficient for Columnar Tables
147+
148+
**Title:** feat: display compression coefficient for columnar table columns
149+
150+
**Description:**
151+
152+
Show compression statistics for individual columns in columnar tables.
153+
154+
**Requirements:**
155+
- Display compression ratio for each column
156+
- Show original vs compressed size
157+
- Add compression info to table schema view
158+
- Provide aggregated compression statistics for entire table
159+
- Update info when table structure changes
160+
161+
**Benefits:**
162+
- Helps optimize storage usage
163+
- Aids in schema design decisions
164+
- Provides insights into data characteristics
165+
166+
**Related Areas:**
167+
- Column-oriented tables
168+
- Schema display
169+
- Storage diagnostics
170+
171+
---
172+
173+
## Issue 7: Display Tiering Settings and Statistics for Columnar Tables
174+
175+
**Title:** feat: show tiering configuration and statistics for columnar tables
176+
177+
**Description:**
178+
179+
Add display of tiering settings and per-tier statistics for columnar tables.
180+
181+
**Requirements:**
182+
- Show tiering configuration for each table
183+
- Display data distribution across tiers
184+
- Show storage usage per tier
185+
- Display access patterns per tier
186+
- Provide timeline view of data movement between tiers
187+
188+
**Benefits:**
189+
- Improves visibility into data lifecycle management
190+
- Helps optimize storage costs
191+
- Facilitates tiering policy optimization
192+
193+
**Related Areas:**
194+
- Column-oriented tables
195+
- Storage management
196+
- Diagnostics
197+
198+
---
199+
200+
## Issue 8: Display Volume of Data Read from Blob Storage
201+
202+
**Title:** feat: show query data read volume from blob storage
203+
204+
**Description:**
205+
206+
Display the amount of data read from blob storage for each query execution.
207+
208+
**Requirements:**
209+
- Show data volume read from blob storage in query execution stats
210+
- Display in human-readable format (KB, MB, GB)
211+
- Include in query execution history
212+
- Add to query plan/explain output
213+
- Provide aggregated statistics for multiple query executions
214+
215+
**Benefits:**
216+
- Helps understand query performance characteristics
217+
- Aids in query optimization
218+
- Facilitates cost analysis for cloud deployments
219+
220+
**Related Areas:**
221+
- SQL Editor
222+
- Query execution
223+
- Performance diagnostics
224+
225+
---
226+
227+
## Issue 9: Display Subcolumns Settings for Columnar Tables
228+
229+
**Title:** feat: show subcolumns configuration for columnar tables
230+
231+
**Description:**
232+
233+
Add display of subcolumns settings and structure for columnar tables.
234+
235+
**Requirements:**
236+
- Show subcolumns configuration in table schema view
237+
- Display subcolumn data types and properties
238+
- Show relationships between parent columns and subcolumns
239+
- Provide statistics for subcolumn usage
240+
- Update display when schema changes
241+
242+
**Benefits:**
243+
- Improves understanding of complex columnar table structures
244+
- Helps with schema design and optimization
245+
- Provides better visibility into semi-structured data handling
246+
247+
**Related Areas:**
248+
- Column-oriented tables
249+
- Schema display
250+
- Table info
251+
252+
---
253+
254+
## Issue 10: Specify Snapshot Isolation Level for Query Execution
255+
256+
**Title:** feat: ability to specify snapshot isolation level when running queries
257+
258+
**Description:**
259+
260+
Allow users to specify snapshot isolation transaction level when executing queries.
261+
262+
**Requirements:**
263+
- Add isolation level selector in query execution interface
264+
- Support snapshot read isolation level
265+
- Display current isolation level in query editor
266+
- Provide information about isolation level implications
267+
- Save user preferences for isolation level
268+
269+
**Benefits:**
270+
- Enables consistent reads across long-running transactions
271+
- Provides better control over transaction behavior
272+
- Supports advanced use cases requiring specific isolation guarantees
273+
274+
**Related Areas:**
275+
- SQL Editor
276+
- Query execution
277+
- Transaction management
278+
279+
---
280+
281+
## Issue 11: Display Skip Indexes Structure for Columnar Tables
282+
283+
**Title:** feat: show skip indexes structure for columnar tables
284+
285+
**Description:**
286+
287+
Display skip indexes configuration and statistics for columnar tables.
288+
289+
**Requirements:**
290+
- Show list of skip indexes for each columnar table
291+
- Display index structure and configuration
292+
- Show index statistics (size, coverage, effectiveness)
293+
- Provide index usage information in query plans
294+
- Display index build status and progress
295+
296+
**Benefits:**
297+
- Improves query performance optimization
298+
- Helps understand index effectiveness
299+
- Facilitates index management and tuning
300+
301+
**Related Areas:**
302+
- Column-oriented tables
303+
- Schema display
304+
- Query optimization
305+
- Indexes
306+
307+
---
308+
309+
## Implementation Notes
310+
311+
These features are related to enhancing the YDB Embedded UI capabilities for:
312+
1. Query development and execution workflow improvements (Issues 1, 2, 3, 5, 10)
313+
2. Resource management visibility (Issues 4, 5)
314+
3. Columnar table-specific features (Issues 6, 7, 9, 11)
315+
4. Performance monitoring and diagnostics (Issue 8)
316+
317+
Some features may have dependencies on backend API availability and should be coordinated with YDB core development.
318+
319+
## Priority Suggestions
320+
321+
**High Priority:**
322+
- Issue 1: Save Query History
323+
- Issue 2: Download Query Results
324+
- Issue 4: Display Resource Pools
325+
326+
**Medium Priority:**
327+
- Issue 3: Charts for Query Results
328+
- Issue 5: Specify Resource Pools for Query Execution
329+
- Issue 8: Display Volume of Data Read from Blob Storage
330+
331+
**Low Priority (Requires Backend Support):**
332+
- Issue 6: Display Column Compression Coefficient
333+
- Issue 7: Display Tiering Settings and Statistics
334+
- Issue 9: Display Subcolumns Settings
335+
- Issue 10: Specify Snapshot Isolation Level
336+
- Issue 11: Display Skip Indexes Structure

0 commit comments

Comments
 (0)