From adf565fe3d174c9f13c6bca84729419c05734f5e Mon Sep 17 00:00:00 2001 From: Rob Dominguez Date: Mon, 5 Dec 2022 18:11:06 -0600 Subject: [PATCH] docs: make cloud db guides agnostic PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7127 Co-authored-by: Sean Park-Ross <94021366+seanparkross@users.noreply.github.com> GitOrigin-RevId: 7ea4fc8829216308878085577412b4a9b8c5942e --- .../cloud-databases/_category_.json | 5 +- .../connect-db/cloud-databases/aiven.mdx | 56 +++++-- .../connect-db/cloud-databases/alloy.mdx | 51 +++--- .../connect-db/cloud-databases/aws-aurora.mdx | 56 ++++--- .../cloud-databases/aws-postgres.mdx | 60 ++++--- .../cloud-databases/azure-cosmos.mdx | 38 +++-- .../connect-db/cloud-databases/azure.mdx | 59 ++++--- .../connect-db/cloud-databases/crunchy.mdx | 38 +++-- .../cloud-databases/digital-ocean.mdx | 58 ++++--- .../connect-db/cloud-databases/elephant.mdx | 80 ++++----- .../cloud-databases/enterprisedb.mdx | 88 +++++----- .../connect-db/cloud-databases/gcp.mdx | 100 ++++++----- .../connect-db/cloud-databases/heroku.mdx | 7 +- .../connect-db/cloud-databases/index.mdx | 156 +++++++++--------- .../connect-db/cloud-databases/mssql.mdx | 95 ++++++----- .../connect-db/cloud-databases/neon.mdx | 19 +-- .../connect-db/cloud-databases/railway.mdx | 68 ++++---- .../connect-db/cloud-databases/render.mdx | 62 +++---- .../connect-db/cloud-databases/supabase.mdx | 102 ++++++------ .../cloud-databases/timescale-cloud.mdx | 82 +++++---- .../connect-db/cloud-databases/yugabyte.mdx | 99 ++++++----- 21 files changed, 792 insertions(+), 587 deletions(-) diff --git a/docs/docs/databases/connect-db/cloud-databases/_category_.json b/docs/docs/databases/connect-db/cloud-databases/_category_.json index 97c5f4eaa28..9c3927815f4 100644 --- a/docs/docs/databases/connect-db/cloud-databases/_category_.json +++ b/docs/docs/databases/connect-db/cloud-databases/_category_.json @@ -1,5 +1,4 @@ { - "label": "Cloud databases guides", - "position": 1, - "className": "cloud-icon" + "label": "Cloud database guides", + "position": 1 } diff --git a/docs/docs/databases/connect-db/cloud-databases/aiven.mdx b/docs/docs/databases/connect-db/cloud-databases/aiven.mdx index 39704e5d9b5..3fb239ee543 100644 --- a/docs/docs/databases/connect-db/cloud-databases/aiven.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/aiven.mdx @@ -14,16 +14,23 @@ sidebar_position: 2 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with an Aiven Postgres Database - -
Available on: Cloud
+# Connecting Hasura to an Aiven Postgres Database ## Introduction -This guide explains how to connect a new or existing Aiven Postgres database to a Hasura Cloud project. If you're -exploring Aiven and are interested in migrating an existing Postgres database - such as from Heroku - check out their +This guide explains how to connect a new or existing [Aiven Postgres](https://aiven.io/postgresql) database to a Hasura +instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our +[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring Aiven and are interested in +migrating an existing Postgres database - such as from Heroku - check out their [docs](https://docs.aiven.io/docs/products/postgresql/howto/migrate-pg-dump-restore.html) before continuing below. +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura +instance and already have a project running, skip to [step 3](#create-pg-db-aiven). + +::: + ## Step 1: Sign up or log in to Hasura Cloud Navigate to [Hasura Cloud](https://cloud.hasura.io/signup/?pg=docs&plcmt=body&cta=navigate-to-hasura-cloud&tech=default) @@ -35,15 +42,20 @@ On the Hasura Cloud dashboard, create a new project: -After the project is initialized successfully, click on `Launch console` to open the Hasura console in your browser. +After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: - -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -## Step 3: Create a Postgres DB on Aiven (skip if you have an existing DB) {#create-pg-db-aiven} +## Step 3: Create a Postgres DB on Aiven {#create-pg-db-aiven} + +:::info Note + +If you have an existing Aiven Postgres database, you can skip this step and move on to [step 4](#connect-hasura-aiven). + +::: Log into the [Aiven console](https://console.aiven.io/login). @@ -70,7 +82,7 @@ If you're using a database user other than the default one, make sure to give it ::: -## Step 4: Allow connections to your DB from Hasura Cloud +## Step 4: Allow connections to your DB from Hasura {#connect-hasura-aiven} On the `Services` dashboard, click on your DB: @@ -84,10 +96,18 @@ Scroll down to `Allowed IP Addresses` and click on `Change`: width='1000px' /> -Copy the IP address from the copy icon in the `Hasura Cloud IP` field on the project's details view on Hasura Cloud. +If you're using Hasura Cloud, you can quickly find your IP address from the `Hasura Cloud IP` field on the project's +details view: +:::info Note + +If you're using a self-hosted solution, you'll need to determine the IP address manually depending on your hosting +service. + +::: + Add the Hasura IP address that you copied, click on the `+`: @@ -108,7 +128,7 @@ To get it, navigate to the `Overview` tab of your database dashboard and copy th ## Step 6: Finish connecting the database -Back on Hasura Console, enter the database URL that we retrieved in [step 5](#get-db-url-aiven): +Back on the Hasura Console, enter the database URL that we retrieved in [step 5](#get-db-url-aiven): @@ -127,12 +147,12 @@ Voilà. You are ready to start developing. ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or -[custom domains](/projects/domains.mdx)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or + [custom domains](/projects/domains.mdx)). diff --git a/docs/docs/databases/connect-db/cloud-databases/alloy.mdx b/docs/docs/databases/connect-db/cloud-databases/alloy.mdx index 7c52380be53..35cce12c061 100644 --- a/docs/docs/databases/connect-db/cloud-databases/alloy.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/alloy.mdx @@ -16,15 +16,21 @@ sidebar_position: 3 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with a Google AlloyDB Postgres Database - -
Available on: Cloud
+# Connecting Hasura to a Google AlloyDB Postgres Database ## Introduction -This guide explains how to connect a new or existing Google AlloyDB Postgres database to a Hasura Cloud project. If -you're exploring AlloyDB Postgres, check out their [docs](https://cloud.google.com/alloydb/docs) before continuing -below. +This guide explains how to connect a new or existing [Google AlloyDB Postgres](https://cloud.google.com/alloydb) +database to a Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our +[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring AlloyDB Postgres, check out +their [docs](https://cloud.google.com/alloydb/docs) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-alloy). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -39,9 +45,8 @@ On the Hasura Cloud dashboard, create a new project: After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: - -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. @@ -121,7 +126,7 @@ Provide a name for this instance and set the following properties: :::tip Tip - For the best performance, select the GCE region as the same or closest to your Hasura Cloud project's region. + For the best performance, select the GCE region as the same or closest to whichever region hosts your Hasura instance. ::: @@ -156,16 +161,24 @@ Additionally, you may have to specify a different version of the auth proxy, suc ## Step 5: Add a firewall rule -With our auth proxy now running, you'll need to create a firewall rule that allows a connection from your Hasura Cloud -project. From your project's dashboard, copy the Hasura Cloud IP address: +With our auth proxy now running, you'll need to create a firewall rule that allows a connection from your Hasura +instance. If using Hasura Cloud, from your project's dashboard, copy the Hasura Cloud IP address: +:::info Note + +If you're using a self-hosted solution, you'll need to determine the IP address manually depending on your hosting +service. + +::: + Within the **VPC Firewall settings**, add a new rule by clicking, `CREATE FIREWALL RULE`: -Permit connections to port `5432` and specify the Hasura Cloud IP address in the IPv4 range and click `CREATE`: +Permit connections to port `5432` and specify the IP address of your Hasura instance in the IPv4 range and click +`CREATE`: @@ -182,7 +195,7 @@ postgresql://:@:54 [step 3](#create-pg-db-alloy). - The `ip-address-of-gce-instance` is from [step 4](#create-gce-instance) when you created a GCE VM instance. -Back on Hasura Console, enter the database URL: +Back on the Hasura Console, enter the database URL: @@ -201,12 +214,12 @@ Voilà. You are ready to start developing. ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or -[custom domains](/projects/domains.mdx)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or + [custom domains](/projects/domains.mdx)). diff --git a/docs/docs/databases/connect-db/cloud-databases/aws-aurora.mdx b/docs/docs/databases/connect-db/cloud-databases/aws-aurora.mdx index 47b83a6bf75..baa2c899c4b 100644 --- a/docs/docs/databases/connect-db/cloud-databases/aws-aurora.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/aws-aurora.mdx @@ -14,18 +14,24 @@ sidebar_position: 4 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with an AWS RDS Aurora Postgres Database - -
Available on: Cloud
+# Connecting Hasura to an AWS RDS Aurora Postgres Database ## Introduction -This guide explains how to connect a new or existing AWS RDS Aurora Postgres database to a Hasura Cloud project. If -you're exploring AWS RDS Aurora Postgres and are interested in migrating an existing Postgres database - such as from -Heroku - check out their +This guide explains how to connect a new or existing [AWS RDS Aurora Postgres](https://aws.amazon.com/rds/aurora/) +database to a Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our [self-hosted] +(/deployment/deployment-guides/index.mdx) solutions. If you're exploring AWS RDS Aurora Postgres and are interested +in migrating an existing Postgres database - such as from Heroku - check out their [docs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html) before continuing below. +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-aurora). + +::: + ## Step 1: Sign up or log in to Hasura Cloud Navigate to [Hasura Cloud](https://cloud.hasura.io/signup/?pg=docs&plcmt=body&cta=navigate-to-hasura-cloud&tech=default) @@ -37,15 +43,20 @@ On the Hasura Cloud dashboard, create a new project: -After the project is initialized successfully, click on `Launch console` to open the Hasura console in your browser. +After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: - -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -## Step 3: Create an Aurora DB on AWS RDS (skip if you have an existing DB) {#create-pg-aws-rds-aurora} +## Step 3: Create an Aurora DB on AWS RDS {#create-pg-db-aurora} + +:::info Note + +If you have an existing Aurora DB, you can skip this step and move on to [step 4](#connect-hasura-aws-rds-aurora). + +::: Log into the [AWS console](https://console.aws.amazon.com//). @@ -92,7 +103,7 @@ If you're using a database user other than the default one, make sure to give it ::: -## Step 4: Allow connections to your DB from Hasura Cloud +## Step 4: Allow connections to your DB from Hasura {#connect-hasura-aws-rds-aurora} On the database dashboard, click on `Connectivity & security`. On the right, click on the security group that you selected or added in [step 3](#create-pg-aws-rds-aurora). @@ -119,10 +130,17 @@ Click on `Add rule`: width='1000px' /> -Copy the IP address from the copy icon in the `Hasura Cloud IP` field on the project's details view on Hasura Cloud. +If using Hasura Cloud, from your project's dashboard, copy the Hasura Cloud IP address: +:::info Note + +If you're using a self-hosted solution, you'll need to determine the IP address manually depending on your hosting +service. + +::: + Add the Hasura IP address that you copied: @@ -155,7 +173,7 @@ On the database dashboard, click on `Connectivity & security`: ## Step 6: Finish connecting the database -Back on Hasura Console, enter the database URL that we retrieved in [step 5](#construct-db-url-aurora): +Back on the Hasura Console, enter the database URL that we retrieved in [step 5](#construct-db-url-aurora): @@ -174,12 +192,12 @@ Voilà. You are ready to start developing. ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or -[custom domains](/projects/domains.mdx)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or + [custom domains](/projects/domains.mdx)). diff --git a/docs/docs/databases/connect-db/cloud-databases/aws-postgres.mdx b/docs/docs/databases/connect-db/cloud-databases/aws-postgres.mdx index 8f409bd52cd..500e517e71d 100644 --- a/docs/docs/databases/connect-db/cloud-databases/aws-postgres.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/aws-postgres.mdx @@ -14,16 +14,23 @@ sidebar_position: 5 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with an AWS RDS Postgres Database - -
Available on: Cloud
+# Connecting Hasura to an AWS RDS Postgres Database ## Introduction -This guide explains how to connect a new or existing AWS RDS Postgres database to a Hasura Cloud project. If you're -exploring AWS RDS Postgres and are interested in migrating an existing Postgres database - such as from Heroku - check -out their [docs](https://aws.amazon.com/getting-started/hands-on/move-to-managed/migrate-postgresql-to-amazon-rds/) -before continuing below. +This guide explains how to connect a new or existing [AWS RDS Postgres](https://aws.amazon.com/rds/) database to a +Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our +[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring AWS RDS Postgres and are +interested in migrating an existing Postgres database - such as from Heroku - check out their +[docs](https://aws.amazon.com/getting-started/hands-on/move-to-managed/migrate-postgresql-to-amazon-rds/) before +continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-hasura-project-aws-rds-postgres). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -36,15 +43,21 @@ On the Hasura Cloud dashboard, create a new project: -After the project is initialized successfully, click on `Launch console` to open the Hasura console in your browser. +After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: - -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -## Step 3: Create a Postgres DB on AWS (skip if you have an existing DB) {#create-aws-rds-postgres-db} +## Step 3: Create a Postgres DB on AWS {#create-aws-rds-postgres-db} + +:::info Note + +If you have an existing Postgres database on AWS, you can skip this step and move on to +[step 4](#connect-hasura-aws-pg). + +::: Log into the [AWS console](https://console.aws.amazon.com//). @@ -88,7 +101,7 @@ If you're using a database user other than the default one, make sure to give it ::: -## Step 4: Allow connections to your DB from Hasura Cloud +## Step 4: Allow connections to your DB from Hasura {#connect-hasura-aws-pg} On the database dashboard, click on `Connectivity & security`. On the right, click on the security group that you selected or added in [step 3](/databases/connect-db/cloud-databases/aws-postgres.mdx#create-aws-rds-postgres-db). @@ -115,10 +128,17 @@ Click on `Add rule`: width='1000px' /> -Copy the IP address from the copy icon in the `Hasura Cloud IP` field on the project's details view on Hasura Cloud. +If using Hasura Cloud, from your project's dashboard, copy the Hasura Cloud IP address: +:::info Note + +If you're using a self-hosted solution, you'll need to determine the IP address manually depending on your hosting +service. + +::: + Add the Hasura IP address that you copied: @@ -151,7 +171,7 @@ On the database dashboard, click on `Connectivity & security`: ## Step 6: Finish connecting the database -Back on Hasura Console, enter the database URL that we retrieved in +Back on the Hasura Console, enter the database URL that we retrieved in [step 5](/databases/connect-db/cloud-databases/aws-postgres.mdx#construct-db-url-aws-postgres): @@ -171,12 +191,12 @@ Voilà. You are ready to start developing. ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or -[custom domains](/projects/domains.mdx)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or + [custom domains](/projects/domains.mdx)). diff --git a/docs/docs/databases/connect-db/cloud-databases/azure-cosmos.mdx b/docs/docs/databases/connect-db/cloud-databases/azure-cosmos.mdx index da2d79a53f9..67dfa5936d6 100644 --- a/docs/docs/databases/connect-db/cloud-databases/azure-cosmos.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/azure-cosmos.mdx @@ -15,15 +15,22 @@ sidebar_position: 6 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with an Azure Cosmos DB for PostgreSQL - -
Available on: Cloud
+# Connecting Hasura to an Azure Cosmos DB for PostgreSQL ## Introduction -This guide explains how to connect a new Azure Cosmos DB for PostgreSQL to a Hasura Cloud project. If you're exploring -Azure Cosmos DB for PostgreSQL, check out their [docs](https://azure.microsoft.com/en-us/products/cosmos-db/#overview) -before continuing below. +This guide explains how to connect a new +[Azure Cosmos DB for PostgreSQL](https://learn.microsoft.com/en-us/azure/cosmos-db/postgresql/introduction) to a Hasura +instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our +[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring Azure Cosmos DB for PostgreSQL, +check out their [docs](https://azure.microsoft.com/en-us/products/cosmos-db/#overview) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-azure). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -38,13 +45,12 @@ On the Hasura Cloud dashboard, create a new project: After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: - -You will get prompted for a PostgreSQL Database URL. We will create this in the next step and then come back here. +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -## Step 3: Create a Cosmos DB on Azure +## Step 3: Create a Cosmos DB on Azure {#create-pg-db-azure} You can start a free trial with [Azure Cosmos DB](https://cosmos.azure.com/try/). Select Azure Cosmos DB for PostgreSQL and click `Create`: @@ -98,13 +104,13 @@ Voilà. You are ready to start developing. ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx#manage-project-collaborators), -[env vars](/projects/env-vars.mdx#manage-project-env-vars) or -[custom domains](/projects/domains.mdx#manage-project-domains)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx#manage-project-collaborators), + [env vars](/projects/env-vars.mdx#manage-project-env-vars) or + [custom domains](/projects/domains.mdx#manage-project-domains)). diff --git a/docs/docs/databases/connect-db/cloud-databases/azure.mdx b/docs/docs/databases/connect-db/cloud-databases/azure.mdx index d03a3ffc8b2..0ad4182c0df 100644 --- a/docs/docs/databases/connect-db/cloud-databases/azure.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/azure.mdx @@ -14,16 +14,24 @@ sidebar_position: 8 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with an Azure Postgres Database - -
Available on: Cloud
+# Connecting Hasura to an Azure Postgres Database ## Introduction -This guide explains how to connect a new or existing Azure Postgres database to a Hasura Cloud project. If you're -exploring Azure Postgres and are interested in migrating an existing Postgres database - such as from Heroku - check out -their [docs](https://learn.microsoft.com/en-us/azure/dms/tutorial-postgresql-azure-postgresql-online-portal) before -continuing below. +This guide explains how to connect a new or existing +[Azure Postgres database](https://azure.microsoft.com/en-us/products/postgresql/) to a Hasura instance, either on +[Hasura Cloud](https://cloud.hasura.io) or via one of our [self-hosted](/deployment/deployment-guides/index.mdx) +solutions. If you're exploring Azure Postgres and are interested in migrating an existing Postgres database - such as +from Heroku - check out their +[docs](https://learn.microsoft.com/en-us/azure/dms/tutorial-postgresql-azure-postgresql-online-portal) before continuing +below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-azure). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -36,15 +44,14 @@ On the Hasura Cloud dashboard, create a new project: -After the project is initialized successfully, click on `Launch console` to open the Hasura console in your browser. +After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: - -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -## Step 3: Create a Postgres DB on Azure (skip if you have an existing DB) +## Step 3: Create a Postgres DB on Azure {#create-pg-db-azure} Log into the [Azure portal](https://portal.azure.com). @@ -81,15 +88,23 @@ console. Hasura v2.x works fine with JIT enabled. ::: -## Step 4: Allow connections to your DB from Hasura Cloud +## Step 4: Allow connections to your DB from Hasura On the database dashboard, click on `Connection security` under `Settings` on the left navigation bar. On `Allow access to Azure services`, click the `Yes` button. Then add a Firewall rule for Hasura. -Copy the IP address from the copy icon in the `Hasura Cloud IP` field on the project's details view on Hasura Cloud. +If you're using Hasura Cloud, you can quickly find your IP address from the `Hasura Cloud IP` field on the project's +details view: - + + +:::info Note + +If you're using a self-hosted solution, you'll need to determine the IP address manually depending on your hosting +service. + +::: Add the Hasura IP address that you copied: @@ -122,7 +137,7 @@ On the database dashboard, click on `Overview`: ## Step 6: Finish connecting the database -Back on Hasura Console, enter the database URL that we retrieved in [step 5](#get-db-url-azure): +Back on the Hasura Console, enter the database URL that we retrieved in [step 5](#get-db-url-azure): @@ -142,13 +157,13 @@ Voilà. You are ready to start developing. ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx#manage-project-collaborators), -[env vars](/projects/env-vars.mdx#manage-project-env-vars) or -[custom domains](/projects/domains.mdx#manage-project-domains)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx#manage-project-collaborators), + [env vars](/projects/env-vars.mdx#manage-project-env-vars) or + [custom domains](/projects/domains.mdx#manage-project-domains)). diff --git a/docs/docs/databases/connect-db/cloud-databases/crunchy.mdx b/docs/docs/databases/connect-db/cloud-databases/crunchy.mdx index 1fa5c42b54d..47cb9c3870c 100644 --- a/docs/docs/databases/connect-db/cloud-databases/crunchy.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/crunchy.mdx @@ -14,15 +14,22 @@ sidebar_position: 9 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with a Crunchy Postgres Database - -
Available on: Cloud
+# Connecting Hasura to a Crunchy Postgres Database ## Introduction -This guide explains how to connect a new or existing Crunchy Postgres database to a Hasura Cloud project. If you're -exploring Crunchy Postgres and are interested in migrating an existing Postgres database - such as from Heroku - check -out their [docs](https://www.crunchydata.com/migrate-from-heroku) before continuing below. +This guide explains how to connect a new or existing [Crunchy Postgres](https://www.crunchydata.com/) database to a +Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our +[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring Crunchy Postgres and are +interested in migrating an existing Postgres database - such as from Heroku - check out their +[docs](https://www.crunchydata.com/migrate-from-heroku) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-crunchy). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -37,13 +44,12 @@ On the Hasura Cloud dashboard, create a new project: After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: - -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -## Step 3: Create a Postgres DB on Crunchy ([skip if you have an existing DB](#get-db-url)) +## Step 3: Create a Postgres DB on Crunchy {#create-pg-db-crunchy} Log into [Crunchy](https://crunchybridge.com/dashboard). @@ -128,13 +134,13 @@ Voilà. You are ready to start developing. ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx#manage-project-collaborators), -[env vars](/projects/env-vars.mdx#manage-project-env-vars) or -[custom domains](/projects/domains.mdx#manage-project-domains)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx#manage-project-collaborators), + [env vars](/projects/env-vars.mdx#manage-project-env-vars) or + [custom domains](/projects/domains.mdx#manage-project-domains)). diff --git a/docs/docs/databases/connect-db/cloud-databases/digital-ocean.mdx b/docs/docs/databases/connect-db/cloud-databases/digital-ocean.mdx index b843cb40a4f..ce5cf6982d3 100644 --- a/docs/docs/databases/connect-db/cloud-databases/digital-ocean.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/digital-ocean.mdx @@ -14,16 +14,23 @@ sidebar_position: 10 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with a Digital Ocean Postgres Database - -
Available on: Cloud
+# Connecting Hasura to a Digital Ocean Postgres Database ## Introduction -This guide explains how to connect a new or existing Digital Ocean Postgres database to a Hasura Cloud project. If -you're exploring Digital Ocean Postgres and are interested in migrating an existing Postgres database - such as from -Heroku - check out their [docs](https://docs.digitalocean.com/products/databases/postgresql/how-to/migrate/) before -continuing below. +This guide explains how to connect a new or existing +[Digital Ocean Postgres](https://www.digitalocean.com/products/managed-databases-postgresql) database to a Hasura +instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our +[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring Digital Ocean Postgres and are +interested in migrating an existing Postgres database - such as from Heroku - check out their +[docs](https://docs.digitalocean.com/products/databases/postgresql/how-to/migrate/) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-do). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -36,15 +43,14 @@ On the Hasura Cloud dashboard, create a new project: -After the project is initialized successfully, click on `Launch console` to open the Hasura console in your browser. +After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: - -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -## Step 3: Create a Postgres DB on Digital Ocean (skip if you have an existing DB) +## Step 3: Create a Postgres DB on Digital Ocean {#create-pg-db-do} Log into [Digital Ocean](https://cloud.digitalocean.com/). @@ -61,7 +67,7 @@ associated with. Then click `Create a Database Cluster`. -## Step 4: Allow connections to your DB from Hasura Cloud +## Step 4: Allow connections to your DB from Hasura Navigate to the database cluster's `Overview` page: @@ -71,9 +77,17 @@ Scroll down to `Trusted sources` and click the `Edit` button: -Copy the IP address from the copy icon in the `Hasura Cloud IP` field on the project's details view on Hasura Cloud. +If you're using Hasura Cloud, you can quickly find your IP address from the `Hasura Cloud IP` field on the project's +details view: - + + +:::info Note + +If you're using a self-hosted solution, you'll need to determine the IP address manually depending on your hosting +service. + +::: Enter the Hasura IP address that you copied: @@ -112,7 +126,7 @@ Then click the `Copy` button for the next step. ## Step 6: Finish connecting the database -Back on Hasura Console, enter the database URL that we retrieved in [step 5](#get-db-url-do): +Back on the Hasura Console, enter the database URL that we retrieved in [step 5](#get-db-url-do): @@ -132,13 +146,13 @@ Voilà. You are ready to start developing. ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx#manage-project-collaborators), -[env vars](/projects/env-vars.mdx#manage-project-env-vars) or -[custom domains](/projects/domains.mdx#manage-project-domains)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx#manage-project-collaborators), + [env vars](/projects/env-vars.mdx#manage-project-env-vars) or + [custom domains](/projects/domains.mdx#manage-project-domains)). diff --git a/docs/docs/databases/connect-db/cloud-databases/elephant.mdx b/docs/docs/databases/connect-db/cloud-databases/elephant.mdx index 92a5774dee4..beb03ce05ce 100644 --- a/docs/docs/databases/connect-db/cloud-databases/elephant.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/elephant.mdx @@ -15,13 +15,20 @@ sidebar_position: 11 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with an ElephantSQL Postgres Database - -
Available on: Cloud
+# Connecting Hasura to an ElephantSQL Postgres Database ## Introduction -This guide explains how to connect a new or existing ElephantSQL Postgres database to a Hasura Cloud project. +This guide explains how to connect a new or existing [ElephantSQL Postgres](https://www.elephantsql.com/) database to a +Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our [self-hosted] +(/deployment/deployment-guides/index.mdx) solutions. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-elephant). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -32,52 +39,51 @@ and sign up or log in. On the Hasura Cloud dashboard, create a new project: - + After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. + - - -## Step 3: Create a Postgres DB on ElephantSQL ([skip if you have an existing DB](#get-db-url)) +## Step 3: Create a Postgres DB on ElephantSQL {#create-pg-db-elephant} Log into [ElephantSQL](https://customer.elephantsql.com/login). If this is your first time logging into ElephantSQL, you'll need to create a team. Complete the form and click `Create team`. - + From here, you'll need to create a new instance: Choose a name, plan, and - if necessary - tags for this instance. Click `Select Region` when complete: Choose a region and click `Review`: Confirm your selections and click `Create instance`: - + Congratulations! You've now created an ElephantSQL Postgres instance you can use with Hasura GraphQL Engine. Follow the steps below to connect it to Hasura. @@ -86,7 +92,7 @@ steps below to connect it to Hasura. From your dashboard, click on the name of your instance: - + The structure of the database connection URL looks as follows: @@ -97,19 +103,19 @@ postgres://:@ From the `Details` view, copy the URL string to your clipboard: ## Step 5: Finish connecting the database -Back on Hasura Console, enter the database URL that we retrieved in the previous step: +Back on the Hasura Console, enter the database URL that we retrieved in the previous step: Then click `Connect Database`. @@ -124,19 +130,19 @@ of the raw database URLs. Voilà. You are ready to start developing. - + ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx#manage-project-collaborators), -[env vars](/projects/env-vars.mdx#manage-project-env-vars) or -[custom domains](/projects/domains.mdx#manage-project-domains)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx#manage-project-collaborators), + [env vars](/projects/env-vars.mdx#manage-project-env-vars) or + [custom domains](/projects/domains.mdx#manage-project-domains)). - + :::info Note diff --git a/docs/docs/databases/connect-db/cloud-databases/enterprisedb.mdx b/docs/docs/databases/connect-db/cloud-databases/enterprisedb.mdx index ff91fb124fb..a88f37a33fb 100644 --- a/docs/docs/databases/connect-db/cloud-databases/enterprisedb.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/enterprisedb.mdx @@ -15,16 +15,23 @@ sidebar_position: 12 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with an EnterpriseDB (BigAnimal) Postgres Database - -
Available on: Cloud
+# Connecting Hasura to an EnterpriseDB (BigAnimal) Postgres Database ## Introduction -This guide explains how to connect a new or existing EnterpriseDB (BigAnimal) Postgres database to a Hasura Cloud -project. If you're exploring EnterpriseDB Postgres and are interested in migrating an existing Postgres database - such -as from Heroku - check out their [docs](https://www.enterprisedb.com/docs/biganimal/latest/migration/cold_migration/) -before continuing below. +This guide explains how to connect a new or existing +[EnterpriseDB](https://www.enterprisedb.com/products/biganimal-cloud-postgresql) (BigAnimal) Postgres database to a +Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or [self-hosted] +(/deployment/deployment-guides/index.mdx). If you're exploring EnterpriseDB Postgres and are interested in migrating +an existing Postgres database - such as from Heroku - check out their [docs](https://www.enterprisedb. +com/docs/biganimal/latest/migration/cold_migration/) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-enterprisedb). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -35,64 +42,63 @@ and sign up or log in. On the Hasura Cloud dashboard, create a new project: - + After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. + - - -## Step 3: Create a BigAnimal Postgres DB on EnterpriseDB ([skip if you have an existing DB](#get-db-url)) +## Step 3: Create a BigAnimal Postgres DB on EnterpriseDB {#create-pg-db-enterprisedb} Log into [EnterpriseDB](https://www.enterprisedb.com/dashboard) and head to your dashboard. From your dashboard, scroll down and click `Test drive for free` in the BigAnimal section: - + EnterpriseDB will create a free trial and redirect you to your BigAnimal portal. From this portal, click `Create New Cluster`: - + Select the type of cluster and provider you plan to use, then click `Next: Cluster Settings`: Enter a cluster name and password: Choose a database type, region, and instance type: Select your storage and networking requirements, then click `Create Cluster`: You'll be redirected to your BigAnimal portal and should see your cluster provisioning like this: - + Congratulations! You've now created a BigAnimal Postgres instance on EnterpriseDB which you can use with Hasura GraphQL Engine. Follow the steps below to connect it to Hasura. @@ -110,14 +116,14 @@ parameters from the `Connect` tab and pass them to Hasura. After BigAnimal has provisioned the cluster, click on the title: - + From the cluster's dashboard, choose the `Connect` tab: For each of the following under `Connection Info`, click `Copy` and paste their values into the appropriate fields on @@ -132,7 +138,7 @@ the Hasura Console: Back on the Hasura Console, paste your values into the mapped field: - + :::info Note @@ -153,19 +159,19 @@ of the raw database URLs. Voilà. You are ready to start developing. - + ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx#manage-project-collaborators), -[env vars](/projects/env-vars.mdx#manage-project-env-vars) or -[custom domains](/projects/domains.mdx#manage-project-domains)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx#manage-project-collaborators), + [env vars](/projects/env-vars.mdx#manage-project-env-vars) or + [custom domains](/projects/domains.mdx#manage-project-domains)). - + :::info Note diff --git a/docs/docs/databases/connect-db/cloud-databases/gcp.mdx b/docs/docs/databases/connect-db/cloud-databases/gcp.mdx index 9018df93c1a..168fb7e6093 100644 --- a/docs/docs/databases/connect-db/cloud-databases/gcp.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/gcp.mdx @@ -14,15 +14,22 @@ sidebar_position: 13 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with a GCP Postgres Database - -
Available on: Cloud
+# Connecting Hasura to a GCP Postgres Database ## Introduction -This guide explains how to connect a new or existing GCP Postgres database to a Hasura Cloud project. If you're -exploring GCP Postgres and are interested in migrating an existing Postgres database - such as from Heroku - check out -their [docs](https://cloud.google.com/database-migration/docs/postgres) before continuing below. +This guide explains how to connect a new or existing [GCP Postgres database](https://cloud.google.com/sql) to a Hasura +instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our +[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring GCP Postgres and are +interested in migrating an existing Postgres database - such as from Heroku - check out their +[docs](https://cloud.google.com/database-migration/docs/postgres) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-gcp). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -33,54 +40,67 @@ and sign up or log in. On the Hasura Cloud dashboard, create a new project: - + -After the project is initialized successfully, click on `Launch console` to open the Hasura console in your browser. +After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. + - +## Step 3: Create a Postgres DB on GCP {#create-pg-db-gcp} -## Step 3: Create a Postgres DB on GCP (skip if you have an existing DB) {#create-pg-db-gcp} +:::info Note + +If you have an existing Postgres database on GCP, you can skip this step and move on to +[step 4](#allow-connections). + +::: Log into the [GCP console](https://console.cloud.google.com/). On the left-side navigation, scroll down to `Storage` and click on `SQL`: - + On the top, click on `Create instance`: - + Select Postgres: - + Select an instance ID, as well as a default user password. If required, choose a specific region and zone. - + Then click `Create`. -## Step 4: Allow connections to your DB from Hasura Cloud +## Step 4: Allow connections to your DB from Hasura {#allow-connections} On the dashboard of your GCP database instance, on the left sidebar, click on `Connections`. Then scroll down to the checkbox `Public IP`, and click `+ Add network`: - + You can choose an optional name (e.g. "Hasura"). -Copy the IP address from the copy icon in the `Hasura Cloud IP` field on the project's details view on Hasura Cloud. +If using Hasura Cloud, from your project's dashboard, copy the Hasura Cloud IP address: - + + +:::info Note + +If you're using a self-hosted solution, you'll need to determine the IP address manually depending on your hosting +service. + +::: Enter the Hasura IP address that you copied: - + Then click `Save`. @@ -106,16 +126,16 @@ postgresql://:@:/ - `public-ip`: The public IP can be optained by clicking on `Overview` on the left-side navigation and then scrolling down to `Connect to this instance`: - + - `postgres-port`: The default port for Postgres is `5432` if not specified otherwise. - `db`: The DB is `postgres` by default unless otherwise specified. ## Step 6: Finish connecting the database -Back on Hasura Console, enter the database URL that we retrieved in [step 5](#construct-db-url-gcp): +Back on the Hasura Console, enter the database URL that we retrieved in [step 5](#construct-db-url-gcp): - + Then click `Connect Database`. @@ -128,7 +148,7 @@ vars to connect to the databases in place of the raw database URLs. Voilà. You are ready to start developing. - + ## Step 7 (optional): Enable SSL connection @@ -150,9 +170,9 @@ Download these certs to your local drive. ### Step 7.2: Add env vars -Log in to [Hasura Cloud](https://cloud.hasura.io/), go to your project and add the following env vars: +If using Hasura Cloud, go to your project and add the following env vars: -(Open the cert files using your favourite text editor, select all the contents and copy them to the clipboard) +(Open the cert files using your favorite text editor, select all the contents and copy them to the clipboard) | Env Var Name | Value | | ------------------ | ------------------------------- | @@ -162,11 +182,17 @@ Log in to [Hasura Cloud](https://cloud.hasura.io/), go to your project and add t Here is how your Hasura Cloud env vars setup should look like: - + + +:::info Note + +If you're using a self-hosted solution, you can set these env vars in your `docker-compose.yml` file. + +::: ### Step 7.3: Configure SSL settings -Open the console of your Hasura Cloud project, go to the `Data -> Manage -> [db-name] -> Edit` page. +Open the Console of your Hasura project, go to the `Data -> Manage -> [db-name] -> Edit` page. Under `Connection Settings` add the following SSL certificate settings: @@ -179,22 +205,22 @@ Under `Connection Settings` add the following SSL certificate settings: Here is how the setup should look like: - + Finally, click on the `Update Connection` button to apply the SSL settings. - + ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or -[custom domains](/projects/domains.mdx)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or + [custom domains](/projects/domains.mdx)). - + :::info Note diff --git a/docs/docs/databases/connect-db/cloud-databases/heroku.mdx b/docs/docs/databases/connect-db/cloud-databases/heroku.mdx index a90ef44e63a..1f08c49d8aa 100644 --- a/docs/docs/databases/connect-db/cloud-databases/heroku.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/heroku.mdx @@ -14,13 +14,12 @@ sidebar_position: 14 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with a Heroku Postgres Database - -
Available on: Cloud
+# Connecting Hasura to a Heroku Postgres Database ## Introduction -This guide explains how to connect a new or existing Postgres database hosted on Heroku to a Hasura Cloud project. +This guide explains how to connect a new or existing Postgres database hosted on Heroku to a Hasura instance, either on +[Hasura Cloud](https://cloud.hasura.io) or [self-hosted](/deployment/deployment-guides/index.mdx). :::warning diff --git a/docs/docs/databases/connect-db/cloud-databases/index.mdx b/docs/docs/databases/connect-db/cloud-databases/index.mdx index 752cdad8500..e950f705048 100644 --- a/docs/docs/databases/connect-db/cloud-databases/index.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/index.mdx @@ -3,7 +3,7 @@ description: Use an existing database with Hasura Cloud title: 'Cloud: Guides for connecting Hasura Cloud with different cloud databases' keywords: - hasura - - cloud + - cloud databases - docs - existing database slug: index @@ -32,160 +32,158 @@ import Supabase from '@site/static/img/cloud-dbs/logos/supabase.png'; import Timescale from '@site/static/img/cloud-dbs/logos/timescaledb.png'; import Yugabyte from '@site/static/img/cloud-dbs/logos/yugabyte.png'; -# Guides for connecting Hasura Cloud with different cloud databases - -
Available on: Cloud
+# Guides for connecting Hasura with different cloud databases ## Overview -Check out the following guides for tutorials on how to use Hasura Cloud with a new or existing database provided by +Check out the following guides for tutorials on how to use Hasura with a new or existing database provided by specific cloud vendors. -
- -
-
- Connect Postgres DB to Hasura +
+ +
+
+ Connect Postgres DB to Hasura
Aiven
 - -
-
- Connect Google AlloyDB to Hasura + +
+
+ Connect Google AlloyDB to Hasura
AlloyDB
 - -
-
- Connect AWS Aurora Postgres to Hasura + +
+
+ Connect AWS Aurora Postgres to Hasura
AWS RDS Aurora Postgres
 - -
-
- Connect AWS RDS Postgres to Hasura + +
+
+ Connect AWS RDS Postgres to Hasura
AWS RDS Postgres
 - -
-
- Connect Azure Cosmos to Hasura + +
+
+ Connect Azure Cosmos to Hasura
Azure Cosmos
 - -
-
- Connect MS SQL on Azure to Hasura + +
+
+ Connect MS SQL on Azure to Hasura
Azure MS SQL
 - -
-
- Connect Azure Postgres to Hasura + +
+
+ Connect Azure Postgres to Hasura
Azure Postgres
 - -
-
- Connect Crunchy Postgres to Hasura + +
+
+ Connect Crunchy Postgres to Hasura
Crunchy Postgres
 - -
-
- Connect DO Postgres to Hasura + +
+
+ Connect DO Postgres to Hasura
Digital Ocean Postgres
 - -
-
- Connect ElephantSQL Postgres to Hasura + +
+
+ Connect ElephantSQL Postgres to Hasura
ElephantSQL
 - -
-
+ +
+
Connect EnterpriseDB BigAnimal Postgres to Hasura
EnterpriseDB
 - -
-
- Connect GCP Postgres to Hasura + +
+
+ Connect GCP Postgres to Hasura
GCP Postgres
 - -
-
- Connect Neon Postgres to Hasura + +
+
+ Connect Neon Postgres to Hasura
Neon Postgres
 - -
-
- Connect Railway Postgres to Hasura + +
+
+ Connect Railway Postgres to Hasura
Railway Postgres
 - -
-
- Connect Render Postgres to Hasura + +
+
+ Connect Render Postgres to Hasura
Render Postgres
 - -
-
- Connect Supabase Postgres to Hasura + +
+
+ Connect Supabase Postgres to Hasura
Supabase Postgres
 - -
-
- Connect TimescaleDB Postgres to Hasura + +
+
+ Connect TimescaleDB Postgres to Hasura
TimescaleDB
 - -
-
- Connect YugabyteDB Postgres to Hasura + +
+
+ Connect YugabyteDB Postgres to Hasura
YugabyteDB
diff --git a/docs/docs/databases/connect-db/cloud-databases/mssql.mdx b/docs/docs/databases/connect-db/cloud-databases/mssql.mdx index 23dc77bdd1a..d13bfa7f91d 100644 --- a/docs/docs/databases/connect-db/cloud-databases/mssql.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/mssql.mdx @@ -17,15 +17,22 @@ sidebar_position: 7 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura with an MS SQL on Azure Database - -
Available on: Cloud
+# Connecting Hasura to an MS SQL on Azure Database ## Introduction -This guide explains how to connect a new or existing MS SQL database on Azure to a Hasura Cloud project. If you're -exploring MS SQL on Azure, and are interested in migrating an existing MS SQL database, check out their -[docs](https://learn.microsoft.com/en-us/azure/dms/tutorial-sql-server-to-azure-sql) before continuing below. +This guide explains how to connect a new or existing +[MS SQL database on Azure](https://azure.microsoft.com/en-us/products/azure-sql/database/) to a Hasura instance, either +on [Hasura Cloud](https://cloud.hasura.io) or via one of our [self-hosted](/deployment/deployment-guides/index.mdx) +solutions. If you're exploring MS SQL on Azure, and are interested in migrating an existing MS SQL database, check out +their [docs](https://learn.microsoft.com/en-us/azure/dms/tutorial-sql-server-to-azure-sql) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-mssql). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -36,7 +43,7 @@ and sign up or log in. On the Hasura Cloud dashboard, create a new project: - + After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. @@ -44,31 +51,31 @@ On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Connec You will get prompted for a MS SQL Database URL. We will create this in the next step and then come back here. - + -## Step 3: Create an MS SQL Instance on Azure (skip if you have an existing DB) {#create-mssql-server-instance} +## Step 3: Create an MS SQL Instance on Azure {#create-pg-db-mssql} Log into the [Azure Console](https://portal.azure.com/#home). On the top, click on `Search` and type "SQL Server" into the search field. Then click on `SQL Servers`: Click on the `Create` button: - + Select the current `Subscription` (Billing Account) and the resource group. Fill in all the necessary fields. In the Authentication part, select `Use SQL Authentication` and fill the username and password for the SQL user. Change additional settings or add tags to the instance if required. Once you reach to `Review + Create` tab, review all @@ -76,27 +83,34 @@ the fields. You can go back and change any field if required. Then, click on `Cr instance. -## Step 4: Allow connections to your DB from Hasura Cloud +## Step 4: Allow connections to your DB from Hasura Once Azure provisions the server, navigate to the server instance page and click on `Show networking settings`. - + -Back on Hasura Cloud, copy the IP address in the `Hasura Cloud IP` field on the project's details view. +If using Hasura Cloud, from your project's dashboard, copy the Hasura Cloud IP address: - + + +:::info Note + +If you're using a self-hosted solution, you'll need to determine the IP address manually depending on your hosting +service. + +::: On Azure, under `Firewell rules` in networking settings, click on `Add a firewall rule`. Name the firewall rule and -paste the Hasura cloud IP on both the `Start IP` and `End IP` input boxes: +paste the Hasura instance's IP address on both the `Start IP` and `End IP` input boxes: - + -After entering the IP of your Hasura Cloud project, click on `OK` and then click on `Save` at end of the page for the +After entering the IP of your Hasura instance, click on `OK` and then click on `Save` at end of the page for the changes to take effect. ## Step 5: Create database {#create-db-on-mssql-instance} @@ -104,14 +118,14 @@ changes to take effect. Go to the SQL Server instance's home and click on `Create Database` Fill in all the required fields and additional settings if required. Click on `Review + create` and create the database. - + ## Step 6: Construct the database connection URL {#construct-db-url-mssql} @@ -126,7 +140,7 @@ as a template. Using the information below, you can modify the attributes to mee Copy the server name from instance home. - + - `Driver`: Driver to use for connection to the SQL Server. If you are not sure, use `ODBC Driver 17 for SQL Server`. - `Server`: The server name copied from the instance page. @@ -136,9 +150,10 @@ Copy the server name from instance home. ## Step 6: Finish connecting the database -Back on Hasura Console, enter and modify the connection string that we referenced in [step 6](#construct-db-url-mssql): +Back on the Hasura Console, enter and modify the connection string that we referenced in +[step 6](#construct-db-url-mssql): - + Then click `Connect Database`. @@ -151,18 +166,18 @@ vars to connect to the databases in place of the raw database URLs. Voilà. You are ready to start developing. - + ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or -[custom domains](/projects/domains.mdx)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or + [custom domains](/projects/domains.mdx)). - + :::info Note diff --git a/docs/docs/databases/connect-db/cloud-databases/neon.mdx b/docs/docs/databases/connect-db/cloud-databases/neon.mdx index 5a043f66ea2..957729d0e4a 100644 --- a/docs/docs/databases/connect-db/cloud-databases/neon.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/neon.mdx @@ -15,12 +15,11 @@ sidebar_position: 15 import Thumbnail from '@site/src/components/Thumbnail'; -# Using Hasura Cloud with a Neon Serverless Postgres Database +# Connecting Hasura to a Neon Serverless Postgres Database ## Introduction -This guide explains how to connect a new [Neon](https://neon.tech/) serverless Postgres database to a Hasura Cloud -project. +This guide explains how to connect a new [Neon](https://neon.tech/) serverless Postgres database to a [Hasura Cloud](https://cloud.hasura.io) instance. ## Creating a New Neon Database @@ -33,7 +32,7 @@ and sign up or log in. On the Hasura Cloud dashboard, create a new project: - + After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. @@ -41,12 +40,12 @@ On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Create Click on `Connect Neon Database` to create and connect a new Postgres database to your Hasura project. - + On the next step, you'll be prompted to Login/Sign up for Neon. We recommend `Continue with Hasura` for a seamless experience. - + After successful authorization, a new Neon Postgres database will be created and connected to your Hasura project with the connection string associated with the environment variable `PG_DATABASE_URL`. @@ -58,19 +57,19 @@ the template gallery instantly. For example: to get started, you could try the `Welcome to Hasura` template: - + This installs a schema with data that you can now query using your Hasura GraphQL API from the `API` tab. Voilà! You are ready to start developing. - + :::info Note You can visit the Neon console from the `Data` tab to manage your created database. - + ::: @@ -110,7 +109,7 @@ If you've already reached the free-tier limit of three databases, please head to [Neon console](https://console.neon.tech/) and delete an unused database to be able to create and connect a new one from the Hasura Console. - + ::: diff --git a/docs/docs/databases/connect-db/cloud-databases/railway.mdx b/docs/docs/databases/connect-db/cloud-databases/railway.mdx index f27b5a85a3d..2891882cacd 100644 --- a/docs/docs/databases/connect-db/cloud-databases/railway.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/railway.mdx @@ -14,15 +14,22 @@ sidebar_position: 16 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with a Railway Postgres Database - -
Available on: Cloud
+# Connecting Hasura to a Railway Postgres Database ## Introduction -This guide explains how to connect a new or existing Railway Postgres database to a Hasura Cloud project. If you're -exploring Railway Postgres and are interested in migrating an existing Postgres database - such as from Heroku - check -out their [docs](https://railway.app/heroku) before continuing below. +This guide explains how to connect a new or existing +[Railway Postgres database](https://docs.railway.app/databases/postgresql) to a Hasura instance, either on +[Hasura Cloud](https://cloud.hasura.io) or via one of our [self-hosted](/deployment/deployment-guides/index.mdx) +solutions. If you're exploring Railway Postgres and are interested in migrating an existing Postgres database - such as +from Heroku - check out their [docs](https://railway.app/heroku) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-railway). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -33,27 +40,26 @@ and sign up or log in. On the Hasura Cloud dashboard, create a new project: - + After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. + - - -## Step 3: Create a Postgres DB on Railway ([skip if you have an existing DB](#get-db-url)) +## Step 3: Create a Postgres DB on Railway {#create-pg-db-railway} Log into [Railway](https://railway.app/dashboard). From your dashboard, click `New Project`: - + Select `Provision PostgreSQL`: - + Railway will redirect you to the project's dashboard. After a few seconds, you should see the `Activity` card update with information about your new instance. Congratulations! You've now created a Postgres instance on Railway which you @@ -70,17 +76,17 @@ postgresql://:@:/ Click on the `PostgreSQL` card to see details related to this instance. Choose the `Connect` tab and copy the `Postgres Connection URL`: ## Step 5: Finish connecting the database @@ -88,9 +94,9 @@ Choose the `Connect` tab and copy the `Postgres Connection URL`: Back on the Hasura Console, enter the database URL that we retrieved in the previous step: Then click `Connect Database`. @@ -105,19 +111,19 @@ of the raw database URLs. Voilà. You are ready to start developing. - + ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx#manage-project-collaborators), -[env vars](/projects/env-vars.mdx#manage-project-env-vars) or -[custom domains](/projects/domains.mdx#manage-project-domains)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx#manage-project-collaborators), + [env vars](/projects/env-vars.mdx#manage-project-env-vars) or + [custom domains](/projects/domains.mdx#manage-project-domains)). - + :::info Note diff --git a/docs/docs/databases/connect-db/cloud-databases/render.mdx b/docs/docs/databases/connect-db/cloud-databases/render.mdx index 5a67071e2e7..ad296056c59 100644 --- a/docs/docs/databases/connect-db/cloud-databases/render.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/render.mdx @@ -14,15 +14,22 @@ sidebar_position: 17 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with a Render Postgres Database - -
Available on: Cloud
+# Connecting Hasura to a Render Postgres Database ## Introduction -This guide explains how to connect a new or existing Render Postgres database to a Hasura Cloud project. If you're -exploring Render Postgres and are interested in migrating an existing Postgres database - such as from Heroku - check -out their [docs](https://render.com/docs/migrate-from-heroku) before continuing below. +This guide explains how to connect a new or existing [Render Postgres database](https://render.com/docs/databases) to a +Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our +[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring Render Postgres and are +interested in migrating an existing Postgres database - such as from Heroku - check out their +[docs](https://render.com/docs/migrate-from-heroku) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-render). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -33,27 +40,26 @@ and sign up or log in. On the Hasura Cloud dashboard, create a new project: - + After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. + - - -## Step 3: Create a Postgres DB on Render ([skip if you have an existing DB](#get-db-url)) +## Step 3: Create a Postgres DB on Render {#create-pg-db-render} Log into [Render](https://dashboard.render.com/). From your dashboard, click `New PostrgeSQL`: - + Choose a name for your new database and fill in the required info. When ready, click `Create Database`: - + Render will redirect you to the database's dashboard. After a few minutes, you should see the status update to `Available`. Congratulations! You've now created a Postgres instance on Render which you can use with Hasura GraphQL @@ -70,9 +76,9 @@ postgres://:@/ From your database's dashboard, find the `Connections` card and copy the `External Database URL`: ## Step 5: Finish connecting the database @@ -80,9 +86,9 @@ From your database's dashboard, find the `Connections` card and copy the `Extern Back on the Hasura Console, enter the database URL that we retrieved in the previous step: Then click `Connect Database`. @@ -97,19 +103,19 @@ of the raw database URLs. Voilà. You are ready to start developing. - + ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx#manage-project-collaborators), -[env vars](/projects/env-vars.mdx#manage-project-env-vars) or -[custom domains](/projects/domains.mdx#manage-project-domains)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx#manage-project-collaborators), + [env vars](/projects/env-vars.mdx#manage-project-env-vars) or + [custom domains](/projects/domains.mdx#manage-project-domains)). - + :::info Note diff --git a/docs/docs/databases/connect-db/cloud-databases/supabase.mdx b/docs/docs/databases/connect-db/cloud-databases/supabase.mdx index 0f4977153c5..e6f4b873d3d 100644 --- a/docs/docs/databases/connect-db/cloud-databases/supabase.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/supabase.mdx @@ -14,15 +14,22 @@ sidebar_position: 18 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with a Supabase Postgres Database - -
Available on: Cloud
+# Connecting Hasura to a Supabase Postgres Database ## Introduction -This guide explains how to connect a new or existing Supabase Postgres database to a Hasura Cloud project. If you're -exploring Supabase Postgres and are interested in migrating an existing Postgres database - such as from Heroku - check -out their [docs](https://supabase.com/docs/guides/migrations/heroku) before continuing below. +This guide explains how to connect a new or existing [Supabase Postgres database](https://supabase.com/database) to a +Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our +[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring Supabase Postgres and are +interested in migrating an existing Postgres database - such as from Heroku - check out their +[docs](https://supabase.com/docs/guides/migrations/heroku) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-supabase). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -33,68 +40,67 @@ and sign up or log in. On the Hasura Cloud dashboard, create a new project: - + After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: +On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a +Postgres Database URL. We'll create this in the next step and then come back here. -You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. + - - -## Step 3: Create a Postgres DB on Supabase ([skip if you have an existing DB](#get-db-url)) +## Step 3: Create a Postgres DB on Supabase {#create-pg-db-supabase} Log into [Supabase](https://app.supabase.com/) using your GitHub login. From your dashboard, click `New project`: If you don't already have an organization within Supabase, you'll need to create a one. Click `New organization`: Fill in a name and click `Create organization`: After creating your organization, you'll be presented with the `Create a new project` view. Fill in the necessary information and click `Create new project`: You'll be redirected to your project's dashboard. After a few minutes, your database should be provisioned. You'll know you're ready once your dashboard changes from this: To this: Congratulations! You've now created a Postgres instance on Supabase which you can use with Hasura GraphQL Engine. Follow @@ -111,22 +117,22 @@ postgresql://:@:/ From your database's dashboard, click the `Settings` icon on the side navigation: Choose `Database`: Then scroll down to find the `Connection string` section. Select the `URI` option and copy the string: - + :::info Note @@ -139,9 +145,9 @@ You'll need to replace `[YOUR-PASSWORD]` with your project's password. Back on the Hasura Console, enter the database URI that we retrieved in the previous step: Then click `Connect Database`. @@ -156,19 +162,19 @@ of the raw database URLs. Voilà. You are ready to start developing. - + ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx#manage-project-collaborators), -[env vars](/projects/env-vars.mdx#manage-project-env-vars) or -[custom domains](/projects/domains.mdx#manage-project-domains)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx#manage-project-collaborators), + [env vars](/projects/env-vars.mdx#manage-project-env-vars) or + [custom domains](/projects/domains.mdx#manage-project-domains)). - + :::info Note diff --git a/docs/docs/databases/connect-db/cloud-databases/timescale-cloud.mdx b/docs/docs/databases/connect-db/cloud-databases/timescale-cloud.mdx index 09c54093e5e..10c351a6572 100644 --- a/docs/docs/databases/connect-db/cloud-databases/timescale-cloud.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/timescale-cloud.mdx @@ -14,15 +14,22 @@ sidebar_position: 19 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with a Timescale Postgres Database - -
Available on: Cloud
+# Connecting Hasura to a Timescale Postgres Database ## Introduction -This guide explains how to connect a new or existing Timescale Postgres database to a Hasura Cloud project. If you're -exploring Timescale Postgres and are interested in migrating an existing Postgres database - such as from Heroku - check -out their [docs](https://docs.timescale.com/timescaledb/latest/how-to-guides/migrate-data/) before continuing below. +This guide explains how to connect a new or existing [Timescale Postgres](https://www.timescale.com/) database to a +Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our [self-hosted] +(/deployment/deployment-guides/index.mdx) solutions. If you're exploring Timescale Postgres and are interested in +migrating an existing Postgres database - such as from Heroku - check out their +[docs](https://docs.timescale.com/timescaledb/latest/how-to-guides/migrate-data/) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and +already have a project running, skip to [step 3](#create-pg-db-timescale). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -33,37 +40,37 @@ and sign up or log in. On the Hasura Cloud dashboard, create a new project: - + You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. -After the project is initialized successfully, click on `Launch console` to open the Hasura console in your browser. +After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: +On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: - + -## Step 3: Create a Postgres DB on Timescale (skip if you have an existing DB) {#create-pg-db-timescale} +## Step 3: Create a Postgres DB on Timescale Cloud {#create-pg-db-timescale} Log into the [Timescale Cloud portal](https://portal.timescale.cloud/login). On the Timescale dashboard, under `Services`, click on `+ Create new service`: Select the Postgres option: - + Scroll down and select the `Cloud Provider`, `Region` and `Service Plan` based on your requirements. In the end, enter a `Name` for the service: - + Then click `Create service`. @@ -74,27 +81,34 @@ If you're using a database user other than the default one, make sure to give it ::: -## Step 4: Allow connections to your DB from Hasura Cloud +## Step 4: Allow connections to your DB from Hasura On the `Services` dashboard, click on your DB: - + Scroll down to `Allowed IP Addresses` and click on `Change`: -Copy the IP address from the copy icon in the `Hasura Cloud IP` field on the project's details view on Hasura Cloud. +If using Hasura Cloud, from your project's dashboard, copy the Hasura Cloud IP address: - + + +:::info Note + +If you're using a self-hosted solution, you'll need to determine the IP address manually depending on your hosting +service. + +::: Add the Hasura IP address that you copied, click on the `+` and then click on `Save changes`: - + ## Step 5: Get the database connection URL {#get-db-url-timescale} @@ -106,13 +120,13 @@ postgresql://:@:/?sslmode=req To get it, navigate to the `Overview` tab of your database dashboard and copy the `Service URI`: - + ## Step 6: Finish connecting the database -Back on Hasura Console, enter the database URL that we retrieved in [step 5](#get-db-url-timescale): +Back on the Hasura Console, enter the database URL that we retrieved in [step 5](#get-db-url-timescale): - + Then click `Connect Database`. @@ -125,18 +139,18 @@ vars to connect to the databases in place of the raw database URLs. Voilà. You are ready to start developing. - + ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or -[custom domains](/projects/domains.mdx)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or + [custom domains](/projects/domains.mdx)). - + :::info Note diff --git a/docs/docs/databases/connect-db/cloud-databases/yugabyte.mdx b/docs/docs/databases/connect-db/cloud-databases/yugabyte.mdx index fe214c8d3e0..78c99615f00 100644 --- a/docs/docs/databases/connect-db/cloud-databases/yugabyte.mdx +++ b/docs/docs/databases/connect-db/cloud-databases/yugabyte.mdx @@ -14,15 +14,22 @@ sidebar_position: 20 import Thumbnail from '@site/src/components/Thumbnail'; import HeadingIcon from '@site/src/components/HeadingIcon'; -# Using Hasura Cloud with a Yugabyte Postgres Database - -
Available on: Cloud
+# Connecting Hasura to a Yugabyte Postgres Database ## Introduction -This guide explains how to connect a new or existing Yugabyte Postgres database to a Hasura Cloud project. If you're -exploring Yugabyte Postgres and are interested in migrating an existing Postgres database - such as from Heroku - check -out their [docs](https://docs.yugabyte.com/preview/migrate/migrate-steps/) before continuing below. +This guide explains how to connect a new or existing [Yugabyte Postgres database](https://www.yugabyte.com/) to a Hasura +instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our +[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring Yugabyte Postgres and are +interested in migrating an existing Postgres database - such as from Heroku - check out their +[docs](https://docs.yugabyte.com/preview/migrate/migrate-steps/) before continuing below. + +:::info Note + +If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura +instance and already have a project running, skip to [step 3](#create-pg-db-yugabyte). + +::: ## Step 1: Sign up or log in to Hasura Cloud @@ -33,31 +40,31 @@ and sign up or log in. On the Hasura Cloud dashboard, create a new project: - + You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here. -After the project is initialized successfully, click on `Launch console` to open the Hasura console in your browser. +After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser. -On the Hasura console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: +On the Hasura Console, navigate to `Data -> Manage -> Connect Database -> Connect existing database`: - + -## Step 3: Create a Postgres DB on Yugabyte (skip if you have an existing DB) {#create-pg-db-yugabyte} +## Step 3: Create a Postgres DB on Yugabyte {#create-pg-db-yugabyte} Log into the [Yugabyte Cloud dashboard](https://cloud.yugabyte.com/login). On the Yugabyte Cloud dashboard, click on `Create a free cluster`: - + Select the `Managed Free` option and then click `Next`. - + Select a `Cloud Provider` and `Region` and then click `Next`. - + :::info Note @@ -69,35 +76,41 @@ If you're using a database user other than the default one, make sure to give it Download your credentials and then click `Create Cluster`. -## Step 4: Allow connections to your DB from Hasura Cloud +## Step 4: Allow connections to your DB from Hasura From the cluster's dashboard, click `Add IP Allow List`: - + Within the modal, click `Create New List and Add to Cluster`: -Copy the IP address from the copy icon in the `Hasura Cloud IP` field on the project's details view on Hasura Cloud. +If using Hasura Cloud, from your project's dashboard, copy the Hasura Cloud IP address: - + +:::info Note + +If you're using a self-hosted solution, you'll need to determine the IP address manually depending on your hosting +service. + +::: Enter the Hasura IP address that you copied: Then click `Save`. @@ -113,17 +126,17 @@ postgresql://:@:/?ssl=true&ss To get it, from the cluster's dashboard, click `Run your own application`: Click the `Optimize for Hasura Cloud` checkbox and then copy your connection string: ## Step 6: Finish connecting the database @@ -131,7 +144,7 @@ Click the `Optimize for Hasura Cloud` checkbox and then copy your connection str Back on the Hasura Console, enter the database URL that we just copied and replace the `` and `` with the information from your credentials downloaded in [step 3](#create-pg-db-yugabyte): - + Then click `Connect Database`. @@ -144,20 +157,20 @@ vars to connect to the databases in place of the raw database URLs. Voilà. You are ready to start developing. - + ## Next steps -You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other -[GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. If you're completely -new to Yugabyte and want to learn more, check out -[this tutorial](https://hasura.io/learn/database/yugabyte/introduction/) from our Learn site. +- You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other + [GraphQL & Hasura Courses](https://hasura.io/learn/) for a more detailed introduction to Hasura. If you're completely + new to Yugabyte and want to learn more, check out + [this tutorial](https://hasura.io/learn/database/yugabyte/introduction/) from our Learn site. -You can also click the gear icon to manage your Hasura Cloud project. (e.g. add -[collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or -[custom domains](/projects/domains.mdx)). +- If using Hasura Cloud, you can also click the gear icon to manage your Hasura Cloud project. (e.g. add + [collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or + [custom domains](/projects/domains.mdx)). - + :::info Note