silverbullet/website/🔌 Query.md

type: plug
uri: core:query
repo: https://github.com/silverbulletmd/silverbullet
author: Silver Bullet Authors

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.

2. Syntax

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

3. How to run a query?

After writing the query, there are two options

• Open the command palette and run Materialized Queries: Update
• 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

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 sources

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

4.2 Data that can be inserted by users

• insert the data: You can insert a data using the syntax below

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

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

4.3 Plugs’ data sources

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’ pages

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

We would like to get the list of all pages.

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

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

5.2 Simple query without a condition