├── .editorconfig
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── .gitpod.yml
├── .ncurc.json
├── .npmrc
├── DEV_README.md
├── LICENSE.txt
├── README.md
├── assets
├── grafana-dashboard.png
├── obsidian.png
└── postgres.png
├── esbuild.config.mjs
├── jest.config.js
├── manifest.json
├── package.json
├── src
├── adapters
│ └── postgresql-adapter.ts
├── classes
│ ├── index.ts
│ ├── postgresql-plugin.ts
│ └── settings-tab.ts
├── constants
│ ├── default-settings.ts
│ └── index.ts
├── functions
│ ├── construct-adapter.spec.ts
│ └── construct-adapter.ts
├── interfaces
│ └── database-adapter.ts
├── main.ts
└── types
│ ├── adapter-name.ts
│ ├── index.ts
│ └── plugin-settings.ts
├── styles.css
├── sync.sh
├── tsconfig.json
├── version-bump.mjs
├── versions.json
└── yarn.lock
/.editorconfig:
--------------------------------------------------------------------------------
1 | # top-most EditorConfig file
2 | root = true
3 |
4 | [*]
5 | charset = utf-8
6 | end_of_line = lf
7 | insert_final_newline = true
8 | indent_style = tab
9 | indent_size = 4
10 | tab_width = 4
11 |
--------------------------------------------------------------------------------
/.eslintignore:
--------------------------------------------------------------------------------
1 | npm node_modules
2 | build
--------------------------------------------------------------------------------
/.eslintrc.js:
--------------------------------------------------------------------------------
1 | // This is a workaround for https://github.com/eslint/eslint/issues/3458
2 | require('@rushstack/eslint-config/patch/modern-module-resolution');
3 |
4 | /**
5 | * @type {import("eslint").Linter.Config}
6 | */
7 | const config = {
8 | extends: [ "@rushstack/eslint-config/profile/node", "@rushstack/eslint-config/mixins/friendly-locals" ], // <---- put your profile string here
9 | parserOptions: { tsconfigRootDir: __dirname },
10 |
11 | }
12 |
13 | module.exports = config
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # vscode
2 | .vscode
3 |
4 | # Intellij
5 | *.iml
6 | .idea
7 |
8 | # npm
9 | node_modules
10 |
11 | # Don't include the compiled main.js file in the repo.
12 | # They should be uploaded to GitHub releases instead.
13 | main.js
14 |
15 | # Exclude sourcemaps
16 | *.map
17 |
18 | # obsidian
19 | data.json
20 |
21 | # Exclude macOS Finder (System Explorer) View States
22 | .DS_Store
23 |
24 | # yarn
25 | yarn-error.log
--------------------------------------------------------------------------------
/.gitpod.yml:
--------------------------------------------------------------------------------
1 | tasks:
2 | - init: yarn install && yarn build
3 | command: yarn dev
4 |
5 | vscode:
6 | extensions:
7 | - esbenp.prettier-vscode
8 | - dbaeumer.vscode-eslint
9 | - WakaTime.vscode-wakatime
10 | - streetsidesoftware.code-spell-checker
11 | - eamodio.gitlens
12 | - mushan.vscode-paste-image
13 | - lukashass.volar
14 | - wayou.vscode-todo-highlight
15 | - nicoespeon.abracadabra
16 | - https://marketplace.visualstudio.com/_apis/public/gallery/publishers/nick-lvov-dev/vsextensions/typescript-explicit-types/0.0.9/vspackage
17 | - GitHub.copilot
18 | - GitHub.copilot-labs
19 | - nick-lvov-dev.typescript-explicit-types
20 |
--------------------------------------------------------------------------------
/.ncurc.json:
--------------------------------------------------------------------------------
1 | {
2 | "upgrade": true,
3 | "reject": ["@types/node"]
4 | }
5 |
--------------------------------------------------------------------------------
/.npmrc:
--------------------------------------------------------------------------------
1 | tag-version-prefix=""
--------------------------------------------------------------------------------
/DEV_README.md:
--------------------------------------------------------------------------------
1 | ## Developer's README.md
2 |
3 | ### Development instructions
4 |
5 | 1. Open this repository on Gitpod
6 | 2. Go to https://gitpod.io and copy your workspace SSH username and host inside `sync.sh`
7 | 3. Copy `sync.sh` inside `.obsidian/plugins`
8 | 4. Do some modifications on your remote Gitpod development instance
9 | 5. Execute `sync.sh` on your local computer (the plugin's files should get copied)
10 | 6. Restart Obsidian (using a keybinding is useful here)
11 | 7. Iterate steps 4 to 6 until you are satisfied.
12 | 8. Publish your work!
13 |
14 | ### Releasing a new version
15 |
16 | 1. Update your manifest.json with your new version number, such as 1.0.1, and the minimum Obsidian version required for your latest release.
17 | 2. Update your versions.json file with "new-plugin-version": "minimum-obsidian-version" so older versions of Obsidian can download an older version of your plugin that's compatible.
18 | 3. Update `package.json`
19 | 4. Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix v. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
20 | 5. Upload the files manifest.json, main.js, styles.css as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
21 | Publish the release.
22 |
--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) [2022] [Camille Louédoc-Eyries]
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | Obsidian + PostgreSQL = ❤️
3 |
4 |
5 |
6 | An Obsidian plugin to upload your notes' metadata to your database.
7 |
8 |
9 | ## Features
10 |
11 | - send the Dataview annotations of a page to a PostgreSQL database
12 | - 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)
13 |
14 | ## Installation
15 |
16 | 1. Get a PostgreSQL database (see section below)
17 | 2. Set your PostgreSQL connection string inside the settings
18 | 3. Open the command panel and type "PostgreSQL" to see the list of available commands
19 |
20 | ### Setting up a PostgreSQL database
21 |
22 | - Follow [this guide](https://www.postgresql.org/download/) to self-host PostgreSQL on your computer or a remote server.
23 | - You can also use a managed provider
24 | - [Amazon RDS](https://aws.amazon.com/fr/rds/postgresql/resources/)
25 | - [ElephantSQL](https://www.elephantsql.com/)
26 | - [Managed PostgreSQL for Heroku](https://www.heroku.com/postgres)
27 |
28 | I 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.
29 |
30 | I 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.
31 |
32 | ### Where is my data stored?
33 |
34 | The data produced by `postgresql-obsidian` is made available to you under the `obsidian` database schema.
35 |
36 | You can use PostgreSQL views to extract and format the information that you need.
37 |
38 | ### Why should I send my data to a PostgreSQL database?
39 |
40 | Sending 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).
41 |
42 | Here is a screenshot of the Grafana dashboard I made to monitor my personal health:
43 |
44 | 
45 |
46 | ## Contributing
47 |
48 | Contributions are what make the open source community such an amazing place to be, learn, inspire, and create. Any contributions you make are **greatly appreciated**!
49 |
50 | ### Development
51 |
52 | See the [developer documentation](./DEV_README.md) for more information.
53 |
54 | ### TODO
55 |
56 | - [x] overcomplicated development workflow
57 | - [x] set PostgreSQL URL in the settings
58 | - [ ] get various information from the current note
59 | - [x] Dataview data
60 | - [ ] list content
61 | - [ ] commands
62 | - [x] upload current note
63 | - [ ] bulk upload
64 | - [ ] automatic upload on edit
65 | - [ ] submit to Obsidian plugin registry
66 |
67 | ### Useful links
68 |
69 | - [Obsidian API documentation](https://github.com/obsidianmd/obsidian-api)
70 |
71 | ## Attribution
72 |
73 | - 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.
74 | - Thanks to the [Rush Stack](https://github.com/microsoft/rushstack) for providing an easy-to-use ESLint configuration.
75 | - Thanks to the [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview) for making it easy to access a note's metadata.
76 |
77 | ## License
78 |
79 | [MIT](LICENSE.txt)
80 |
81 |
82 |
83 |
84 |