neil/silverbullet
1
0
Fork 0
Code

adress PR review

Browse Source
This commit is contained in:
Sinan Sonmez (Chaush) 2022-07-30 15:42:25 +00:00
parent 9cb8be6d03
commit 4be859c810
1 changed files with 13 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
website/🔌 Query.md
View File

@ -6,15 +6,15 @@ author: Silver Bullet Authors
``` ```
### 1. 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 pages.
### 2. 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
4. _available query options_: Usage of options is similar to general query language except special render option. Render option is to use display the data in a format that you created in a separate template 4. _available query options_: Usage of options is similar to SQL except special `render` option. Render option is to use display the data in a format that you created in a separate template
* `where` * `where`
* `order` * `order by`
* `limit` * `limit`
* `select` * `select`
* `render` * `render`
@ -27,7 +27,7 @@ After writing the query, there are three options:
* Use shortcut: hit **Alt-q** (Windows, Linux) or **Option-q** (Mac) * Use shortcut: hit **Alt-q** (Windows, Linux) or **Option-q** (Mac)
* 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 “body” of the query is replaced with the new results of the query data will be displayed.
### 4. Data sources ### 4. Data sources
Available data sources can be categorized as: Available data sources can be categorized as:
@ -37,18 +37,16 @@ Available data sources can be categorized as:
Best part about data sources: there is an auto completion. 🎉 Best part about data sources: there is an auto completion. 🎉
Start writing `<!— #query `, it will show you all available data sources. 🤯 Start writing `<!— #query ` or simply use `/query` slash command, it will show you all available data sources. 🤯
#### 4.1 Builtin data sources #### 4.1. Available data sources
* `page`: list of all pages 📄 * `page`: list of all pages 📄
* `task`: list of all tasks created with `[]` syntax ✅ * `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 ✍️ * `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 ⏺️ * `item`: list of ordered and unordered items such as bulleted lists ⏺️
* `tags`: list of all hashtags used in all pages ⚡ * `tags`: list of all hashtags used in all pages ⚡
* `link`: list of all pages giving a link to the page where query is written 🔗 * `link`: list of all pages giving a link to the page where query is written 🔗
* `data`: You can insert a data using the syntax below 🖥️. You can query the data using `data` option.
#### 4.2 Data that can be inserted by users
* *insert the data:* You can insert a data using the syntax below 🖥️
```data ```data
name: John name: John
age: 50 age: 50
@ -65,17 +63,14 @@ age: 28
city: Berlin city: Berlin
country: Germany country: Germany
``` ```
* *query the data:* You can query the data using `data` option
<!-- #query data where age > 20 and country = "Italy" --> <!-- #query data where age > 20 and country = "Italy" -->
|name|age|city |country|page |pos | |name|age|city |country|page |pos |
|----|--|-----|-----|---------------|----| |----|--|-----|-----|---------------|----|
|John|50|Milan|Italy|Test Data Query|0 | |John|50|Milan|Italy|🔌 Query |2198|
|Jane|53|Rome |Italy|Test Data Query|46 | |Jane|53|Rome |Italy|🔌 Query |2244|
|John|50|Milan|Italy|🔌 Query |2148|
|Jane|53|Rome |Italy|🔌 Query |2194|
<!-- /query --> <!-- /query -->
#### 4.3 Plugs’ data sources #### 4.2 Plugs’ data sources
Certain plugs can also provide special data sources to query a certain data. Some examples are Certain plugs can also provide special data sources to query a certain data. Some examples are
* [[🔌 Github]] provides `gh-pull` to query PRs for selected repo * [[🔌 Github]] provides `gh-pull` to query PRs for selected repo
* [[🔌 Mattermost]] provides `mm-saved` to fetch (by default 15) saved posts in Mattermost * [[🔌 Mattermost]] provides `mm-saved` to fetch (by default 15) saved posts in Mattermost
@ -96,10 +91,10 @@ For the sake of simplicity, we will use `page` data source and limit the results
<!-- #query page limit 10 --> <!-- #query page limit 10 -->
|name |lastModified |perm|tags |type|uri |repo |author | |name |lastModified |perm|tags |type|uri |repo |author |
|--|--|--|--|--|--|--|--| |--|--|--|--|--|--|--|--|
|index |1659178324609|rw|undefined|undefined|undefined |undefined |undefined | |index |1659178324000|rw|undefined|undefined|undefined |undefined |undefined |
|Mattermost Plugin|1659108035000|rw|undefined|undefined|undefined |undefined |undefined | |Mattermost Plugin|1659108035000|rw|undefined|undefined|undefined |undefined |undefined |
|PLUGS |1659108634000|rw|undefined|undefined|undefined |undefined |undefined | |PLUGS |1659108634000|rw|undefined|undefined|undefined |undefined |undefined |
|Test Data Query |1659179547936|rw|undefined|undefined|undefined |undefined |undefined | |Test Data Query |1659179547000|rw|undefined|undefined|undefined |undefined |undefined |
|template/plug |1659108035000|rw|undefined|undefined|undefined |undefined |undefined | |template/plug |1659108035000|rw|undefined|undefined|undefined |undefined |undefined |
|template/tasks |1659108035000|rw|#each|undefined|undefined |undefined |undefined | |template/tasks |1659108035000|rw|#each|undefined|undefined |undefined |undefined |
|💡 Inspiration |1659108035000|rw|undefined|undefined|undefined |undefined |undefined | |💡 Inspiration |1659108035000|rw|undefined|undefined|undefined |undefined |undefined |
@ -116,7 +111,7 @@ For the sake of simplicity, we will use `page` data source and limit the results
<!-- #query page where type = "plug" order by lastModified desc limit 5 --> <!-- #query page where type = "plug" order by lastModified desc limit 5 -->
|name |lastModified |perm|type|uri |repo |author | |name |lastModified |perm|type|uri |repo |author |
|--|--|--|--|--|--|--| |--|--|--|--|--|--|--|
|🔌 Query |1659181148142|rw|plug|core:query |https://github.com/silverbulletmd/silverbullet |Silver Bullet Authors| |🔌 Query |1659194185345|rw|plug|core:query |https://github.com/silverbulletmd/silverbullet |Silver Bullet Authors|
|🔌 Mattermost|1659111156000|rw|plug|github:silverbulletmd/silverbullet-mattermost/mattermost.plug.json|https://github.com/silverbulletmd/silverbullet-mattermost|Zef Hemel | |🔌 Mattermost|1659111156000|rw|plug|github:silverbulletmd/silverbullet-mattermost/mattermost.plug.json|https://github.com/silverbulletmd/silverbullet-mattermost|Zef Hemel |
|🔌 Backlinks |1659108035000|rw|plug|ghr:Willyfrog/silverbullet-backlinks |https://github.com/Willyfrog/silverbullet-backlinks |Guillermo Vayá | |🔌 Backlinks |1659108035000|rw|plug|ghr:Willyfrog/silverbullet-backlinks |https://github.com/Willyfrog/silverbullet-backlinks |Guillermo Vayá |
|🔌 Ghost |1659108035000|rw|plug|github:silverbulletmd/silverbullet-ghost/ghost.plug.json |https://github.com/silverbulletmd/silverbullet-ghost |Zef Hemel | |🔌 Ghost |1659108035000|rw|plug|github:silverbulletmd/silverbullet-ghost/ghost.plug.json |https://github.com/silverbulletmd/silverbullet-ghost |Zef Hemel |