https://github.com/daamien/pandoc-run-postgres
Execute SQL queries inside a markdown document
https://github.com/daamien/pandoc-run-postgres
Last synced: 3 months ago
JSON representation
Execute SQL queries inside a markdown document
- Host: GitHub
- URL: https://github.com/daamien/pandoc-run-postgres
- Owner: daamien
- Created: 2022-12-11T23:16:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-06T14:45:20.000Z (3 months ago)
- Last Synced: 2025-03-06T15:07:28.591Z (3 months ago)
- Language: Python
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# pandoc-run-postgres
Execute SQL queries inside a markdown document
## Example
1. Write a SQL query in a code block
~~~ markdown
``` run-postgres
SELECT oid, 'hello ' || rolname || '!' AS greetings from pg_roles
Limit 2;
```
~~~
2. Call pandoc
```
export PGHOST=localhost
export PGDATABASE=foo
export PGUSER=bob
export PGPASSWORD=xxxxxxxx
pandoc --filter pandoc-run-postgres hello.md -o result.md
```
3. The output will contain the SQL query inside a SQL codeblock and
the result in a table:
~~~ markdown
```sql
SELECT oid,
'hello ' || rolname || '!' AS greetings
FROM pg_roles
LIMIT 2;
```
oid greetings
------ -----------------------------
33731 hello bob!
33748 hello alice!
~~~
## Install
```
pip install pandoc-run-postgres
```
## Configuration
See examples in `sample.md`.
## Similar projects
* [pandoc-filter-runsql] for MySQL
* Jupyter's [ipython-sql]
[ipython-sql]: https://github.com/catherinedevlin/ipython-sql
[pandoc-filter-runsql]: https://github.com/barskern/pandoc-filter-runsql