blacksmithgu /obsidian-dataview
A data index and query language over Markdown files, for https://obsidian.md/.
★ 9,439⑂ 581👁 52⑃ 300● 1,475▤ 138
+2
日增长
9,439
stars
581
forks
52
watchers
300
prs
1,475
issues
138
releases
README
Obsidian Dataview
Treat your Obsidian Vault as a database which you can query from. Provides a JavaScript API and
pipeline-based query language for filtering, sorting, and extracting data from Markdown pages. See the Examples section
below for some quick examples, or the full reference for all the details.
Examples
Show all games in the game folder, sorted by rating, with some metadata:
~~~markdown
dataview
table time-played, length, rating
from "games"
sort rating desc
~~~
!Game Example
---
List games which are MOBAs or CRPGs.
~~~markdown
dataview
list from game/moba or game/crpg
~~~
!Game List
---
List all markdown tasks in un-completed projects:
~~~markdown
dataview
task from projects/active
~~~
!Task List
---
Show all files in the books folder that you read in 2021, grouped by genre and sorted by rating:
~~~markdown
dataviewjs
for (let group of dv.pages("book").where(p = p["time-read"].year == 2021).groupBy(p = p.genre)) {
dv.header(3, group.key);
dv.table(["Name", "Time Read", "Rating"],
group.rows
.sort(k = k.rating, 'desc')
.map(k = [k.file.link, k["time-read"], k.rating]))
}
~~~
!Books By Genre
Usage
For a full description of all features, instructions, and examples, see the reference. For a more brief outline, let us examine the two major aspects of Dataview: data and querying.
Data
Dataview generates data from your vault by pulling
information from Markdown frontmatter and Inline fields.
- Markdown frontmatter is arbitrary YAML enclosed by --- at the top of a markdown document which can store metadata
about that document.
- Inline fields are a Dataview feature which allow you to write metadata directly inline in your markdown document via
Key:: Value syntax.
Examples of both are shown below:
yaml
---
alias: "document"
last-reviewed: 2021-08-17
thoughts:
rating: 8
reviewable: false
---
markdown
Markdown Page
Basic Field:: Value
Bold Field:: Nice!
You can also write [field:: inline fields]; multiple [field2:: on the same line].
If you want to hide the (field3:: key), you can do that too.
Querying
Once you've annotated documents and the like with metadata, you can then query it using any of Dataview's four query
modes:
1. Dataview Query Language (DQL): A pipeline-based, vaguely SQL-looking expression language which can support basic
use cases. See the documentation for details.
~~~markdown
dataview
TABLE file.name AS "File", rating AS "Rating" FROM book
~~~
2. Inline Expressions: DQL expressions which you can embed directly inside markdown and which will be evaluated in
preview mode. See the documentation for
allowable queries.
markdown
We are on page = this.file.name.
3. DataviewJS: A high-powered JavaScript API which gives full access to the Dataview index and some convenient
rendering utilities. Highly recommended if you know JavaScript, since this is far more powerful than the query
language. Check the documentation for more details.
Top issues
#42"Burning out" dataviews142 comments · 2021-03-18#555support markdown tables as data sources35 comments · 2021-10-17#812Support for alternate checkbox tasks32 comments · 2022-01-26#63Links from dataview rendered in the graph view27 comments · 2021-03-28#1075Bug report: excessive refreshing25 comments · 2022-05-09#1234dv table displaying due dates doesn't pick up due dates in tasks24 comments · 2022-07-04#57Transclusion of links23 comments · 2021-03-24#234List other filetypes in vault22 comments · 2021-05-19
Discussions
#2664How to make loading a table faster or more beautiful?0 comments · 2026-04-19#2655Update README to suggest users use Obsidian Bases1 comments · 2026-02-18#2654Render contents under a heading using dv.paragraph0 comments · 2026-02-15#2653WHERE clause with AND => need to stop evaluation early0 comments · 2026-02-13#2652Has anything changed in recent versions?0 comments · 2026-02-10#2648Get list items by tag, plus all descendents0 comments · 2026-01-03#2645Open to a PR for customising Calendar dots?1 comments · 2025-12-26#2644saving calculations in metadata fields doesn't work0 comments · 2025-12-23
Latest release
0.5.70 0.5.70 2025-04-070.5.70 (Beta) Still attempting to fix 2557, github is acting up.