-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
create new markdown sql tools doc (#19)
- Loading branch information
1 parent
aa24f02
commit c0a702e
Showing
1 changed file
with
77 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
## Markdown SQL Pro Tools | ||
|
||
**Markdown SQL Pro Tools** extension adds custom SQL [Code Lenses](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#codelens-show-actionable-context-information-within-source-code) to SQL code blocks in standard SQL and various markdown documents in VS Code IDE. | ||
|
||
The provided **SQL Code Lenses** include top-level SQL and markdown document `Execute All`, `Select All`, `Extract All`, `Bookmark All` SQL code lenses, `Execute`, `Select`, and `Copy` SQL code block lenses, and `Create` New SQL document from SQL code block lens. | ||
|
||
Our **SQL Code Lenses** integrate with the popular [SQL Tools](https://vscode-sqltools.mteixeira.dev/en/home/) Connections manager, supported [SQL Tools drivers](https://marketplace.visualstudio.com/search?term=tag%3Asqltools-driver&target=VSCode&category=All%20categories&sortBy=Rating), and query results viewer to execute SQL **directly** on any of the supported SQL Tools database management systems and view results. | ||
|
||
![Markdown SQL Pro Tools](https://github.com/RandomFractals/pro-data-tools/blob/main/docs/images/markdown-sql-pro-tools-v1.1.0.gif?raw=true) | ||
|
||
## Markdown SQL Features | ||
|
||
**Markdown SQL Pro Tools** add the following top-level **SQL Code Lenses** to SQL and markdown documents open in VS Code IDE: | ||
|
||
- `Execute All` SQL code lens to execute all SQL statements in the open SQL or markdown document | ||
- `Select All` SQL code lens to select all SQL code blocks in the open markdown document | ||
- `Extract All` SQL code lens to extract all SQL code blocks from the open markdown document | ||
- `Bookmark All` SQL code lens to bookmark all SQL code blocks in the open markdown document | ||
|
||
This extension also adds the following SQL Code Lenses to individual SQL code blocks in the open markdown documents and SQL statements in SQL documents: | ||
|
||
- `Execute` SQL code lens to run SQL code using active SQL Tools database connection | ||
- `Select` SQL code lens to select SQL code block in the open SQL or markdown document editor | ||
- `Copy` SQL code lens to copy SQL code block to the clipboard | ||
- `Create` SQL code lens to create new SQL document from SQL code block in the open text editor | ||
|
||
### Supported Markdown Documents and SQL Highlights | ||
|
||
**Markdown SQL Pro Tools** detect and highlight SQL code blocks in stanadard `.md` markdown documents, `.Rmd` [R markdown](https://rmarkdown.rstudio.com/) documents, `.qmd` [Quarto](https://quarto.org/) publishing documents, `.ojs` and `.omd` [Observable JS](https://marketplace.visualstudio.com/items?itemName=GordonSmith.observable-js) and markdown documents. | ||
|
||
The supported SQL code blocks include [code fences](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) with `sql` tag, `%%sql` magic code blocks, and `%sql` magic code lines with `SELECT` statements. | ||
|
||
![Markdown SQL Code Highlights](https://github.com/RandomFractals/pro-data-tools/blob/main/docs/images/markdown-sql-code-highlight.png?raw=true) | ||
|
||
You can use new top-level `Select All` SQL code lens to select all detected SQL code blocks in the open markdown document. | ||
|
||
![Markdown SQL Code Selections](https://github.com/RandomFractals/pro-data-tools/blob/main/docs/images/markdown-sql-selections.png?raw=true) | ||
|
||
### Markdown SQL Code Bookmarks | ||
|
||
Users of the popular [Bookmarks](https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks) VS Code extension can use new top-level `Bookmark All` SQL code lens to toggle SQL code bookmarks in the open markdown documents. | ||
|
||
![Markdown SQL Code Bookmarks](https://github.com/RandomFractals/pro-data-tools/blob/main/docs/images/markdown-sql-bookmarks.png?raw=true) | ||
|
||
Using **Markdown SQL Pro Tools** with new **SQL Bookmarks**, SQLite and our **DuckDB Pro** SQL Tools in VS Code IDE on [Ploomber's JupySQL](https://github.com/ploomber/jupysql/blob/master/doc/quick-start.md) Jupyter book markdown docs: | ||
|
||
![Using Markdown SQL Code Bookmarks](https://github.com/RandomFractals/pro-data-tools/blob/main/docs/images/markdown-sql-bookmarks.gif?raw=true) | ||
|
||
**Note**: Install [Bookmarks](https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks) extension separately to see new `Bookmark All` SQL code lens enabled in the supported markdown documents. | ||
|
||
### Interactive SQL in Quarto Docs | ||
|
||
The **Markdown SQL Pro Tools** v1.2.0 and above add **SQL Code Lenses** to SQL code blocks in [Quarto](https://quarto.org/) markdown docs in VS Code IDE. | ||
|
||
Quick demo of setting up local HR SQLite database with SQL Tools VS Code extension, rendering Quarto markdown document with [Quarto](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) extension, and using our new SQL code lenses to Execute SQL queries from standard `.md` and `.qmd` markdown documents code: | ||
|
||
![Interactive SQL in Quarto Docs](https://github.com/RandomFractals/pro-data-tools/blob/main/docs/images/markdown-sql-in-quarto.gif?raw=true) | ||
|
||
You can install and use [Interactive SQL](https://github.com/shafayetShafee/interactive-sql) Quarto extension to experiment with it in VS Code with Quarto markdown docs. | ||
|
||
### Interactive SQL in R Markdown | ||
|
||
You can also use new **SQL Code Lenses** in [R Markdown](https://rmarkdown.rstudio.com/) documents in VS Code IDE. | ||
|
||
[SQL in RMD](https://github.com/sciencificity/sql-in-rmd/tree/main) GitHub repository provides a great example of using SQL code chunks in R markdown documents. | ||
|
||
Setting up demo SQLite database connection and using our **SQL Code Lenses** to run SQL queries from R markdown document: | ||
|
||
![Interactive SQL in R Markdown](https://github.com/RandomFractals/pro-data-tools/blob/main/docs/images/markdown-sql-in-rmd.gif?raw=true) | ||
|
||
## Markdown SQL Feature Contributions | ||
|
||
**Markdown SQL Pro Tools** contribute the following Commands and Activation Events to VS Code IDE for working with SQL code in markdown and SQL documents. | ||
|
||
![Markdown SQL Pro Tools Feature Contributions](https://github.com/RandomFractals/pro-data-tools/blob/main/docs/images/markdown-sql-pro-tools-contributions.png?raw=true) | ||
|
||
**Markdodown SQL Pro Tools** extension is available under the new [**Markdown Sql Pro Tools**](https://github.com/sponsors/RandomFractals/sponsorships?tier_id=295482) monthly sponsor subscription on GitHub and also includes access to the [**DuckDB Pro**](https://randomfractals.github.io/pro-data-tools/#duckdb-pro-tools) SQL Tools plugin and [**PRQL Code Lens**](https://github.com/RandomFractals/pro-data-tools/blob/main/prql-tools.md#prql-code-lens) extension from our Premium [**Pro Data Tools**](https://randomfractals.github.io/pro-data-tools/#pro-data-tools) extensions pack. |