hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 17:02:49 +03:00
Code Issues Projects Releases Wiki Activity

docs: make cloud db guides agnostic

Browse Source 
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
This commit is contained in:
Rob Dominguez 2022-12-05 18:11:06 -06:00 committed by hasura-bot
parent 599d9fd602
commit adf565fe3d
21 changed files with 792 additions and 587 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/docs/databases/connect-db/cloud-databases/_category_.json
View File

@ -1,5 +1,4 @@
{
"label": "Cloud databases guides",
"position": 1,
"className": "cloud-icon"
"label": "Cloud database guides",
"position": 1
}

50
docs/docs/databases/connect-db/cloud-databases/aiven.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' width='1000px' />
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.
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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:
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' width='1000px' />
:::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 `+`:
<Thumbnail src='/img/cloud-dbs/aiven/add-hasura-ip.png' alt='Add the Hasura IP on Aiven' width='1000px' />
@ -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):
<Thumbnail src='/img/cloud-dbs/aiven/Aiven-complete.png' alt='Database setup' width='600px' />
@ -127,10 +147,10 @@ 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
- 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
- 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)).

45
docs/docs/databases/connect-db/cloud-databases/alloy.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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.
<Thumbnail src='/img/cloud-dbs/alloy/alloy-existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
@ -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:
<Thumbnail src='/img/cloud-dbs/alloy/alloy-hasura-ip.png' alt='AlloyDB get IP of Hasura Cloud project' width='1000px' />
:::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`:
<Thumbnail src='/img/cloud-dbs/alloy/alloy-create-firewall.png' alt='AlloyDB create firewall rule' width='1000px' />
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`:
<Thumbnail src='/img/cloud-dbs/alloy/alloy-firewall-settings.png' alt='AlloyDB firewall rule settings' width='1000px' />
@ -182,7 +195,7 @@ postgresql://<database-user>:<postgres-password>@<ip-address-of-gce-instance>: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:
<Thumbnail src='/img/cloud-dbs/alloy/alloy-connect-db.png' alt='AlloyDB connect db' width='1000px' />
@ -201,10 +214,10 @@ 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
- 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
- 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)).

50
docs/docs/databases/connect-db/cloud-databases/aws-aurora.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' width='1000px' />
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.
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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:
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' width='1000px' />
:::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:
<Thumbnail src='/img/cloud-dbs/aws/add-hasura-ip.png' alt='Add the Hasura IP for AWS RDS database' width='1000px' />
@ -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):
<Thumbnail src='/img/getting-started/connect-db-cloud.png' alt='Database setup' width='600px' />
@ -174,10 +192,10 @@ 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
- 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
- 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)).

54
docs/docs/databases/connect-db/cloud-databases/aws-postgres.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' width='1000px' />
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.
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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:
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' width='1000px' />
:::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:
<Thumbnail src='/img/cloud-dbs/aws/add-hasura-ip.png' alt='Add the Hasura IP for AWS RDS database' width='1000px' />
@ -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):
<Thumbnail src='/img/getting-started/connect-db-cloud.png' alt='Database setup' width='600px' />
@ -171,10 +191,10 @@ 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
- 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
- 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)).

30
docs/docs/databases/connect-db/cloud-databases/azure-cosmos.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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.
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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,10 +104,10 @@ 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
- 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
- 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)).

51
docs/docs/databases/connect-db/cloud-databases/azure.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' width='1000px' />
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.
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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:
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' />
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' width='1000px' />
:::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):
<Thumbnail src='/img/cloud-dbs/azure/azure-complete.png' alt='Database setup' width='600px' />
@ -142,10 +157,10 @@ 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
- 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
- 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)).

30
docs/docs/databases/connect-db/cloud-databases/crunchy.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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.
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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,10 +134,10 @@ 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
- 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
- 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)).

50
docs/docs/databases/connect-db/cloud-databases/digital-ocean.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud 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.
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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:
<Thumbnail src='/img/cloud-dbs/do/edit-trusted-sources.png' alt='Edit trusted sources for database in Digital Ocean' />
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:
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' />
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' width='1000px' />
:::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):
<Thumbnail src='/img/cloud-dbs/do/DO-complete.png' alt='Database setup' width='600px' />
@ -132,10 +146,10 @@ 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
- 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
- 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)).

72
docs/docs/databases/connect-db/cloud-databases/elephant.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' />
<Thumbnail src="/img/cloud-dbs/create-hasura-cloud-project.png" alt="Create Hasura Cloud 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.
<Thumbnail src="/img/cloud-dbs/existing-db-setup.png" alt="Hasura Cloud database setup" width="700px" />
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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`.
<Thumbnail src='/img/cloud-dbs/elephant/elephant-create-team.png' alt='Create Elephant team' width='700px' />
<Thumbnail src="/img/cloud-dbs/elephant/elephant-create-team.png" alt="Create Elephant team" width="700px" />
From here, you'll need to create a new instance:
<Thumbnail
src='/img/cloud-dbs/elephant/elephant-create-instance.png'
alt='Create new Elephant instance'
width='700px'
src="/img/cloud-dbs/elephant/elephant-create-instance.png"
alt="Create new Elephant instance"
width="700px"
/>
Choose a name, plan, and - if necessary - tags for this instance. Click `Select Region` when complete:
<Thumbnail
src='/img/cloud-dbs/elephant/elephant-instance-details.png'
alt='Add details to Elephant instance'
width='700px'
src="/img/cloud-dbs/elephant/elephant-instance-details.png"
alt="Add details to Elephant instance"
width="700px"
/>
Choose a region and click `Review`:
<Thumbnail
src='/img/cloud-dbs/elephant/elephant-select-region.png'
alt='Choose region for Elephant instance'
width='700px'
src="/img/cloud-dbs/elephant/elephant-select-region.png"
alt="Choose region for Elephant instance"
width="700px"
/>
Confirm your selections and click `Create instance`:
<Thumbnail src='/img/cloud-dbs/elephant/elephant-confirm-instance.png' alt='Create Elephant instance' width='700px' />
<Thumbnail src="/img/cloud-dbs/elephant/elephant-confirm-instance.png" alt="Create Elephant instance" width="700px" />
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:
<Thumbnail src='/img/cloud-dbs/elephant/elephant-choose-instance.png' alt='Choose Elephant instance' width='700px' />
<Thumbnail src="/img/cloud-dbs/elephant/elephant-choose-instance.png" alt="Choose Elephant instance" width="700px" />
The structure of the database connection URL looks as follows:
@ -97,19 +103,19 @@ postgres://<user-name>:<password>@<host-server>
From the `Details` view, copy the URL string to your clipboard:
<Thumbnail
src='/img/cloud-dbs/elephant/elephant-connection-string.png'
alt='Get the connection string for the database'
width='700px'
src="/img/cloud-dbs/elephant/elephant-connection-string.png"
alt="Get the connection string for the database"
width="700px"
/>
## 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:
<Thumbnail
src='/img/cloud-dbs/elephant/elephant-connect-db.png'
alt='Add the connection string to your Hasura Console'
width='700px'
src="/img/cloud-dbs/elephant/elephant-connect-db.png"
alt="Add the connection string to your Hasura Console"
width="700px"
/>
Then click `Connect Database`.
@ -124,19 +130,19 @@ of the raw database URLs.
Voilà. You are ready to start developing.
<Thumbnail src='/img/cloud-dbs/hasura-console.png' alt='Hasura Console' />
<Thumbnail src="/img/cloud-dbs/hasura-console.png" alt="Hasura Console" />
## Next steps
You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other
- 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
- 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)).
<Thumbnail src='/img/getting-started/project-manage.png' alt='Project actions' width='860px' />
<Thumbnail src="/img/getting-started/project-manage.png" alt="Project actions" width="860px" />
:::info Note

80
docs/docs/databases/connect-db/cloud-databases/enterprisedb.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' />
<Thumbnail src="/img/cloud-dbs/create-hasura-cloud-project.png" alt="Create Hasura Cloud 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.
<Thumbnail src="/img/cloud-dbs/existing-db-setup.png" alt="Hasura Cloud database setup" width="700px" />
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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:
<Thumbnail src='/img/cloud-dbs/big-animal/big-animal-test-drive.png' alt='Test drive BigAnimal' width='700px' />
<Thumbnail src="/img/cloud-dbs/big-animal/big-animal-test-drive.png" alt="Test drive BigAnimal" width="700px" />
EnterpriseDB will create a free trial and redirect you to your BigAnimal portal. From this portal, click
`Create New Cluster`:
<Thumbnail src='/img/cloud-dbs/big-animal/big-animal-create-new-cluster.png' alt='Create new cluster' width='700px' />
<Thumbnail src="/img/cloud-dbs/big-animal/big-animal-create-new-cluster.png" alt="Create new cluster" width="700px" />
Select the type of cluster and provider you plan to use, then click `Next: Cluster Settings`:
<Thumbnail
src='/img/cloud-dbs/big-animal/big-animal-cluster-type-provider.png'
alt='Choose type and provider'
width='700px'
src="/img/cloud-dbs/big-animal/big-animal-cluster-type-provider.png"
alt="Choose type and provider"
width="700px"
/>
Enter a cluster name and password:
<Thumbnail
src='/img/cloud-dbs/big-animal/big-animal-cluster-name-password.png'
alt='Add name and password'
width='700px'
src="/img/cloud-dbs/big-animal/big-animal-cluster-name-password.png"
alt="Add name and password"
width="700px"
/>
Choose a database type, region, and instance type:
<Thumbnail
src='/img/cloud-dbs/big-animal/big-animal-cluster-type-region.png'
alt='Choose cluster type and region'
width='700px'
src="/img/cloud-dbs/big-animal/big-animal-cluster-type-region.png"
alt="Choose cluster type and region"
width="700px"
/>
Select your storage and networking requirements, then click `Create Cluster`:
<Thumbnail
src='/img/cloud-dbs/big-animal/big-animal-storage-networking.png'
alt='Choose storage and networking'
width='700px'
src="/img/cloud-dbs/big-animal/big-animal-storage-networking.png"
alt="Choose storage and networking"
width="700px"
/>
You'll be redirected to your BigAnimal portal and should see your cluster provisioning like this:
<Thumbnail src='/img/cloud-dbs/big-animal/big-animal-provisioning.png' alt='Cluster provisioning' width='700px' />
<Thumbnail src="/img/cloud-dbs/big-animal/big-animal-provisioning.png" alt="Cluster provisioning" width="700px" />
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:
<Thumbnail src='/img/cloud-dbs/big-animal/big-animal-cluster-ready.png' alt='Cluster ready' width='700px' />
<Thumbnail src="/img/cloud-dbs/big-animal/big-animal-cluster-ready.png" alt="Cluster ready" width="700px" />
From the cluster's dashboard, choose the `Connect` tab:
<Thumbnail
src='/img/cloud-dbs/big-animal/big-animal-connection-parameters.png'
alt='Cluster connection parameters'
width='700px'
src="/img/cloud-dbs/big-animal/big-animal-connection-parameters.png"
alt="Cluster connection parameters"
width="700px"
/>
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:
<Thumbnail src='/img/cloud-dbs/big-animal/big-animal-connect-db.png' alt='Connect to Hasura Console' width='700px' />
<Thumbnail src="/img/cloud-dbs/big-animal/big-animal-connect-db.png" alt="Connect to Hasura Console" width="700px" />
:::info Note
@ -153,19 +159,19 @@ of the raw database URLs.
Voilà. You are ready to start developing.
<Thumbnail src='/img/cloud-dbs/hasura-console.png' alt='Hasura Console' />
<Thumbnail src="/img/cloud-dbs/hasura-console.png" alt="Hasura Console" />
## Next steps
You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other
- 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
- 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)).
<Thumbnail src='/img/getting-started/project-manage.png' alt='Project actions' width='860px' />
<Thumbnail src="/img/getting-started/project-manage.png" alt="Project actions" width="860px" />
:::info Note

94
docs/docs/databases/connect-db/cloud-databases/gcp.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' width='1000px' />
<Thumbnail src="/img/cloud-dbs/create-hasura-cloud-project.png" alt="Create Hasura Cloud project" width="1000px" />
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.
<Thumbnail src="/img/cloud-dbs/existing-db-setup.png" alt="Hasura Cloud database setup" width="700px" />
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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`:
<Thumbnail src='/img/cloud-dbs/gcp/navigate-to-sql.png' alt='Navigate to SQL in GCP' width='250px' />
<Thumbnail src="/img/cloud-dbs/gcp/navigate-to-sql.png" alt="Navigate to SQL in GCP" width="250px" />
On the top, click on `Create instance`:
<Thumbnail src='/img/cloud-dbs/gcp/create-instance.png' alt='Create database instance in GCP' width='1000px' />
<Thumbnail src="/img/cloud-dbs/gcp/create-instance.png" alt="Create database instance in GCP" width="1000px" />
Select Postgres:
<Thumbnail src='/img/cloud-dbs/gcp/select-postgres.png' alt='Select Postgres database instance in GCP' width='1000px' />
<Thumbnail src="/img/cloud-dbs/gcp/select-postgres.png" alt="Select Postgres database instance in GCP" width="1000px" />
Select an instance ID, as well as a default user password. If required, choose a specific region and zone.
<Thumbnail src='/img/cloud-dbs/gcp/configure-instance.png' alt='Configure database instance in GCP' width='500px' />
<Thumbnail src="/img/cloud-dbs/gcp/configure-instance.png" alt="Configure database instance in GCP" width="500px" />
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`:
<Thumbnail src='/img/cloud-dbs/gcp/connections.png' alt='Navigate to connections in GCP' width='600px' />
<Thumbnail src="/img/cloud-dbs/gcp/connections.png" alt="Navigate to connections in GCP" width="600px" />
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:
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' width='1000px' />
<Thumbnail src="/img/projects/hasura-cloud-ip.png" alt="Hasura Cloud IP field" width="1000px" />
:::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:
<Thumbnail src='/img/cloud-dbs/gcp/add-network.png' alt='Add a new network in GCP' width='600px' />
<Thumbnail src="/img/cloud-dbs/gcp/add-network.png" alt="Add a new network in GCP" width="600px" />
Then click `Save`.
@ -106,16 +126,16 @@ postgresql://<user-name>:<password>@<public-ip>:<postgres-port>/
- `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`:
<Thumbnail src='/img/cloud-dbs/gcp/public-ip.png' alt='Find the public IP for a GCP Postgres database' width='700px' />
<Thumbnail src="/img/cloud-dbs/gcp/public-ip.png" alt="Find the public IP for a GCP Postgres database" width="700px" />
- `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):
<Thumbnail src='/img/cloud-dbs/gcp/GCP-complete.png' alt='Database setup' width='600px' />
<Thumbnail src="/img/cloud-dbs/gcp/GCP-complete.png" alt="Database setup" width="600px" />
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.
<Thumbnail src='/img/cloud-dbs/hasura-console.png' alt='Hasura console' width='1100px' />
<Thumbnail src="/img/cloud-dbs/hasura-console.png" alt="Hasura console" width="1100px" />
## 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:
<Thumbnail src='/img/cloud-dbs/gcp/cloud-gcp-env-vars.png' alt='Hasura Cloud Env Vars' width='1000px' />
<Thumbnail src="/img/cloud-dbs/gcp/cloud-gcp-env-vars.png" alt="Hasura Cloud Env Vars" width="1000px" />
:::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:
<Thumbnail src='/img/cloud-dbs/gcp/ssl-config-setup.png' alt='Hasura Console SSL Config Setup' width='1000px' />
<Thumbnail src="/img/cloud-dbs/gcp/ssl-config-setup.png" alt="Hasura Console SSL Config Setup" width="1000px" />
Finally, click on the `Update Connection` button to apply the SSL settings.
<Thumbnail src='/img/cloud-dbs/gcp/update-connection-button.png' alt='Update Connection Button' width='1000px' />
<Thumbnail src="/img/cloud-dbs/gcp/update-connection-button.png" alt="Update Connection Button" width="1000px" />
## Next steps
You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other
- 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
- 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)).
<Thumbnail src='/img/getting-started/project-manage.png' alt='Project actions' width='860px' />
<Thumbnail src="/img/getting-started/project-manage.png" alt="Project actions" width="860px" />
:::info Note

7
docs/docs/databases/connect-db/cloud-databases/heroku.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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

156
docs/docs/databases/connect-db/cloud-databases/index.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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.
<div className='vendor-table'>
<VersionedLink to='/databases/connect-db/cloud-databases/aiven'>
<div className='card-wrapper'>
<div className='card'>
<img src={Aiven} title='Aiven Postgres' alt='Connect Postgres DB to Hasura' />
<div className="vendor-table">
<VersionedLink to="/databases/connect-db/cloud-databases/aiven">
<div className="card-wrapper">
<div className="card">
<img src={Aiven} title="Aiven Postgres" alt="Connect Postgres DB to Hasura" />
</div>
<h5>Aiven</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/alloy'>
<div className='card-wrapper'>
<div className='card'>
<img src={Alloy} title='Google AlloyDB Postgres' alt='Connect Google AlloyDB to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/alloy">
<div className="card-wrapper">
<div className="card">
<img src={Alloy} title="Google AlloyDB Postgres" alt="Connect Google AlloyDB to Hasura" />
</div>
<h5>AlloyDB</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/aws-aurora'>
<div className='card-wrapper'>
<div className='card'>
<img src={Aurora} title='AWS Aurora Postgres' alt='Connect AWS Aurora Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/aws-aurora">
<div className="card-wrapper">
<div className="card">
<img src={Aurora} title="AWS Aurora Postgres" alt="Connect AWS Aurora Postgres to Hasura" />
</div>
<h5>AWS RDS Aurora Postgres</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/aws-postgres'>
<div className='card-wrapper'>
<div className='card'>
<img src={RDS} title='AWS RDS Postgres' alt='Connect AWS RDS Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/aws-postgres">
<div className="card-wrapper">
<div className="card">
<img src={RDS} title="AWS RDS Postgres" alt="Connect AWS RDS Postgres to Hasura" />
</div>
<h5>AWS RDS Postgres</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/azure-cosmos'>
<div className='card-wrapper'>
<div className='card'>
<img src={Cosmos} title='Azure Cosmos DB' alt='Connect Azure Cosmos to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/azure-cosmos">
<div className="card-wrapper">
<div className="card">
<img src={Cosmos} title="Azure Cosmos DB" alt="Connect Azure Cosmos to Hasura" />
</div>
<h5>Azure Cosmos</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/mssql'>
<div className='card-wrapper'>
<div className='card'>
<img src={MSSQL} title='MS SQL on Azure' alt='Connect MS SQL on Azure to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/mssql">
<div className="card-wrapper">
<div className="card">
<img src={MSSQL} title="MS SQL on Azure" alt="Connect MS SQL on Azure to Hasura" />
</div>
<h5>Azure MS SQL</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/azure'>
<div className='card-wrapper'>
<div className='card'>
<img src={Azure} title='Azure Postgres' alt='Connect Azure Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/azure">
<div className="card-wrapper">
<div className="card">
<img src={Azure} title="Azure Postgres" alt="Connect Azure Postgres to Hasura" />
</div>
<h5>Azure Postgres</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/crunchy'>
<div className='card-wrapper'>
<div className='card'>
<img src={RollTide} title='Crunchy Postgres' alt='Connect Crunchy Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/crunchy">
<div className="card-wrapper">
<div className="card">
<img src={RollTide} title="Crunchy Postgres" alt="Connect Crunchy Postgres to Hasura" />
</div>
<h5>Crunchy Postgres</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/digital-ocean'>
<div className='card-wrapper'>
<div className='card'>
<img src={DO} title='Digital Ocean Postgres' alt='Connect DO Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/digital-ocean">
<div className="card-wrapper">
<div className="card">
<img src={DO} title="Digital Ocean Postgres" alt="Connect DO Postgres to Hasura" />
</div>
<h5>Digital Ocean Postgres</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/elephant'>
<div className='card-wrapper'>
<div className='card'>
<img src={Elephant} title='ElephantSQL Postgres' alt='Connect ElephantSQL Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/elephant">
<div className="card-wrapper">
<div className="card">
<img src={Elephant} title="ElephantSQL Postgres" alt="Connect ElephantSQL Postgres to Hasura" />
</div>
<h5>ElephantSQL</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/enterprisedb'>
<div className='card-wrapper'>
<div className='card'>
<VersionedLink to="/databases/connect-db/cloud-databases/enterprisedb">
<div className="card-wrapper">
<div className="card">
<img
src={Enterprise}
title='EnterpriseDB BigAnimal Postgres'
alt='Connect EnterpriseDB BigAnimal Postgres to Hasura'
title="EnterpriseDB BigAnimal Postgres"
alt="Connect EnterpriseDB BigAnimal Postgres to Hasura"
/>
</div>
<h5>EnterpriseDB</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/gcp'>
<div className='card-wrapper'>
<div className='card'>
<img src={GCP} title='GCP Postgres' alt='Connect GCP Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/gcp">
<div className="card-wrapper">
<div className="card">
<img src={GCP} title="GCP Postgres" alt="Connect GCP Postgres to Hasura" />
</div>
<h5>GCP Postgres</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/neon'>
<div className='card-wrapper'>
<div className='card'>
<img src={Neon} title='Neon Postgres' alt='Connect Neon Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/neon">
<div className="card-wrapper">
<div className="card">
<img src={Neon} title="Neon Postgres" alt="Connect Neon Postgres to Hasura" />
</div>
<h5>Neon Postgres</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/railway'>
<div className='card-wrapper'>
<div className='card'>
<img src={Railway} title='Railway Postgres' alt='Connect Railway Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/railway">
<div className="card-wrapper">
<div className="card">
<img src={Railway} title="Railway Postgres" alt="Connect Railway Postgres to Hasura" />
</div>
<h5>Railway Postgres</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/render'>
<div className='card-wrapper'>
<div className='card'>
<img src={Render} title='Render Postgres' alt='Connect Render Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/render">
<div className="card-wrapper">
<div className="card">
<img src={Render} title="Render Postgres" alt="Connect Render Postgres to Hasura" />
</div>
<h5>Render Postgres</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/supabase'>
<div className='card-wrapper'>
<div className='card'>
<img src={Supabase} title='Supabase Postgres' alt='Connect Supabase Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/supabase">
<div className="card-wrapper">
<div className="card">
<img src={Supabase} title="Supabase Postgres" alt="Connect Supabase Postgres to Hasura" />
</div>
<h5>Supabase Postgres</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/timescale-cloud'>
<div className='card-wrapper'>
<div className='card'>
<img src={Timescale} title='TimescaleDB Postgres' alt='Connect TimescaleDB Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/timescale-cloud">
<div className="card-wrapper">
<div className="card">
<img src={Timescale} title="TimescaleDB Postgres" alt="Connect TimescaleDB Postgres to Hasura" />
</div>
<h5>TimescaleDB</h5>
</div>
</VersionedLink>
<VersionedLink to='/databases/connect-db/cloud-databases/yugabyte'>
<div className='card-wrapper'>
<div className='card'>
<img src={Yugabyte} title='YugabyteDB Postgres' alt='Connect YugabyteDB Postgres to Hasura' />
<VersionedLink to="/databases/connect-db/cloud-databases/yugabyte">
<div className="card-wrapper">
<div className="card">
<img src={Yugabyte} title="YugabyteDB Postgres" alt="Connect YugabyteDB Postgres to Hasura" />
</div>
<h5>YugabyteDB</h5>
</div>

89
docs/docs/databases/connect-db/cloud-databases/mssql.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' width='1000px' />
<Thumbnail src="/img/cloud-dbs/create-hasura-cloud-project.png" alt="Create Hasura Cloud project" width="1000px" />
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.
<Thumbnail src='/img/cloud-dbs/mssql/existing-mssql-setup.png' alt='Hasura Cloud database setup' width='1000px' />
<Thumbnail src="/img/cloud-dbs/mssql/existing-mssql-setup.png" alt="Hasura Cloud database setup" width="1000px" />
## 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`:
<Thumbnail
src='/img/cloud-dbs/mssql/select-sql-server-step-1.png'
alt='Navigate to SQL Servers on Azure'
width='1000px'
src="/img/cloud-dbs/mssql/select-sql-server-step-1.png"
alt="Navigate to SQL Servers on Azure"
width="1000px"
/>
Click on the `Create` button:
<Thumbnail src='/img/cloud-dbs/mssql/click-on-create-step-2.png' alt='Create database in Azure' width='1000px' />
<Thumbnail src="/img/cloud-dbs/mssql/click-on-create-step-2.png" alt="Create database in Azure" width="1000px" />
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.
<Thumbnail
src='/img/cloud-dbs/mssql/fill-required-fields-step-3.png'
alt='Fill all required fields to create database'
width='1000px'
src="/img/cloud-dbs/mssql/fill-required-fields-step-3.png"
alt="Fill all required fields to create database"
width="1000px"
/>
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.
<Thumbnail
src='/img/cloud-dbs/mssql/review-and-create-step-4.png'
alt='Review and create SQL Server instance'
width='1000px'
src="/img/cloud-dbs/mssql/review-and-create-step-4.png"
alt="Review and create SQL Server instance"
width="1000px"
/>
## 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`.
<Thumbnail src='/img/cloud-dbs/mssql/server-created-go-to-network.png' alt='Go to networking settings' width='1000px' />
<Thumbnail src="/img/cloud-dbs/mssql/server-created-go-to-network.png" alt="Go to networking settings" width="1000px" />
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:
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' width='1000px' />
<Thumbnail src="/img/projects/hasura-cloud-ip.png" alt="Hasura Cloud IP field" width="1000px" />
:::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:
<Thumbnail src='/img/cloud-dbs/mssql/add-ip-and-save.png' alt='Add IP to firewall' width='1000px' />
<Thumbnail src="/img/cloud-dbs/mssql/add-ip-and-save.png" alt="Add IP to firewall" width="1000px" />
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`
<Thumbnail
src='/img/cloud-dbs/mssql/click-on-create-db-step-6.png'
alt='Create Database on SQL Server'
width='1000px'
src="/img/cloud-dbs/mssql/click-on-create-db-step-6.png"
alt="Create Database on SQL Server"
width="1000px"
/>
Fill in all the required fields and additional settings if required. Click on `Review + create` and create the database.
<Thumbnail src='/img/cloud-dbs/mssql/create-db-step-7.png' alt='Review and create database' width='1000px' />
<Thumbnail src="/img/cloud-dbs/mssql/create-db-step-7.png" alt="Review and create database" width="1000px" />
## 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.
<Thumbnail src='/img/cloud-dbs/mssql/copy-server-name.png' alt='Copy server name' width='1000px' />
<Thumbnail src="/img/cloud-dbs/mssql/copy-server-name.png" alt="Copy server name" width="1000px" />
- `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):
<Thumbnail src='/img/cloud-dbs/mssql/connect-to-hasura-step-8.png' alt='Database setup' width='1000px' />
<Thumbnail src="/img/cloud-dbs/mssql/connect-to-hasura-step-8.png" alt="Database setup" width="1000px" />
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.
<Thumbnail src='/img/cloud-dbs/hasura-console.png' alt='Hasura console' width='1100px' />
<Thumbnail src="/img/cloud-dbs/hasura-console.png" alt="Hasura console" width="1100px" />
## Next steps
You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other
- 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
- 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)).
<Thumbnail src='/img/getting-started/project-manage.png' alt='Project actions' width='860px' />
<Thumbnail src="/img/getting-started/project-manage.png" alt="Project actions" width="860px" />
:::info Note

19
docs/docs/databases/connect-db/cloud-databases/neon.mdx
View File

@ -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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' />
<Thumbnail src="/img/cloud-dbs/create-hasura-cloud-project.png" alt="Create Hasura Cloud 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.
<Thumbnail src='/img/cloud-dbs/neon/connect_neon_database.png' alt='Connect Neon database' widht='700px' />
<Thumbnail src="/img/cloud-dbs/neon/connect_neon_database.png" alt="Connect Neon database" widht="700px" />
On the next step, you'll be prompted to Login/Sign up for Neon. We recommend `Continue with Hasura` for a seamless
experience.
<Thumbnail src='/img/cloud-dbs/neon/neon_authentication.png' alt='Neon Authentication' widht='700px' />
<Thumbnail src="/img/cloud-dbs/neon/neon_authentication.png" alt="Neon Authentication" widht="700px" />
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:
<Thumbnail src='/img/cloud-dbs/neon/hasura_hello_world_template.png' alt='Hello World Template' widht='700px' />
<Thumbnail src="/img/cloud-dbs/neon/hasura_hello_world_template.png" alt="Hello World Template" widht="700px" />
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.
<Thumbnail src='/img/cloud-dbs/hasura-console.png' alt='Hasura Console' />
<Thumbnail src="/img/cloud-dbs/hasura-console.png" alt="Hasura Console" />
:::info Note
You can visit the Neon console from the `Data` tab to manage your created database.
<Thumbnail src='/img/cloud-dbs/neon/neon_console_link_page.png' alt='Neon Console Link' widht='700px' />
<Thumbnail src="/img/cloud-dbs/neon/neon_console_link_page.png" alt="Neon Console Link" widht="700px" />
:::
@ -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.
<Thumbnail src='/img/cloud-dbs/neon/free_tier_exceeded_neon.png' alt='Neon Free Tier Warning' widht='700px' />
<Thumbnail src="/img/cloud-dbs/neon/free_tier_exceeded_neon.png" alt="Neon Free Tier Warning" widht="700px" />
:::

60
docs/docs/databases/connect-db/cloud-databases/railway.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' />
<Thumbnail src="/img/cloud-dbs/create-hasura-cloud-project.png" alt="Create Hasura Cloud 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.
<Thumbnail src="/img/cloud-dbs/existing-db-setup.png" alt="Hasura Cloud database setup" width="700px" />
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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`:
<Thumbnail src='/img/cloud-dbs/railway/railway-new-project.png' alt='Create a new project with Railway' width='700px' />
<Thumbnail src="/img/cloud-dbs/railway/railway-new-project.png" alt="Create a new project with Railway" width="700px" />
Select `Provision PostgreSQL`:
<Thumbnail src='/img/cloud-dbs/railway/railway-new-pg.png' alt='Create a new PG db with Railway' width='700px' />
<Thumbnail src="/img/cloud-dbs/railway/railway-new-pg.png" alt="Create a new PG db with Railway" width="700px" />
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://<user-name>:<password>@<host-server>:<port>/<database-name>
Click on the `PostgreSQL` card to see details related to this instance.
<Thumbnail
src='/img/cloud-dbs/railway/railway-choose-pg.png'
alt='Access your the details of the db from the card'
width='700px'
src="/img/cloud-dbs/railway/railway-choose-pg.png"
alt="Access your the details of the db from the card"
width="700px"
/>
Choose the `Connect` tab and copy the `Postgres Connection URL`:
<Thumbnail
src='/img/cloud-dbs/railway/railway-connection-string.png'
alt='Go to the connect tab and grab the connection string'
width='700px'
src="/img/cloud-dbs/railway/railway-connection-string.png"
alt="Go to the connect tab and grab the connection string"
width="700px"
/>
## 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:
<Thumbnail
src='/img/cloud-dbs/render/render-connect-db.png'
alt='Connect the database on Hasura Console'
width='700px'
src="/img/cloud-dbs/render/render-connect-db.png"
alt="Connect the database on Hasura Console"
width="700px"
/>
Then click `Connect Database`.
@ -105,19 +111,19 @@ of the raw database URLs.
Voilà. You are ready to start developing.
<Thumbnail src='/img/cloud-dbs/hasura-console.png' alt='Hasura Console' />
<Thumbnail src="/img/cloud-dbs/hasura-console.png" alt="Hasura Console" />
## Next steps
You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other
- 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
- 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)).
<Thumbnail src='/img/getting-started/project-manage.png' alt='Project actions' width='860px' />
<Thumbnail src="/img/getting-started/project-manage.png" alt="Project actions" width="860px" />
:::info Note

54
docs/docs/databases/connect-db/cloud-databases/render.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' />
<Thumbnail src="/img/cloud-dbs/create-hasura-cloud-project.png" alt="Create Hasura Cloud 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.
<Thumbnail src="/img/cloud-dbs/existing-db-setup.png" alt="Hasura Cloud database setup" width="700px" />
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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`:
<Thumbnail src='/img/cloud-dbs/render/render-new-pg.png' alt='Create a new PG db with Render' width='700px' />
<Thumbnail src="/img/cloud-dbs/render/render-new-pg.png" alt="Create a new PG db with Render" width="700px" />
Choose a name for your new database and fill in the required info. When ready, click `Create Database`:
<Thumbnail src='/img/cloud-dbs/render/render-pg-details.png' alt='Fill in the db details' width='700px' />
<Thumbnail src="/img/cloud-dbs/render/render-pg-details.png" alt="Fill in the db details" width="700px" />
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://<user-name>:<password>@<host-server>/<database-name>
From your database's dashboard, find the `Connections` card and copy the `External Database URL`:
<Thumbnail
src='/img/cloud-dbs/render/render-connection-string.png'
alt='Grab the PG db connection string'
width='700px'
src="/img/cloud-dbs/render/render-connection-string.png"
alt="Grab the PG db connection string"
width="700px"
/>
## 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:
<Thumbnail
src='/img/cloud-dbs/render/render-connect-db.png'
alt='Connect the database on Hasura Console'
width='700px'
src="/img/cloud-dbs/render/render-connect-db.png"
alt="Connect the database on Hasura Console"
width="700px"
/>
Then click `Connect Database`.
@ -97,19 +103,19 @@ of the raw database URLs.
Voilà. You are ready to start developing.
<Thumbnail src='/img/cloud-dbs/hasura-console.png' alt='Hasura Console' />
<Thumbnail src="/img/cloud-dbs/hasura-console.png" alt="Hasura Console" />
## Next steps
You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other
- 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
- 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)).
<Thumbnail src='/img/getting-started/project-manage.png' alt='Project actions' width='860px' />
<Thumbnail src="/img/getting-started/project-manage.png" alt="Project actions" width="860px" />
:::info Note

94
docs/docs/databases/connect-db/cloud-databases/supabase.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' />
<Thumbnail src="/img/cloud-dbs/create-hasura-cloud-project.png" alt="Create Hasura Cloud 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.
<Thumbnail src="/img/cloud-dbs/existing-db-setup.png" alt="Hasura Cloud database setup" width="700px" />
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
## 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`:
<Thumbnail
src='/img/cloud-dbs/supabase/supabase-create-new-project.png'
alt='Create a new project with Supabase'
width='700px'
src="/img/cloud-dbs/supabase/supabase-create-new-project.png"
alt="Create a new project with Supabase"
width="700px"
/>
If you don't already have an organization within Supabase, you'll need to create a one. Click `New organization`:
<Thumbnail
src='/img/cloud-dbs/supabase/supabase-create-new-organization.png'
alt='Create a new organization with Supabase'
width='700px'
src="/img/cloud-dbs/supabase/supabase-create-new-organization.png"
alt="Create a new organization with Supabase"
width="700px"
/>
Fill in a name and click `Create organization`:
<Thumbnail
src='/img/cloud-dbs/supabase/supabase-new-organization-name.png'
alt='Name your organization with Supabase'
width='700px'
src="/img/cloud-dbs/supabase/supabase-new-organization-name.png"
alt="Name your organization with Supabase"
width="700px"
/>
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`:
<Thumbnail
src='/img/cloud-dbs/supabase/supabase-create-new-project-confirm.png'
alt='Confirm project creation'
width='700px'
src="/img/cloud-dbs/supabase/supabase-create-new-project-confirm.png"
alt="Confirm project creation"
width="700px"
/>
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:
<Thumbnail
src='/img/cloud-dbs/supabase/supabase-dashboard-provisioning.png'
alt='Dashboard as project is being provisioned'
width='700px'
src="/img/cloud-dbs/supabase/supabase-dashboard-provisioning.png"
alt="Dashboard as project is being provisioned"
width="700px"
/>
To this:
<Thumbnail
src='/img/cloud-dbs/supabase/supabase-dashboard-ready.png'
alt='Dashboard view after provisioning is complete'
width='700px'
src="/img/cloud-dbs/supabase/supabase-dashboard-ready.png"
alt="Dashboard view after provisioning is complete"
width="700px"
/>
Congratulations! You've now created a Postgres instance on Supabase which you can use with Hasura GraphQL Engine. Follow
@ -111,22 +117,22 @@ postgresql://<user-name>:<password>@<host-server>:<port>/<database-name>
From your database's dashboard, click the `Settings` icon on the side navigation:
<Thumbnail
src='/img/cloud-dbs/supabase/supabase-dashboard-settings.png'
alt='From dashboard, choose settings on the left-hand side'
width='700px'
src="/img/cloud-dbs/supabase/supabase-dashboard-settings.png"
alt="From dashboard, choose settings on the left-hand side"
width="700px"
/>
Choose `Database`:
<Thumbnail
src='/img/cloud-dbs/supabase/supabase-database-view.png'
alt='Database information within the settings view'
width='700px'
src="/img/cloud-dbs/supabase/supabase-database-view.png"
alt="Database information within the settings view"
width="700px"
/>
Then scroll down to find the `Connection string` section. Select the `URI` option and copy the string:
<Thumbnail src='/img/cloud-dbs/supabase/supabase-copy-uri.png' alt='Grab the PG db connection string' width='700px' />
<Thumbnail src="/img/cloud-dbs/supabase/supabase-copy-uri.png" alt="Grab the PG db connection string" width="700px" />
:::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:
<Thumbnail
src='/img/cloud-dbs/supabase/supabase-connected-db.png'
alt='Connect the database on Hasura Console'
width='700px'
src="/img/cloud-dbs/supabase/supabase-connected-db.png"
alt="Connect the database on Hasura Console"
width="700px"
/>
Then click `Connect Database`.
@ -156,19 +162,19 @@ of the raw database URLs.
Voilà. You are ready to start developing.
<Thumbnail src='/img/cloud-dbs/hasura-console.png' alt='Hasura Console' />
<Thumbnail src="/img/cloud-dbs/hasura-console.png" alt="Hasura Console" />
## Next steps
You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other
- 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
- 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)).
<Thumbnail src='/img/getting-started/project-manage.png' alt='Project actions' width='860px' />
<Thumbnail src="/img/getting-started/project-manage.png" alt="Project actions" width="860px" />
:::info Note

76
docs/docs/databases/connect-db/cloud-databases/timescale-cloud.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' width='1000px' />
<Thumbnail src="/img/cloud-dbs/create-hasura-cloud-project.png" alt="Create Hasura Cloud project" width="1000px" />
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`:
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
<Thumbnail src="/img/cloud-dbs/existing-db-setup.png" alt="Hasura Cloud database setup" width="700px" />
## 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`:
<Thumbnail
src='/img/cloud-dbs/timescale/create-new-service.png'
alt='Create a new service on Timescale'
width='1000px'
src="/img/cloud-dbs/timescale/create-new-service.png"
alt="Create a new service on Timescale"
width="1000px"
/>
Select the Postgres option:
<Thumbnail src='/img/cloud-dbs/timescale/select-postgres.png' alt='Select Postgres on Timescale' width='700px' />
<Thumbnail src="/img/cloud-dbs/timescale/select-postgres.png" alt="Select Postgres on Timescale" width="700px" />
Scroll down and select the `Cloud Provider`, `Region` and `Service Plan` based on your requirements.
In the end, enter a `Name` for the service:
<Thumbnail src='/img/cloud-dbs/timescale/create-service.png' alt='Create a service on Timescale' width='1000px' />
<Thumbnail src="/img/cloud-dbs/timescale/create-service.png" alt="Create a service on Timescale" width="1000px" />
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:
<Thumbnail src='/img/cloud-dbs/timescale/select-db.png' alt='Select DB on Timescale' width='1000px' />
<Thumbnail src="/img/cloud-dbs/timescale/select-db.png" alt="Select DB on Timescale" width="1000px" />
Scroll down to `Allowed IP Addresses` and click on `Change`:
<Thumbnail
src='/img/cloud-dbs/timescale/change-allowed-ip-addresses.png'
alt='Change allowed IP addresses on Timescale'
width='1000px'
src="/img/cloud-dbs/timescale/change-allowed-ip-addresses.png"
alt="Change allowed IP addresses on Timescale"
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:
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' width='1000px' />
<Thumbnail src="/img/projects/hasura-cloud-ip.png" alt="Hasura Cloud IP field" width="1000px" />
:::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`:
<Thumbnail src='/img/cloud-dbs/timescale/add-hasura-ip.png' alt='Add the Hasura IP on Timescale' width='500px' />
<Thumbnail src="/img/cloud-dbs/timescale/add-hasura-ip.png" alt="Add the Hasura IP on Timescale" width="500px" />
## Step 5: Get the database connection URL {#get-db-url-timescale}
@ -106,13 +120,13 @@ postgresql://<user-name>:<password>@<public-ip>:<postgres-port>/<db>?sslmode=req
To get it, navigate to the `Overview` tab of your database dashboard and copy the `Service URI`:
<Thumbnail src='/img/cloud-dbs/timescale/copy-service-uri.png' alt='Copy the service URI on Timescale' width='1000px' />
<Thumbnail src="/img/cloud-dbs/timescale/copy-service-uri.png" alt="Copy the service URI on Timescale" width="1000px" />
## 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):
<Thumbnail src='/img/cloud-dbs/timescale/TS-complete.png' alt='Database setup' width='600px' />
<Thumbnail src="/img/cloud-dbs/timescale/TS-complete.png" alt="Database setup" width="600px" />
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.
<Thumbnail src='/img/cloud-dbs/hasura-console.png' alt='Hasura console' width='1100px' />
<Thumbnail src="/img/cloud-dbs/hasura-console.png" alt="Hasura console" width="1100px" />
## Next steps
You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other
- 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
- 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)).
<Thumbnail src='/img/getting-started/project-manage.png' alt='Project actions' width='860px' />
<Thumbnail src="/img/getting-started/project-manage.png" alt="Project actions" width="860px" />
:::info Note

89
docs/docs/databases/connect-db/cloud-databases/yugabyte.mdx
View File

@ -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
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
# 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:
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' width='1000px' />
<Thumbnail src="/img/cloud-dbs/create-hasura-cloud-project.png" alt="Create Hasura Cloud project" width="1000px" />
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`:
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
<Thumbnail src="/img/cloud-dbs/existing-db-setup.png" alt="Hasura Cloud database setup" width="700px" />
## 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`:
<Thumbnail src='/img/cloud-dbs/yugabyte/yb-step-2.png' alt='Create cluster on Yugabyte' width='1000px' />
<Thumbnail src="/img/cloud-dbs/yugabyte/yb-step-2.png" alt="Create cluster on Yugabyte" width="1000px" />
Select the `Managed Free` option and then click `Next`.
<Thumbnail src='/img/cloud-dbs/yugabyte/yb-step-3a.png' alt='Managed Free cluster on Yugabyte' width='1000px' />
<Thumbnail src="/img/cloud-dbs/yugabyte/yb-step-3a.png" alt="Managed Free cluster on Yugabyte" width="1000px" />
Select a `Cloud Provider` and `Region` and then click `Next`.
<Thumbnail src='/img/cloud-dbs/yugabyte/yb-step-3b.png' alt='Cloud Provider and Region on Yugabyte' width='1000px' />
<Thumbnail src="/img/cloud-dbs/yugabyte/yb-step-3b.png" alt="Cloud Provider and Region on Yugabyte" width="1000px" />
:::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`.
<Thumbnail
src='/img/cloud-dbs/yugabyte/yb-step-3c.png'
alt='Create cluster on Yugabyte after downloading credentials'
width='1000px'
src="/img/cloud-dbs/yugabyte/yb-step-3c.png"
alt="Create cluster on Yugabyte after downloading credentials"
width="1000px"
/>
## 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`:
<Thumbnail src='/img/cloud-dbs/yugabyte/yb-step-3d.png' alt='Add IP Allow List on Yugabyte' width='1000px' />
<Thumbnail src="/img/cloud-dbs/yugabyte/yb-step-3d.png" alt="Add IP Allow List on Yugabyte" width="1000px" />
Within the modal, click `Create New List and Add to Cluster`:
<Thumbnail
src='/img/cloud-dbs/yugabyte/yb-step-3e.png'
alt='Create New List and Add to Cluster on Yugabyte'
width='1000px'
src="/img/cloud-dbs/yugabyte/yb-step-3e.png"
alt="Create New List and Add to Cluster on Yugabyte"
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:
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' />
<Thumbnail src="/img/projects/hasura-cloud-ip.png" alt="Hasura Cloud IP field" width="1000px" />
:::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:
<Thumbnail
src='/img/cloud-dbs/yugabyte/yb-step-3f.png'
alt='Add Hasura IP to database in Allow List on Yugabyte'
width='700px'
src="/img/cloud-dbs/yugabyte/yb-step-3f.png"
alt="Add Hasura IP to database in Allow List on Yugabyte"
width="700px"
/>
Then click `Save`.
@ -113,17 +126,17 @@ postgresql://<user-name>:<password>@<public-ip>:<postgres-port>/<db>?ssl=true&ss
To get it, from the cluster's dashboard, click `Run your own application`:
<Thumbnail
src='/img/cloud-dbs/yugabyte/yb-step-3g.png'
alt='Run your own application on clutser dashboard'
width='700px'
src="/img/cloud-dbs/yugabyte/yb-step-3g.png"
alt="Run your own application on clutser dashboard"
width="700px"
/>
Click the `Optimize for Hasura Cloud` checkbox and then copy your connection string:
<Thumbnail
src='/img/cloud-dbs/yugabyte/yb-step-3h.png'
alt='Copy connection string on cluster dashboard'
width='1000px'
src="/img/cloud-dbs/yugabyte/yb-step-3h.png"
alt="Copy connection string on cluster dashboard"
width="1000px"
/>
## 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 `<DB USER>` and `<DB PASSWORD>`
with the information from your credentials downloaded in [step 3](#create-pg-db-yugabyte):
<Thumbnail src='/img/cloud-dbs/yugabyte/yb-step-3i.png' alt='Database setup' width='600px' />
<Thumbnail src="/img/cloud-dbs/yugabyte/yb-step-3i.png" alt="Database setup" width="600px" />
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.
<Thumbnail src='/img/cloud-dbs/hasura-console.png' alt='Hasura console' width='1100px' />
<Thumbnail src="/img/cloud-dbs/hasura-console.png" alt="Hasura console" width="1100px" />
## Next steps
You can check out our [30-Minute Hasura Basics Course](https://hasura.io/learn/graphql/hasura/introduction/) and other
- 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
- 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)).
<Thumbnail src='/img/getting-started/project-manage.png' alt='Project actions' width='860px' />
<Thumbnail src="/img/getting-started/project-manage.png" alt="Project actions" width="860px" />
:::info Note