Allow reloading database contents from the UI

Open
#4,432 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript, vscode
Domain
developer-experience, devtools

Research direction

Trace the database tree item's right-click context menu and the existing delete/import functionality. Start by finding how those commands replace database entries, then add a manual reload path that refreshes contents from the same file without re-adding it; done means updated databases can be queried without the stale-open errors described in the issue.

Written by the indexing model from the issue text.

Description

enhancement VSCode

Is your feature request related to a problem? Please describe.
When writing queries I often throw them against a small toy application that contains exactly the cases I am trying to query for. As my queries evolve and new edge-cases appear I have to frequently make modifications to the project, and this means recompiling the database. Currently to make the extension properly work with the new database I have to remove the old one and use the file picker to add a "new" database with the same file path. CodeQL does not seem to like it when the database is changed while it is open, so not doing this results in it seizing up when querying to other unintuitive errors.

Describe the solution you'd like
An extra option in the database right-click menu that tells the extension "I want to re-load the data from disk" would be nice. It could probably be implemented on top of existing delete/import functionality.

Describe alternatives you've considered
The best fix for this would probably be somehow automatically notifying the extension when the database contents change, however I am not sure whether this can be easily implemented. Allowing the manual reload fixes 90% of the annoyance without being too invasive.

Additional context
I am open to implementing this myself and opening a PR. I have not worked on VSC extensions before, but I am willing to give it a shot.

Dominant language
TypeScript
Stars
539
Forks
240
Avg merge
2d 6h
Merged PRs (30d)
29

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/vscode-codeql

All issues in github/vscode-codeql

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.