neil/silverbullet
1
0
Fork 0
Code

builtin data sources

Browse Source
This commit is contained in:
Sinan Sonmez (Chaush) 2022-07-30 11:11:24 +00:00
parent 4e60d4e514
commit a3cd0faacc
1 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
website/🔌 Query.md
View File

@ -5,10 +5,10 @@ repo: https://github.com/silverbulletmd/silverbullet
author: Silver Bullet Authors author: Silver Bullet Authors
``` ```
### What? ### 1. What?
The query plug is a built-in plug implementing the `<!-- #query -->` mechanism. You can use query plug to automatically receive information from your notes. The query plug is a built-in plug implementing the `<!-- #query -->` mechanism. You can use query plug to automatically receive information from your notes.
### Syntax ### 2. Syntax
1. start with: `<!-- #query [QUERY GOES HERE] -->` 1. start with: `<!-- #query [QUERY GOES HERE] -->`
2. end with: `<!-- /query -->` 2. end with: `<!-- /query -->`
3. write your query: replace `[QUERY GOES HERE]` with any query you want using options below 3. write your query: replace `[QUERY GOES HERE]` with any query you want using options below
@ -20,10 +20,32 @@ The query plug is a built-in plug implementing the `<!-- #query -->` mechanism.
* `render` * `render`
5. If you are a developer or have a technical knowledge to read a code and would like to know more about syntax please check out [query grammar](https://github.com/silverbulletmd/silverbullet/blob/main/packages/plugs/query/query.grammar) 5. If you are a developer or have a technical knowledge to read a code and would like to know more about syntax please check out [query grammar](https://github.com/silverbulletmd/silverbullet/blob/main/packages/plugs/query/query.grammar)
### How to run a query ### 3. How to run a query?
After writing the query, there are two options After writing the query, there are two options
* Open the **command palette** and run **Materialized Queries: Update** * Open the **command palette** and run **Materialized Queries: Update**
* Use shortcut: for windows **Alt-q** and for mac **Option-q** * Use shortcut: for windows **Alt-q** and for mac **Option-q**
* Go to another page and come back to the page where query is located * Go to another page and come back to the page where query is located
After using one of the options, the data will be displayed. After using one of the options, the data will be displayed.
### 4. Data sources
Available data sources can be categorized as
1. Builtin data sources
2. Data that can be inserted by users
3. Plug’s data sourcer
Best part about data sources: there is an auto completion 🎉. Start writing `<!— #query `, it will show you all available data sources.
#### 4.1 Builtin data sources
* `page`: list of all pages
* `task`: list of all tasks created with `[]` syntax
* `full-text`: use it with `where phrase = "SOME_TEXT"`. List of all pages where `SOME_TEXT` is mentioned
* `item`: list of ordered and unordered items such as bulleted lists
* `tags`: list of all hashtags used in all pages
* `link`: list of all pages giving a link to the page where query is written
<!-- #query -->
<!-- /query -->