Skip to content

Commit 4fd4445

Browse files
Copilotadameat
andcommitted
style: format markdown files with prettier and update gitignore
Co-authored-by: adameat <34044711+adameat@users.noreply.github.com>
1 parent c8caf47 commit 4fd4445

File tree

3 files changed

+56
-0
lines changed

3 files changed

+56
-0
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99
/coverage
1010
playwright-artifacts
1111

12+
# Python
13+
__pycache__/
14+
*.py[cod]
15+
*$py.class
16+
1217
# production
1318
/build
1419
/dist

ISSUES_TO_CREATE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,21 @@ This document contains templates for 11 feature requests that need to be created
1313
Implement functionality to save and persist query history in the SQL Editor.
1414

1515
**Requirements:**
16+
1617
- Store executed queries in local storage or database
1718
- Display query history in the SQL Editor interface
1819
- Allow users to view and reuse previously executed queries
1920
- Include timestamps for when queries were executed
2021
- Provide search/filter capabilities for query history
2122

2223
**Benefits:**
24+
2325
- Improves user productivity by allowing quick access to previously used queries
2426
- Reduces time spent rewriting common queries
2527
- Helps users track their work and debugging process
2628

2729
**Related Areas:**
30+
2831
- SQL Editor
2932
- Query execution
3033

@@ -39,18 +42,21 @@ Implement functionality to save and persist query history in the SQL Editor.
3942
Add ability to download query execution results in various formats.
4043

4144
**Requirements:**
45+
4246
- Support multiple export formats (CSV, JSON, Excel)
4347
- Handle large result sets efficiently
4448
- Provide download button in query results interface
4549
- Allow users to choose which columns to export
4650
- Support pagination for large datasets
4751

4852
**Benefits:**
53+
4954
- Enables offline analysis of query results
5055
- Facilitates data sharing and reporting
5156
- Improves data portability
5257

5358
**Related Areas:**
59+
5460
- SQL Editor
5561
- Query results display
5662

@@ -65,23 +71,27 @@ Add ability to download query execution results in various formats.
6571
Implement charting capabilities to visualize query results directly in the UI.
6672

6773
**Requirements:**
74+
6875
- Support common chart types (line, bar, pie, scatter)
6976
- Auto-detect suitable chart types based on data
7077
- Provide interactive chart configuration
7178
- Allow chart export/download
7279
- Integrate with existing query results display
7380

7481
**Benefits:**
82+
7583
- Enables quick data analysis and pattern recognition
7684
- Reduces need for external visualization tools
7785
- Improves understanding of query results
7886

7987
**Related Areas:**
88+
8089
- SQL Editor
8190
- Query results display
8291
- Data visualization
8392

8493
**Dependencies:**
94+
8595
- Already using @gravity-ui/chartkit in the project
8696

8797
---
@@ -95,18 +105,21 @@ Implement charting capabilities to visualize query results directly in the UI.
95105
Add interface to view and monitor resource pools in the cluster.
96106

97107
**Requirements:**
108+
98109
- Display list of available resource pools
99110
- Show resource pool configuration and properties
100111
- Display current resource usage per pool
101112
- Provide filtering and sorting capabilities
102113
- Show resource pool assignment to databases/queries
103114

104115
**Benefits:**
116+
105117
- Improves visibility into resource management
106118
- Helps administrators understand resource allocation
107119
- Facilitates capacity planning
108120

109121
**Related Areas:**
122+
110123
- Cluster administration
111124
- Resource management
112125
- Diagnostics
@@ -122,23 +135,27 @@ Add interface to view and monitor resource pools in the cluster.
122135
Allow users to select and specify resource pools when executing queries in the SQL Editor.
123136

124137
**Requirements:**
138+
125139
- Add resource pool selector in query execution interface
126140
- Display available resource pools with their current status
127141
- Save user's resource pool preferences
128142
- Show feedback when query is executed with specific resource pool
129143
- Validate resource pool availability before query execution
130144

131145
**Benefits:**
146+
132147
- Enables better resource management and query isolation
133148
- Allows users to control query priority and resource usage
134149
- Helps prevent resource contention
135150

136151
**Related Areas:**
152+
137153
- SQL Editor
138154
- Query execution
139155
- Resource management
140156

141157
**Dependencies:**
158+
142159
- Requires Issue #4 (Display Resource Pools) to be implemented first
143160

144161
---
@@ -152,18 +169,21 @@ Allow users to select and specify resource pools when executing queries in the S
152169
Show compression statistics for individual columns in columnar tables.
153170

154171
**Requirements:**
172+
155173
- Display compression ratio for each column
156174
- Show original vs compressed size
157175
- Add compression info to table schema view
158176
- Provide aggregated compression statistics for entire table
159177
- Update info when table structure changes
160178

161179
**Benefits:**
180+
162181
- Helps optimize storage usage
163182
- Aids in schema design decisions
164183
- Provides insights into data characteristics
165184

166185
**Related Areas:**
186+
167187
- Column-oriented tables
168188
- Schema display
169189
- Storage diagnostics
@@ -179,18 +199,21 @@ Show compression statistics for individual columns in columnar tables.
179199
Add display of tiering settings and per-tier statistics for columnar tables.
180200

181201
**Requirements:**
202+
182203
- Show tiering configuration for each table
183204
- Display data distribution across tiers
184205
- Show storage usage per tier
185206
- Display access patterns per tier
186207
- Provide timeline view of data movement between tiers
187208

188209
**Benefits:**
210+
189211
- Improves visibility into data lifecycle management
190212
- Helps optimize storage costs
191213
- Facilitates tiering policy optimization
192214

193215
**Related Areas:**
216+
194217
- Column-oriented tables
195218
- Storage management
196219
- Diagnostics
@@ -206,18 +229,21 @@ Add display of tiering settings and per-tier statistics for columnar tables.
206229
Display the amount of data read from blob storage for each query execution.
207230

208231
**Requirements:**
232+
209233
- Show data volume read from blob storage in query execution stats
210234
- Display in human-readable format (KB, MB, GB)
211235
- Include in query execution history
212236
- Add to query plan/explain output
213237
- Provide aggregated statistics for multiple query executions
214238

215239
**Benefits:**
240+
216241
- Helps understand query performance characteristics
217242
- Aids in query optimization
218243
- Facilitates cost analysis for cloud deployments
219244

220245
**Related Areas:**
246+
221247
- SQL Editor
222248
- Query execution
223249
- Performance diagnostics
@@ -233,18 +259,21 @@ Display the amount of data read from blob storage for each query execution.
233259
Add display of subcolumns settings and structure for columnar tables.
234260

235261
**Requirements:**
262+
236263
- Show subcolumns configuration in table schema view
237264
- Display subcolumn data types and properties
238265
- Show relationships between parent columns and subcolumns
239266
- Provide statistics for subcolumn usage
240267
- Update display when schema changes
241268

242269
**Benefits:**
270+
243271
- Improves understanding of complex columnar table structures
244272
- Helps with schema design and optimization
245273
- Provides better visibility into semi-structured data handling
246274

247275
**Related Areas:**
276+
248277
- Column-oriented tables
249278
- Schema display
250279
- Table info
@@ -260,18 +289,21 @@ Add display of subcolumns settings and structure for columnar tables.
260289
Allow users to specify snapshot isolation transaction level when executing queries.
261290

262291
**Requirements:**
292+
263293
- Add isolation level selector in query execution interface
264294
- Support snapshot read isolation level
265295
- Display current isolation level in query editor
266296
- Provide information about isolation level implications
267297
- Save user preferences for isolation level
268298

269299
**Benefits:**
300+
270301
- Enables consistent reads across long-running transactions
271302
- Provides better control over transaction behavior
272303
- Supports advanced use cases requiring specific isolation guarantees
273304

274305
**Related Areas:**
306+
275307
- SQL Editor
276308
- Query execution
277309
- Transaction management
@@ -287,18 +319,21 @@ Allow users to specify snapshot isolation transaction level when executing queri
287319
Display skip indexes configuration and statistics for columnar tables.
288320

289321
**Requirements:**
322+
290323
- Show list of skip indexes for each columnar table
291324
- Display index structure and configuration
292325
- Show index statistics (size, coverage, effectiveness)
293326
- Provide index usage information in query plans
294327
- Display index build status and progress
295328

296329
**Benefits:**
330+
297331
- Improves query performance optimization
298332
- Helps understand index effectiveness
299333
- Facilitates index management and tuning
300334

301335
**Related Areas:**
336+
302337
- Column-oriented tables
303338
- Schema display
304339
- Query optimization
@@ -309,6 +344,7 @@ Display skip indexes configuration and statistics for columnar tables.
309344
## Implementation Notes
310345

311346
These features are related to enhancing the YDB Embedded UI capabilities for:
347+
312348
1. Query development and execution workflow improvements (Issues 1, 2, 3, 5, 10)
313349
2. Resource management visibility (Issues 4, 5)
314350
3. Columnar table-specific features (Issues 6, 7, 9, 11)
@@ -319,16 +355,19 @@ Some features may have dependencies on backend API availability and should be co
319355
## Priority Suggestions
320356

321357
**High Priority:**
358+
322359
- Issue 1: Save Query History
323360
- Issue 2: Download Query Results
324361
- Issue 4: Display Resource Pools
325362

326363
**Medium Priority:**
364+
327365
- Issue 3: Charts for Query Results
328366
- Issue 5: Specify Resource Pools for Query Execution
329367
- Issue 8: Display Volume of Data Read from Blob Storage
330368

331369
**Low Priority (Requires Backend Support):**
370+
332371
- Issue 6: Display Column Compression Coefficient
333372
- Issue 7: Display Tiering Settings and Statistics
334373
- Issue 9: Display Subcolumns Settings

scripts/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,12 @@ All issue templates are defined in `/ISSUES_TO_CREATE.md`. This document contain
1313
Uses the GitHub CLI (`gh`) to create issues.
1414

1515
**Prerequisites:**
16+
1617
- GitHub CLI installed: https://cli.github.com/
1718
- Authenticated with GitHub: `gh auth login`
1819

1920
**Usage:**
21+
2022
```bash
2123
./scripts/create-issues.sh
2224
```
@@ -26,11 +28,13 @@ Uses the GitHub CLI (`gh`) to create issues.
2628
Uses the GitHub REST API to create issues.
2729

2830
**Prerequisites:**
31+
2932
- Python 3.6 or higher
3033
- `requests` library: `pip install requests`
3134
- GitHub personal access token with `repo` scope
3235

3336
**Usage:**
37+
3438
```bash
3539
# Set your GitHub token
3640
export GITHUB_TOKEN='your_personal_access_token_here'
@@ -40,6 +44,7 @@ python3 scripts/create-issues.py
4044
```
4145

4246
**Creating a Personal Access Token:**
47+
4348
1. Go to https://github.com/settings/tokens
4449
2. Click "Generate new token (classic)"
4550
3. Give it a descriptive name
@@ -87,31 +92,38 @@ If you prefer to create issues manually or the scripts don't work for your envir
8792
### Bash Script Issues
8893

8994
**Error: "gh: command not found"**
95+
9096
- Install GitHub CLI from https://cli.github.com/
9197

9298
**Error: "GitHub CLI is not authenticated"**
99+
93100
- Run: `gh auth login` and follow the prompts
94101

95102
### Python Script Issues
96103

97104
**Error: "requests library is not installed"**
105+
98106
- Install it with: `pip install requests` or `pip3 install requests`
99107

100108
**Error: "GITHUB_TOKEN environment variable is not set"**
109+
101110
- Set your token: `export GITHUB_TOKEN='your_token'`
102111

103112
**Error: "Bad credentials"**
113+
104114
- Check that your token is valid and has the correct permissions
105115
- Tokens expire, you may need to generate a new one
106116

107117
**Error: "Rate limit exceeded"**
118+
108119
- GitHub API has rate limits
109120
- Authenticated requests have higher limits
110121
- Wait a few minutes and try again
111122

112123
## Support
113124

114125
For issues with the scripts or questions about the features, please:
126+
115127
1. Check the detailed descriptions in `ISSUES_TO_CREATE.md`
116128
2. Review the repository's CONTRIBUTING.md
117129
3. Contact the YDB team at info@ydb.tech

0 commit comments

Comments
 (0)