Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/yongjinsim-sudo/dv-quick-run

Run and explain Dataverse Web API queries directly inside VS Code.
https://github.com/yongjinsim-sudo/dv-quick-run

crm dataverse dataverse-api dataverse-query developer-tools dynamics365 odata power-platform vscode vscode-extension

Last synced: 3 days ago
JSON representation

Run and explain Dataverse Web API queries directly inside VS Code.

Awesome Lists containing this project

README 

          
# DV Quick Run



A metadata-aware Dataverse query, investigation, and reasoning workbench for VS Code — with guided traversal, preview-first query refinement, interactive filter refinement, enrichment, and intelligent Query Doctor diagnostics.



**Run, understand, explore, and refine Dataverse queries — now with Query-by-Canvas and interactive inline refinement — without leaving your editor.**



---



## 🚀 What is DV Quick Run?



DV Quick Run turns VS Code into a **Dataverse developer console**.



Instead of switching between Postman, browser tabs, and maker portals, you can:



* Write queries

* Run them instantly

* Explore results in a table

* Investigate records

* Refine queries safely using Query-by-Canvas (preview-first)

* Navigate relationships step-by-step

* Enrich results without rewriting queries



All inside VS Code — with a preview-first, user-controlled workflow.



---



## 🆕 What's New in v0.8.0 (Evidence-Aware Query Doctor)



> Introduces an evidence-driven Query Doctor with structured narrowing insights — helping you understand and refine queries based on actual returned data patterns.



- **Evidence-Aware Query Doctor**

  - Uses:

    - query shape

    - returned row patterns

    - lightweight execution evidence

  - Moves beyond static advice into **result-aware guidance**



- **Structured Narrowing Insights**

  - Detects meaningful patterns in returned rows

  - Surfaces potential ways to refine queries using:

    - repeated categorical values (e.g. status, state, priority)

    - null vs non-null distributions

  - Helps identify *where* to narrow — not just *that* you should



- **Explainable Suggestions**

  - Each suggestion includes a clear reason

  - Examples:

    - “value X appears 12 times”

    - “field populated in 18/30 rows”

  - Builds trust through transparent, evidence-based guidance



- **Suggested Query Guidance**

  - Clear, direct next steps for refining queries



- **Metadata-Accurate Suggestions**

  - Suggested queries use valid fields for the current entity

  - Prevents incorrect or cross-entity recommendations



- **Improved Readability with Formatted Values**

  - Query Doctor prefers human-readable labels where available

  - Example:

    - `statecode = Active` instead of raw numeric values



---



### ✨ New Workflow: Evidence-Based Refinement



Instead of guessing how to improve your query:



1. Run a query  

2. Open **Explain Query**  

3. See:

   - observed patterns

   - narrowing opportunities

   - suggested queries  

4. Refine manually with confidence  

5. Re-run and iterate  



run → observe → understand → refine → repeat



---



### 🧠 Notes



- This release focuses on:

  - insight quality

  - explainability

  - trust

  - correctness



- Establishes the foundation for:

  - interactive query refinement

  - deeper analysis workflows

  - future execution-driven improvements



---



## 🎬 Result Viewer



![DV Quick Run Result Viewer](docs/demo-result-viewer.gif)



Typical workflow:



start simple → run → explore → refine (Query-by-Canvas) → enrich → refine → repeat



---



## ⚡ Quick Start



1. Install **DV Quick Run**

2. Login:



   ```

   az login --allow-no-subscriptions

   ```

3. Configure your Dataverse environment

4. Run a query:



   ```

   contacts?$top=10

   ```



---



## ✨ Key Features



### 🔎 Run & Explore Queries



* Run Dataverse queries (OData & FetchXML) directly in VS Code

* View results in an interactive table or JSON

* Sort, filter, and inspect data inline



---



### 🔗 Guided Traversal + Enrichment



* Traverse relationships step-by-step across Dataverse tables

* Continue traversal using real data (row-driven)

* Enrich results in-place using **Sibling Expand**

* Build complex multi-entity queries without manual `$expand`



---



### 🧠 Explain Query + Query Doctor



* Break queries into human-readable explanations

* Understand filters, sorting, and structure instantly



**Query Doctor (Intelligent Diagnostics):**



* Analyse your query and detect issues

* Get prioritised diagnostics with confidence scoring

* Receive actionable **Suggested Fixes** with examples



Turn this:

  accounts?$expand=primarycontactid



Into:



* what the query does

* what’s missing

* how to improve it



All directly inside VS Code.



---



### 🔍 Investigate Record



* Select a GUID → investigate instantly

* See relationships, summary, and suggested queries



---



### ⚡ Smart Query Helpers



* Build queries (GET / PATCH) with guided prompts

* Incrementally refine queries ($select, $filter, $expand, $orderby)

* Generate queries from JSON



---



### 🧬 Metadata Intelligence



* Hover to see field metadata

* Resolve choice labels automatically

* **Refine filter values inline (preview-first)**

* Explore entity relationships



---



### 🌍 Environment Support



* Work across DEV / UAT / PROD

* Safe environment switching

* Environment-aware metadata caching



---



## 🛡 Guardrails



DV Quick Run detects risky queries (e.g. missing `$top`) and warns before execution.



---



## 👥 Who Is This For?



* Dataverse / Dynamics 365 developers

* Power Platform engineers

* Integration / API developers



---



## 💡 Why DV Quick Run?



Because the fastest workflow is:



**write → run → explore → fix → repeat**



…without leaving your editor.



---



## 🔧 Development



```

npm install

npm run compile

```



Press **F5** to run the extension.



---



## 📜 License



MIT License