blacksmithgu /obsidian-dataview

A data index and query language over Markdown files, for https://obsidian.md/.

★ 9,439⑂ 581👁 52⑃ 300● 1,475▤ 138
TypeScriptMITCreated 2021-01-13blacksmithgu.github.io/obsidian-dataview/
Download: 0.5.700.5.70 ↓0.5.702025-04-07
+2
Daily
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

Discussions

Latest release

0.5.70 0.5.70 2025-04-07
0.5.70 (Beta)

Still attempting to fix 2557, github is acting up.

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON