{"id":14070450,"url":"https://github.com/clouedoc/postgresql-obsidian","last_synced_at":"2025-07-30T07:33:26.719Z","repository":{"id":39645029,"uuid":"502609791","full_name":"clouedoc/postgresql-obsidian","owner":"clouedoc","description":"An Obsidian plugin to upload your notes' metadata to your database.","archived":true,"fork":false,"pushed_at":"2023-07-07T12:39:17.000Z","size":830,"stargazers_count":62,"open_issues_count":7,"forks_count":10,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-13T07:17:58.181Z","etag":null,"topics":["database","obsidian-md","obsidian-plugin","postgresql","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clouedoc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-12T12:28:18.000Z","updated_at":"2024-06-24T20:41:33.000Z","dependencies_parsed_at":"2024-08-13T07:17:17.587Z","dependency_job_id":"77a2af83-08d6-46dc-ba75-8c01bb457ffa","html_url":"https://github.com/clouedoc/postgresql-obsidian","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":"obsidianmd/obsidian-sample-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clouedoc%2Fpostgresql-obsidian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clouedoc%2Fpostgresql-obsidian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clouedoc%2Fpostgresql-obsidian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clouedoc%2Fpostgresql-obsidian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clouedoc","download_url":"https://codeload.github.com/clouedoc/postgresql-obsidian/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228110330,"owners_count":17871162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","obsidian-md","obsidian-plugin","postgresql","typescript"],"created_at":"2024-08-13T07:07:46.367Z","updated_at":"2024-12-04T12:31:04.430Z","avatar_url":"https://github.com/clouedoc.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  Obsidian + PostgreSQL = ❤️\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    An \u003ca href=\"https://obsidian.md\"\u003eObsidian\u003c/a\u003e plugin to upload your notes' metadata to your database.\n\u003c/p\u003e\n\n## Features\n\n-   send the Dataview annotations of a page to a PostgreSQL database\n    -   this lets you use SQL queries on your data and integrate it with other tools, such as [Grafana](https://github.com/grafana/grafana/blob/main/README.md)\n\n## Installation\n\n1. Get a PostgreSQL database (see section below)\n2. Set your PostgreSQL connection string inside the settings\n3. Open the command panel and type \"PostgreSQL\" to see the list of available commands\n\n### Setting up a PostgreSQL database\n\n-   Follow [this guide](https://www.postgresql.org/download/) to self-host PostgreSQL on your computer or a remote server.\n-   You can also use a managed provider\n    -   [Amazon RDS](https://aws.amazon.com/fr/rds/postgresql/resources/)\n    -   [ElephantSQL](https://www.elephantsql.com/)\n    -   [Managed PostgreSQL for Heroku](https://www.heroku.com/postgres)\n\nI personally prefer to self-host PostgreSQL on an offshore server to protect my privacy. However, do note that it takes a bit more knowledge since if you host on a remote server, you will learn how to enable network encryption (SSL) to prevent unauthorized intermediaries from snooping on your data.\n\nI did not try the managed providers that I listed above, but they are from reputable companies and provide way more storage and compute power than you will ever need to host the data generated by this plugin.\n\n### Where is my data stored?\n\nThe data produced by `postgresql-obsidian` is made available to you under the `obsidian` database schema.\n\nYou can use PostgreSQL views to extract and format the information that you need.\n\n### Why should I send my data to a PostgreSQL database?\n\nSending the metadata of your notes to a PostgreSQL database will allow you to explore it with other tools, such as [Grafana](https://github.com/grafana/grafana/blob/main/README.md).\n\nHere is a screenshot of the Grafana dashboard I made to monitor my personal health:\n\n![Grafana dashboard of clouedoc's health, made using the data produced by the postgresql-obsidian plugin. It features charts of an ok-ish lifestyle.](./assets/grafana-dashboard.png)\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to be, learn, inspire, and create. Any contributions you make are **greatly appreciated**!\n\n### Development\n\nSee the [developer documentation](./DEV_README.md) for more information.\n\n### TODO\n\n-   [x] overcomplicated development workflow\n-   [x] set PostgreSQL URL in the settings\n-   [ ] get various information from the current note\n    -   [x] Dataview data\n    -   [ ] list content\n-   [ ] commands\n    -   [x] upload current note\n    -   [ ] bulk upload\n    -   [ ] automatic upload on edit\n-   [ ] submit to Obsidian plugin registry\n\n### Useful links\n\n-   [Obsidian API documentation](https://github.com/obsidianmd/obsidian-api)\n\n## Attribution\n\n-   Thanks to [pg](https://github.com/brianc/node-postgres/tree/master/packages/pg) for making it possible to easily connect to a PostgreSQL database from JavaScript.\n-   Thanks to the [Rush Stack](https://github.com/microsoft/rushstack) for providing an easy-to-use ESLint configuration.\n-   Thanks to the [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview) for making it easy to access a note's metadata.\n\n## License\n\n[MIT](LICENSE.txt)\n\n\u003cdiv style=\"display: flex; justify-content: center; vertical-align: middle;\"\u003e\n    \u003cimg height=50 src=\"./assets/obsidian.png\" class=\"center\"\u003e\n    \u003cimg height=50 src=\"./assets/postgres.png\" class=\"center\"\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclouedoc%2Fpostgresql-obsidian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclouedoc%2Fpostgresql-obsidian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclouedoc%2Fpostgresql-obsidian/lists"}