From 9485731e7db755ca7305f557efa241c0d8f3cbeb Mon Sep 17 00:00:00 2001 From: Shehab Ghazy Date: Sat, 10 Jun 2023 17:43:16 +0300 Subject: [PATCH 1/3] docs: Add PostgreSQL documentation --- packages/docs/pages/apps/postgres/actions.md | 18 ++++++++++++++++++ .../docs/pages/apps/postgres/connection.md | 19 +++++++++++++++++++ .../docs/pages/public/favicons/postgres.svg | 10 ++++++++++ 3 files changed, 47 insertions(+) create mode 100644 packages/docs/pages/apps/postgres/actions.md create mode 100644 packages/docs/pages/apps/postgres/connection.md create mode 100644 packages/docs/pages/public/favicons/postgres.svg diff --git a/packages/docs/pages/apps/postgres/actions.md b/packages/docs/pages/apps/postgres/actions.md new file mode 100644 index 00000000..21a8753d --- /dev/null +++ b/packages/docs/pages/apps/postgres/actions.md @@ -0,0 +1,18 @@ +--- +favicon: /favicons/postgres.svg +items: + - name: Insert + desc: Create a new row in a table in specified schema. + - name: Update + desc: Update rows found based on the given where clause entries. + - name: Delete + desc: Delete rows found based on the given where clause entries. + - name: SQL query + desc: Executes the given SQL statement.. +--- + + + + diff --git a/packages/docs/pages/apps/postgres/connection.md b/packages/docs/pages/apps/postgres/connection.md new file mode 100644 index 00000000..c733db85 --- /dev/null +++ b/packages/docs/pages/apps/postgres/connection.md @@ -0,0 +1,19 @@ +# PostgreSQL + +:::info +This page explains the steps you need to follow to set up the Postgres +connection in Automatisch. If any of the steps are outdated, please let us know! +::: + +PostgreSQL is an open-source relational database management system (RDBMS) known for its robustness, reliability, and feature-richness. +It is a powerful and reliable database management system suitable for a wide range of applications, from small projects to enterprise-level systems. + +1. Fill postgreSQL version field with the version that you are using. +2. Fill host address field with the postgres host address. +3. Fill port field with the postgres port. +4. Select wheather to use ssl or not. +5. Fill database name field with the postgres database name. +6. Fill database username field with the postgres username. +7. Fill password field with the postgres password. +8. Click **Submit** button on Automatisch. +9. Now, you can start using the PostgreSQL connection with Automatisch. \ No newline at end of file diff --git a/packages/docs/pages/public/favicons/postgres.svg b/packages/docs/pages/public/favicons/postgres.svg new file mode 100644 index 00000000..0bdb3e3e --- /dev/null +++ b/packages/docs/pages/public/favicons/postgres.svg @@ -0,0 +1,10 @@ + + + + + + + + + + From 0b362dd43594a6f1fb1e79178e3a6ee0b0635470 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Mon, 12 Jun 2023 11:11:39 +0200 Subject: [PATCH 2/3] docs: Use postgresql key name instead of postgres --- packages/docs/pages/.vitepress/config.js | 9 +++++++++ .../docs/pages/apps/{postgres => postgresql}/actions.md | 0 .../pages/apps/{postgres => postgresql}/connection.md | 0 3 files changed, 9 insertions(+) rename packages/docs/pages/apps/{postgres => postgresql}/actions.md (100%) rename packages/docs/pages/apps/{postgres => postgresql}/connection.md (100%) diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index ad0a4dd1..597d497d 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -151,6 +151,15 @@ export default defineConfig({ { text: 'Connection', link: '/apps/openai/connection' }, ], }, + { + text: 'PostgreSQL', + collapsible: true, + collapsed: true, + items: [ + { text: 'Actions', link: '/apps/postgresql/actions' }, + { text: 'Connection', link: '/apps/postgresql/connection' }, + ], + }, { text: 'RSS', collapsible: true, diff --git a/packages/docs/pages/apps/postgres/actions.md b/packages/docs/pages/apps/postgresql/actions.md similarity index 100% rename from packages/docs/pages/apps/postgres/actions.md rename to packages/docs/pages/apps/postgresql/actions.md diff --git a/packages/docs/pages/apps/postgres/connection.md b/packages/docs/pages/apps/postgresql/connection.md similarity index 100% rename from packages/docs/pages/apps/postgres/connection.md rename to packages/docs/pages/apps/postgresql/connection.md From 6d197119269cc7796bd3d0b311e663fcb50202c1 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Mon, 12 Jun 2023 11:13:09 +0200 Subject: [PATCH 3/3] docs: Add PostgreSQL to available apps --- packages/docs/pages/guide/available-apps.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/docs/pages/guide/available-apps.md b/packages/docs/pages/guide/available-apps.md index 6e966d35..0ce759c2 100644 --- a/packages/docs/pages/guide/available-apps.md +++ b/packages/docs/pages/guide/available-apps.md @@ -19,6 +19,7 @@ Following integrations are currently supported by Automatisch. - [HTTP Request](/apps/http-request/actions) - [Ntfy](/apps/ntfy/actions) - [OpenAI](/apps/openai/actions) +- [PostgreSQL](/apps/postgresql/actions) - [RSS](/apps/rss/triggers) - [Salesforce](/apps/salesforce/triggers) - [Scheduler](/apps/scheduler/triggers)