2022-07-28 17:47:36 +00:00
```meta
type: plug
uri: core:query
repo: https://github.com/silverbulletmd/silverbullet
author: Silver Bullet Authors
```
2022-07-30 11:11:24 +00:00
### 1. What?
2022-07-29 16:05:43 +00:00
The query plug is a built-in plug implementing the `<!-- #query -->` mechanism. You can use query plug to automatically receive information from your notes.
2022-07-30 11:11:24 +00:00
### 2. Syntax
2022-07-29 16:05:43 +00:00
1. start with: `<!-- #query [QUERY GOES HERE] -->`
2. end with: `<!-- /query -->`
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
* `where`
* `order`
* `limit`
* `select`
* `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 )
2022-07-30 11:11:24 +00:00
### 3. How to run a query?
2022-07-29 16:05:43 +00:00
After writing the query, there are two options
* Open the **command palette** and run **Materialized Queries: Update**
2022-07-30 11:03:57 +00:00
* 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
2022-07-29 16:05:43 +00:00
2022-07-30 11:11:24 +00:00
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
2022-07-30 11:13:43 +00:00
3. Plug’
2022-07-30 11:11:24 +00:00
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
2022-07-30 11:13:43 +00:00
#### 4.2 Data that can be inserted by users
* *insert the data:* You can insert a data using the syntax below
```data
name: John
age: 50
city: Milan
country: Italy
---
name: Jane
age: 53
city: Rome
country: Italy
---
name: Francesco
age: 28
city: Berlin
country: Germany
```
* *query the data:* You can query the data using `data` option
<!-- #query data where age > 20 and country = "Italy" -->
|name|age|city |country|page |pos |
|----|--|-----|-----|---------------|----|
|John|50|Milan|Italy|Test Data Query|0 |
|Jane|53|Rome |Italy|Test Data Query|46 |
|John|50|Milan|Italy|🔌 Query |2148|
|Jane|53|Rome |Italy|🔌 Query |2194|
2022-07-30 11:11:24 +00:00
<!-- /query -->
2022-07-30 11:16:40 +00:00
#### 4.3 Plugs’
Certain plugs can also give you special options to query a certain data. Some examples are
* [[🔌 Github]] provides `gh-pull` to query PRs for selected repo
* [[🔌 Mattermost]] provides `mm-saved` to fetch (by default 15) saved posts in Mattermost
For complete list of data sources, please check plugs’
2022-07-30 11:22:41 +00:00
### 5. Examples
We will walk you through a set of example starting from very basic one all the way to format the data using templates.
Our goal in this exercise is to (i) get all plug pages (ii) ordered by last modified time and (iii) display in a nice format.
For the sake of simplicity, we will use `page` data source and limit the results not to spoil the page.
#### 5.1 Simple query without any condition
2022-07-30 11:29:23 +00:00
**Goal:** We would like to get the list of all pages.
2022-07-30 11:22:41 +00:00
2022-07-30 11:29:23 +00:00
**Result:** Look at the data. This is more than we need. The query even gives us template pages. Lets try to limit it in the next step
2022-07-30 11:22:41 +00:00
<!-- #query page limit 10 -->
|name |lastModified |perm|tags |type|uri |repo |author |
|--|--|--|--|--|--|--|--|
|index |1659178324609|rw|undefined|undefined|undefined |undefined |undefined |
|Mattermost Plugin|1659108035000|rw|undefined|undefined|undefined |undefined |undefined |
|PLUGS |1659108634000|rw|undefined|undefined|undefined |undefined |undefined |
|Test Data Query |1659179547936|rw|undefined|undefined|undefined |undefined |undefined |
|template/plug |1659108035000|rw|undefined|undefined|undefined |undefined |undefined |
|template/tasks |1659108035000|rw|#each|undefined|undefined |undefined |undefined |
|💡 Inspiration |1659108035000|rw|undefined|undefined|undefined |undefined |undefined |
|🔌 Backlinks |1659108035000|rw|undefined|plug|ghr:Willyfrog/silverbullet-backlinks |https://github.com/Willyfrog/silverbullet-backlinks |Guillermo Vayá|
|🔌 Ghost |1659108035000|rw|undefined|plug|github:silverbulletmd/silverbullet-ghost/ghost.plug.json |https://github.com/silverbulletmd/silverbullet-ghost |Zef Hemel |
|🔌 Git |1659108035000|rw|undefined|plug|github:silverbulletmd/silverbullet-github/github.plug.json|https://github.com/silverbulletmd/silverbullet-github|Zef Hemel |
<!-- /query -->
#### 5.2 Simple query without a condition
2022-07-30 11:29:23 +00:00
**Goal:** We would like to get all plug pages and sorted by last modified time
**Result:** Okay, this what we wanted but there are also information such as perm, type and lastModified that we don't want to show in the page
2022-07-30 11:24:23 +00:00
<!-- #query page where type = "plug" order by lastModified desc limit 5 -->
|name |lastModified |perm|type|uri |repo |author |
|--|--|--|--|--|--|--|
2022-07-30 11:36:25 +00:00
|🔌 Query |1659180816719|rw|plug|core:query |https://github.com/silverbulletmd/silverbullet |Silver Bullet Authors|
2022-07-30 11:24:23 +00:00
|🔌 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á |
|🔌 Ghost |1659108035000|rw|plug|github:silverbulletmd/silverbullet-ghost/ghost.plug.json |https://github.com/silverbulletmd/silverbullet-ghost |Zef Hemel |
|🔌 Git |1659108035000|rw|plug|github:silverbulletmd/silverbullet-github/github.plug.json |https://github.com/silverbulletmd/silverbullet-github |Zef Hemel |
<!-- /query -->
2022-07-30 11:29:23 +00:00
#### 5.3 Query to select only certain fields
**Goal:** We would like to get all plug pages, select only `name` and `uri` column and sort by last modified time and
**Result:** Okay, this is much better. However, I believe this needs a touch from a visual perspective
2022-07-30 11:36:25 +00:00
<!-- #query page select name author repo uri where type = "plug" order by lastModified desc limit 5 -->
|name |author |repo |
|--|--|--|
|🔌 Query |Silver Bullet Authors|https://github.com/silverbulletmd/silverbullet |
|🔌 Mattermost|Zef Hemel |https://github.com/silverbulletmd/silverbullet-mattermost|
|🔌 Backlinks |Guillermo Vayá |https://github.com/Willyfrog/silverbullet-backlinks |
|🔌 Ghost |Zef Hemel |https://github.com/silverbulletmd/silverbullet-ghost |
|🔌 Git |Zef Hemel |https://github.com/silverbulletmd/silverbullet-github |
2022-07-30 11:29:23 +00:00
<!-- /query -->
2022-07-30 11:36:25 +00:00
#### 5.4 Display the data in a format defined by a template
**Goal:** We would like to display the data from 5.3 in a nice format using bullet points with links to Plug pages, with author name and link to their GitHub repo.
**Result:** Here you go this is the result we would like to achieve 🎉. Did you see how I used `render` and `template/plug` in a query? 🚀
<!-- #query page select name author repo uri where type = "plug" order by lastModified desc limit 5 render "template/plug" -->
* [[🔌 Query]] by **Silver Bullet Authors** ([repo](https://github.com/silverbulletmd/silverbullet))
* [[🔌 Mattermost]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-mattermost))
* [[🔌 Backlinks]] by **Guillermo Vayá** ([repo](https://github.com/Willyfrog/silverbullet-backlinks))
* [[🔌 Ghost]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-ghost))
* [[🔌 Git]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-github))
<!-- /query -->
