diff --git a/docs/docs/actions/create.mdx b/docs/docs/actions/create.mdx
index 18e8e5884ce..4b02d62dae6 100644
--- a/docs/docs/actions/create.mdx
+++ b/docs/docs/actions/create.mdx
@@ -1,6 +1,6 @@
---
sidebar_label: Create Actions
-sidebar_position: 1
+sidebar_position: 3
description: Create Hasura Actions
keywords:
- hasura
diff --git a/docs/docs/actions/index.mdx b/docs/docs/actions/index.mdx
deleted file mode 100644
index 4cbc61520fa..00000000000
--- a/docs/docs/actions/index.mdx
+++ /dev/null
@@ -1,163 +0,0 @@
----
-description: Hasura Actions
-keywords:
- - hasura
- - docs
- - actions
-slug: index
-title: Actions
----
-
-import Thumbnail from '@site/src/components/Thumbnail';
-import Actions from '@site/static/icons/features/actions.svg';
-
-# Actions
-
-## What are Hasura Actions?
-
-Actions are a way to extend Hasura's schema with custom business logic using custom queries and mutations. Actions can
-be added to Hasura to handle various use cases such as data validation, data enrichment from external sources and any
-other complex business logic.
-
-
-
-:::tip Supported from
-
-Actions are supported in Hasura GraphQL Engine versions `v1.2.0` and above.
-
-Actions are supported for **Postgres versions 10 and above**.
-
-:::
-
-## Action description
-
-An action consists of the following parts:
-
-1. `Type`: The type of the action (`query` or `mutation`)
-2. `Definition`: The definition of the query or mutation
-3. `Handler`: The logic to be run when the query or mutation is executed
-4. `Kind`: Sync or async. In case of a query action, there is no `Kind` associated with it. A query action is always
- sync
-
-### Type
-
-Actions can be of two types:
-
-- **Query action**: An action of type `query` extends the query root of the Hasura schema. This means that you can
- execute this action through a GraphQL query. Query Actions must be used where you want to fetch data from a data
- source without changing anything on the data source.
-- **Mutation action**: An action of type `mutation` extends the mutation root of the Hasura schema. This means that you
- can execute this action through a GraphQL mutation. Mutation Actions must be used when you want to mutate the state of
- a data source and fetch some data.
-
-### Definition
-
-The action definition consists of the following:
-
-- `Action Name`: The action will be available as a query or mutation in the GraphQL schema named as the action name
-- `Arguments`: Arguments are used to pass dynamic values along with the query/mutation.
-- `Response type`: The GraphQL type of the response that the query or mutation will return. Action response types
- support objects, scalars and lists of those only.
-
-For instance, consider this action definition:
-
-```graphql
-type Mutation {
- userLogin(username: String!, password: String!): UserInfo
-}
-```
-
-In case the action response is a scalar (eg. Int), the action can also be defined as:
-
-```graphql
-type Mutation {
- userLogin(username: String!, password: String!): Int!
-}
-```
-
-In this definition, we are extending the mutation root with an action called `userLogin`.
-
-- `userLogin` is the action name
-- `username` and `password` are the arguments that accept non-nullable string values.
-- `UserInfo` is the response type of the action
-
-**Custom Types**
-
-In case the action returns an object type, you will have to define your custom types like so:
-
-```graphql
-type UserInfo {
- accessToken: String!
- userId: Int!
-}
-```
-
-Read more about [custom types](/actions/types.mdx).
-
-### Handler
-
-Once you define the action types, you also have to specify the logic to run when the action is executed. This can be
-done in an HTTP webhook, also called the action handler. It could be a REST endpoint or a serverless function.
-
-Learn more about [writing an action handler](/actions/action-handlers.mdx).
-
-### Kind
-
-**Mutation Actions** are of two kinds:
-
-- **Synchronous**: Sync Actions return a response to the client after receiving a response from the handler.
-- **Asynchronous**: [Async Actions](/actions/async-actions.mdx) return an `action id` as response to the client before
- receiving a response from the handler and allow the client to subscribe to the actual response using the `action id`.
-
-**Query Actions** don't have a kind, they always behave like sync mutation Actions.
-
-## How it works?
-
-- Hasura receives the action GraphQL query or mutation and converts this request into an event payload.
-- The event is captured, persisted and then delivered to the action handler with the appropriate retry/delivery
- guarantees.
-- The Action handler runs and returns a response that is captured as an event and again persisted to the event store.
-- The Action response is returned to the client synchronously or asynchronously based on the kind.
-
-## Actions vs. Remote Schemas
-
-Both Actions and Remote Schemas can be used to extend Hasura with business logic. However, they have slightly different
-use cases.
-
-**Actions**
-
-Actions can be used when we want to call a REST endpoint from Hasura as a resolver for some custom types. They are
-especially useful for setting up serverless functions as resolvers.
-
-**Remote Schemas**
-
-If you have an existing GraphQL API or if you're comfortable building a GraphQL server yourself, you can use
-[Remote Schemas](/remote-schemas/index.mdx) to add custom types and resolvers.
-
-## Learn more
-
-- [Creating Actions](/actions/create.mdx)
-- [Custom types](/actions/types.mdx)
-- [Action handlers](/actions/action-handlers.mdx)
-- [Async Actions](/actions/async-actions.mdx)
-- [Codegen](/actions/codegen/index.mdx)
-- [Deriving Actions](/actions/derive.mdx)
-- [Actions permissions](/actions/action-permissions.mdx)
-- [Actions relationships](/actions/action-relationships.mdx)
-- [REST Connectors for Actions](/actions/rest-connectors.mdx)
-- [Debugging Actions](/actions/debugging.mdx)
-- [Cleaning up async Action logs](/actions/logs-clean-up.mdx)
-
-
-
-:::info Additional Resources
-
-- Introduction to Hasura Actions -
- [View Recording](https://hasura.io/events/webinar/hasura-actions/?pg=docs&plcmt=body&cta=view-recording&tech=)
-- Custom Business Logic - [Learn Tutorial](https://hasura.io/learn/graphql/hasura/custom-business-logic/)
-
-:::
diff --git a/docs/docs/actions/overview.mdx b/docs/docs/actions/overview.mdx
new file mode 100644
index 00000000000..74caa4eadc6
--- /dev/null
+++ b/docs/docs/actions/overview.mdx
@@ -0,0 +1,80 @@
+---
+description: Hasura Actions
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - actions
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Actions from '@site/static/icons/features/actions.svg';
+
+# Actions
+
+
+
+
+ Actions are a convenient and secure way to connect to REST APIs to achieve any business logic you may need,
+ directly from your GraphQL API.
+
+
+ Maybe you need to validate, process or enrich some data, call another API, or log a user in. With Actions you can
+ connect to a REST endpoint which can be your own custom server, a public API, or a serverless function.
+
+
+ You can also apply transforms to your payloads and responses and handle the response to your GraphQL client
+ asynchronously, subscribing to results as they occur.
+
+
Quick Links
+
+
+ Get started with Actions in 60 seconds.
+
+
+ Learn how Actions work.
+
+
+
+
+
+
+
+
+## Using Actions
+
+
+
+
+
REST Connectors
+
Integrate existing REST APIs into your GraphQL schema with Actions by applying context and transforms.
+
+
+
+
+
Import OpenAPI to Actions
+
+ Upload an API written in the OpenAPI spec, select the operation you want as a Hasura Action and it will be
+ imported for you.
+
+
+
+
+
+
Async Actions
+
Subscribe to the result of a long-running action in order to be updated as results are processed.
+
+
+
diff --git a/docs/docs/actions/quickstart.mdx b/docs/docs/actions/quickstart.mdx
new file mode 100644
index 00000000000..ab4c94e18dd
--- /dev/null
+++ b/docs/docs/actions/quickstart.mdx
@@ -0,0 +1,207 @@
+---
+description: Quickstart Actions
+title: Quickstart Actions
+keywords:
+ - hasura
+ - docs
+ - actions
+ - quickstart
+ - guide
+ - tutorial
+sidebar_label: Quickstart
+sidebar_position: 2
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
+import SampleAppBlock from '@site/src/components/SampleAppBlock';
+
+# Quickstart Actions
+
+Actions extend your GraphQL schema, allowing it to include traditional REST endpoints. This quickstart will show you how
+to implement an Action using the Console of your Hasura project. This Action, using a REST API, will convert a
+currency value that we'll query directly from our GraphQL API.
+
+**All you need to do is to follow the steps listed below, but if you're more curious about what's happening, check out
+the [recap at the bottom of the page](#recap).**
+
+
+
+## Step 1: Open the Actions page
+
+From the Console of a Hasura Project, open the `Actions` page and click `Create`:
+
+
+
+## Step 2: Describe the Action {#step-2}
+
+Copy and paste the following string in the `Comment / Description` field at the top of the page:
+
+```text
+Convert currency with real-time exchange rates.
+```
+
+
+
+## Step 3: Define the Action {#step-3}
+
+Copy and paste the block below into the `Action Definition` field. It will take the place of all placeholder text:
+
+```graphql
+type Query {
+ currencyConverter(CurrencyInfo: InputParams!): ConvertedCurrency
+}
+```
+
+
+
+## Step 4: Configure your types {#step-4}
+
+Copy and paste the block below into the `Type Configuration` field. It will take the place of all placeholder text:
+
+```graphql
+input InputParams {
+ from: String
+ to: String
+ amt: Int
+}
+
+type Info {
+ rate: Float
+}
+
+type Query {
+ amount: Int
+ from: String
+ to: String
+}
+
+type ConvertedCurrency {
+ date: String
+ info: Info
+ query: Query
+ result: Float
+ success: Boolean
+}
+```
+
+
+
+## Step 5: Add the REST endpoint {#step-5}
+
+In the `Webhook Handler` field, copy and paste the following:
+
+```text
+https://api.exchangerate.host/convert
+```
+
+
+
+## Step 6: Change the request options and add query params {#step-6}
+
+Click `Add Request Options Transform` and change the `Request Method` to `GET`:
+
+
+
+Add the following query parameters and values as separate pairs in the available fields:
+
+| Query Param | Value |
+| ----------- | ----------------------------------- |
+| from | `{{$body.input.CurrencyInfo.from}}` |
+| to | `{{$body.input.CurrencyInfo.to}}` |
+| amount | `{{$body.input.CurrencyInfo.amt}}` |
+
+Scroll to the bottom of the page, click `Create Action`, then head to your API page.
+
+## Step 7: Run a query
+
+Copy and paste the query on the left into your GraphiQL explorer and execute the query by clicking the `Play` button.
+The response should look similar to what's on the right (depending on rates):
+
+
+
+## Recap
+
+What just happened? Congrats! You just extended your GraphQL API with a REST endpoint 🎉
+
+Actions can do a lot of things, but chances are - wherever you are in your GraphQL journey - you still have some legacy
+REST APIs that you need to integrate with. Whether you built them yourself or you're trying to integrate with public
+APIs, Actions are a great way to do that.
+
+We started by [describing our Action](#step-2). This may seem like an excessive step, but - since our GraphQL API is
+self-documenting - it's a good idea to add a description to your Action so that your consumers know what it does. The
+value we entered is available as a tooltip in the GraphiQL explorer and in the API's documentation.
+
+From there, we [defined our Action](#step-3). This is where we tell Hasura what our Action will do. In this case, we're
+defining a `Query` that will return a `ConvertedCurrency` type. This is the type that we'll be returning from our REST
+API. We haven't actually defined these types yet; we're just telling Hasura that when running this query, with these
+inputs, we'll be returning a `ConvertedCurrency` type.
+
+Next, we [configured our types](#step-4). This is where we tell Hasura what our `ConvertedCurrency` type looks like. We
+defined the types of our inputs and output. In the case of our inputs, we're defining an `InputParams` type that will be
+used as the input to our Action (i.e., a user will have to pass in an `InputParams` object that contains `from`, `to`,
+and `amt` when executing our Query).
+
+We're also defining the types of our outputs. In this case, we're defining a `ConvertedCurrency` type that will be
+returned from our REST API. It can be laborious to define these types, but Hasura can take care of that for you. The
+Console's Type Generator is a great way to do that: simply paste in some sample JSON output from your endpoint and
+Hasura will generate the types for you.
+
+
+
+Finally, we [added the REST endpoint](#step-5) and [configured the request options](#step-6). This is where we tell
+Hasura where to send our request and what to send. In this case, we're sending a `GET` request to the
+`https://api.exchangerate.host/convert` endpoint. We're also passing in the `from`, `to`, and `amount` query parameters
+that our REST API expects.
+
+Hasura automatically amends the base url of the REST endpoint with these query parameters and their values from the
+query to produce a request that looks like this:
+
+```text
+https://api.exchangerate.host/convert?from=EUR&to=USD&amount=1
+```
+
+To learn about creating your own Actions, check out the [Create Actions page](/actions/create.mdx).
diff --git a/docs/docs/api-reference/cloud-api-reference.mdx b/docs/docs/api-reference/cloud-api-reference.mdx
index 2c7fd1ff4f7..4c72c2451b5 100644
--- a/docs/docs/api-reference/cloud-api-reference.mdx
+++ b/docs/docs/api-reference/cloud-api-reference.mdx
@@ -7,7 +7,7 @@ keywords:
- API
- API reference
sidebar_position: 14
-sidebar_label: Hasura Cloud API reference
+sidebar_label: Hasura Cloud API reference ☁️
sidebar_class_name: cloud-icon
---
diff --git a/docs/docs/api-reference/index.mdx b/docs/docs/api-reference/general-info.mdx
similarity index 96%
rename from docs/docs/api-reference/index.mdx
rename to docs/docs/api-reference/general-info.mdx
index ae716ee8980..24f19221bee 100644
--- a/docs/docs/api-reference/index.mdx
+++ b/docs/docs/api-reference/general-info.mdx
@@ -1,17 +1,16 @@
---
-description: Hasura API reference
+description: Hasura API reference general info
title: API Reference
keywords:
- hasura
- docs
- API
- API reference
-slug: index
+sidebar_position: 2
+sidebar_label: General Info
---
-import APIReference from '@site/static/icons/features/api_reference.svg';
-
-# API Reference
+# API Reference | General Info
## Available APIs
diff --git a/docs/docs/api-reference/graphql-api/_category_.json b/docs/docs/api-reference/graphql-api/_category_.json
index 8eeccac7539..81abb694873 100644
--- a/docs/docs/api-reference/graphql-api/_category_.json
+++ b/docs/docs/api-reference/graphql-api/_category_.json
@@ -1,4 +1,4 @@
{
"label": "GraphQL API",
- "position": 1
-}
\ No newline at end of file
+ "position": 2
+}
diff --git a/docs/docs/api-reference/kriti-templating.mdx b/docs/docs/api-reference/kriti-templating.mdx
index add4b018da6..b3410a4f7aa 100644
--- a/docs/docs/api-reference/kriti-templating.mdx
+++ b/docs/docs/api-reference/kriti-templating.mdx
@@ -44,7 +44,7 @@ At present, Kriti templating is available for:
- [Action REST Connectors](/actions/rest-connectors.mdx)
- [Event Triggers REST Connectors](/event-triggers/rest-connectors.mdx)
- [Cron Triggers REST Connectors](/scheduled-triggers/create-cron-trigger.mdx#rest-connectors)
-- [Dynamic Database Connection Routing](databases/connect-db/dynamic-db-connection.mdx#connection-template)
+- [Dynamic Database Connection Routing](databases/database-config/dynamic-db-connection.mdx#connection-template)
### Example
diff --git a/docs/docs/api-reference/overview.mdx b/docs/docs/api-reference/overview.mdx
new file mode 100644
index 00000000000..eecb3bbe2d7
--- /dev/null
+++ b/docs/docs/api-reference/overview.mdx
@@ -0,0 +1,78 @@
+---
+description: Hasura API reference
+title: API Reference
+keywords:
+ - hasura
+ - docs
+ - API
+ - API reference
+hide_table_of_contents: true
+sidebar_position: 1
+sidebar_label: Overview
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import APIReference from '@site/static/icons/features/api_reference.svg';
+
+# API Reference
+
+
+
+
+ The Hasura API reference is a comprehensive guide to the Hasura GraphQL Engine API. It is a great place to start
+ if you are building a client application that interacts with the Hasura GraphQL Engine API.
+
+
+ The API reference is divided into sections based on the type of API. Each section contains a list of API endpoints
+ and a description of the API endpoint.
+
+
Quick Links
+
+
+ Get started with the GraphQL API.
+
+
+ Learn more about the available APIs.
+
+
+
+
+
+
+## Using the APIs
+
+
+
+
+
Query / Subscription API
+
+ Learn more about using the Query API to fetch data from the database and the Subscription API to subscribe to
+ database events.
+
+
+
+
+
+
RESTified GraphQL Endpoints
+
+ See how you can use the RESTified GraphQL Endpoints API to fetch data from the database and to subscribe to
+ database events.
+
+
+
+
+
+
Common Syntax Definitions
+
+ Check out our common syntax definitions for the GraphQL API, RESTified GraphQL Endpoints API, and the Metadata
+ API.
+
+
+
+
diff --git a/docs/docs/api-reference/source-health.mdx b/docs/docs/api-reference/source-health.mdx
index 04e51368835..8b93f12da19 100644
--- a/docs/docs/api-reference/source-health.mdx
+++ b/docs/docs/api-reference/source-health.mdx
@@ -8,7 +8,7 @@ keywords:
- source health API
- API reference
sidebar_position: 14
-sidebar_label: Source Health Check API
+sidebar_label: Source Health Check API ☁️
sidebar_class_name: cloud-icon
---
diff --git a/docs/docs/auth/authentication/_category_.json b/docs/docs/auth/authentication/_category_.json
index 17fead0ade9..57cde766129 100644
--- a/docs/docs/auth/authentication/_category_.json
+++ b/docs/docs/auth/authentication/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Authentication",
- "position": 2
-}
\ No newline at end of file
+ "position": 4
+}
diff --git a/docs/docs/auth/authorization/_category_.json b/docs/docs/auth/authorization/_category_.json
index c84d0ee9b24..a47a3e9cbae 100644
--- a/docs/docs/auth/authorization/_category_.json
+++ b/docs/docs/auth/authorization/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Authorization",
- "position": 3
+ "position": 6
}
\ No newline at end of file
diff --git a/docs/docs/auth/authorization/index.mdx b/docs/docs/auth/authorization/index.mdx
index e923009c756..9021d520ca1 100644
--- a/docs/docs/auth/authorization/index.mdx
+++ b/docs/docs/auth/authorization/index.mdx
@@ -28,8 +28,8 @@ need to use in your authorization rules.
Authorization rules, or "Permissions", are defined by you in Hasura Engine. To control access to data, you create
permissions per role and table for each of the `select`, `insert`, `update` and `delete` database operations.
-Permissions can also be defined for [Actions](/actions/action-permissions.mdx) and
-[Remote Schemas](/remote-schemas/auth/remote-schema-permissions.mdx).
+Permissions can also be defined for [Actions](/actions/action-permissions.mdx) and
+[Remote Schemas](/remote-schemas/auth/remote-schema-permissions.mdx).
### Example
diff --git a/docs/docs/auth/index.mdx b/docs/docs/auth/how-it-works.mdx
similarity index 94%
rename from docs/docs/auth/index.mdx
rename to docs/docs/auth/how-it-works.mdx
index 9727730f71b..c49083fe840 100644
--- a/docs/docs/auth/index.mdx
+++ b/docs/docs/auth/how-it-works.mdx
@@ -1,14 +1,13 @@
---
-description: Manage GraphQL Authentication and Authorization with Hasura
+description: How GraphQL Authentication and Authorization works with Hasura
keywords:
- hasura
- docs
- authentication
- auth
- authorization
-slug: index
-title: Authentication and Authorization
-sidebar_position: 1
+title: How it works
+sidebar_position: 3
---
import Thumbnail from '@site/src/components/Thumbnail';
diff --git a/docs/docs/auth/overview.mdx b/docs/docs/auth/overview.mdx
new file mode 100644
index 00000000000..ce57cc67710
--- /dev/null
+++ b/docs/docs/auth/overview.mdx
@@ -0,0 +1,87 @@
+---
+description: Hasura Authentication and Authorization
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - actions
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Auth from '@site/static/icons/features/auth.svg';
+
+# Authentication and Authorization
+
+
+
+
+ Hasura gives you the power to authenticate users how you want, integrating with many popular auth services or your
+ own existing custom solution hosted elsewhere.
+
+
+ With Hasura, you can easily manage access to your data and APIs by defining roles and permissions. Hasura's fine-grained
+ access control system allows you to specify which users can access which data, Actions, and Remote Schema fields, ensuring
+ that your application is secure and robust.
+
+
+ Say goodbye to the headache of managing authentication and authorization and focus on building your application
+ with Hasura.
+
+
Quick Links
+
+
+ Get started with Auth in 60 seconds.
+
+
+ Learn how Auth works.
+
+
+
+
+
+
+
+
+## Using Auth
+
+
+
+
+
JWT Mode
+
+ With JWT Mode, Hasura can easily integrate with your existing authentication service and rapidly help you
+ configure granular access to your data.
+
+
+
+
+
+
Configuring Permissions
+
+ Regardless of the authentication mode you choose, Hasura provides a flexible permission system to control who
+ can access your data.
+
+
+
+
+
+
Roles and Session Variables
+
+ Using defined roles based on your custom configuration, you can enable permissions for your tables and views
+ based on the role of the user.
+
+
+
+
diff --git a/docs/docs/auth/quickstart.mdx b/docs/docs/auth/quickstart.mdx
new file mode 100644
index 00000000000..a9f5a6a56c4
--- /dev/null
+++ b/docs/docs/auth/quickstart.mdx
@@ -0,0 +1,259 @@
+---
+description: Quickstart Auth
+title: Quickstart Auth
+keywords:
+ - hasura
+ - docs
+ - actions
+ - quickstart
+ - guide
+ - tutorial
+sidebar_label: Quickstart
+sidebar_position: 2
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import Thumbnail from '@site/src/components/Thumbnail';
+import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
+import SampleAppBlock from '@site/src/components/SampleAppBlock';
+
+# Quickstart Auth
+
+In this quickstart, we'll use a JWT and permissions to limit a query to only the user making the request. We're using
+our sample app, which you can read more about below. If you don't use the sample app, you'll need to ensure your data
+model includes a `users` table and modify the values of the encoded and decoded JWT to match your user's information.
+
+
+
+## Step 1: Add an environment variable
+
+Depending on how your instance is deployed, you can either use the GUI or your configuration files to set this secret.
+
+
+
+
+Head to your Project's settings page and click on the Env vars option in the side navigation:
+
+
+
+Once there, click on New Env Var and select `HASURA_GRAPHQL_JWT_SECRET` from the `Key` field. Paste this value into the
+environment variable's value field:
+
+```json
+{
+ "key": "oursupersecretsupersecurekey1234567890",
+ "type": "HS256"
+}
+```
+
+Click `Add`:
+
+
+
+
+
+In your `docker-compose.yml`, add the following environment variable and value:
+
+```yaml
+HASURA_GRAPHQL_JWT_SECRET: '{ "type": "HS256", "key": "oursupersecretsupersecurekey1234567890" }'
+```
+
+If you don't already have a `users` table, add one with the following SQL using the `Data` tab's SQL editor:
+
+```sql
+CREATE TABLE users (
+ id uuid NOT NULL,
+ name text NOT NULL,
+ email text NOT NULL,
+ PRIMARY KEY (id)
+);
+```
+
+Then, insert these users:
+
+```sql
+INSERT INTO public.users (id, name, email) VALUES ('7cf0a66c-65b7-11ed-b904-fb49f034fbbb', 'Sean', 'seandemo@hasura.io');
+INSERT INTO public.users (id, name, email) VALUES ('82001336-65b7-11ed-b905-7fa26a16d198', 'Rob', 'robdemo@hasura.io');
+INSERT INTO public.users (id, name, email) VALUES ('86d5fba0-65b7-11ed-b906-afb985970e2e', 'Marion', 'mariondemo@hasura.io');
+INSERT INTO public.users (id, name, email) VALUES ('8dea1160-65b7-11ed-b907-e3c5123cb650', 'Sandeep', 'sandeepdemo@hasura.io');
+INSERT INTO public.users (id, name, email) VALUES ('9bd9d300-65b7-11ed-b908-571fef22d2ba', 'Abby', 'abbydemo@hasura.io');
+```
+
+
+
+
+## Step 2: Create a user role
+
+Head to the `Data` tab of the Hasura Console. If you have a `users` table, select it from the list on the left-hand
+side, and open the `Permissions` tab:
+
+
+
+As you can see, we currently only have an admin role. To make access to data more granular, we'll create a new role by
+entering `user` into the text input. After entering the name of the role, click the ❌ in the `select` column:
+
+
+
+Configure the `Row select permissions` by choosing `With custom check` and pasting the following value in the editor on
+line 1:
+
+```json
+{ "id": { "_eq": "X-Hasura-User-Id" } }
+```
+
+Configure the `Column select permissions` by clicking `Toggle All`:
+
+
+
+Finally, click `Save Permissions`.
+
+## Step 3: Add a header in the GraphiQL explorer
+
+Head back to the `API` tab and add a new row to the `Request Headers`. Enter this `key`:
+
+```plaintext
+Authorization
+```
+
+And this value:
+
+```plaintext
+Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IlNlYW4iLCJlbWFpbCI6InNlYW5kZW1vQGhhc3VyYS5pbyIsImlhdCI6MTUxNjIzOTAyMiwiaHR0cHM6Ly9oYXN1cmEuaW8vand0L2NsYWltcyI6eyJ4LWhhc3VyYS1hbGxvd2VkLXJvbGVzIjpbInVzZXIiLCJhZG1pbiJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6IjdjZjBhNjZjLTY1YjctMTFlZC1iOTA0LWZiNDlmMDM0ZmJiYiJ9fQ.jSp42PsCa4r-2ObfopkiDBvTn9nDysIv-NOIEnU3wR0
+```
+
+Check the box next to `Authorization`; the final result should look like this:
+
+
+
+## Step 4: Test it out
+
+Before demonstrating the access control you just designed, run the following query:
+
+```graphql
+query GetUsers {
+ users {
+ id
+ email
+ name
+ }
+}
+```
+
+You should see an array of 5 records returned:
+
+```json
+{
+ "data": {
+ "users": [
+ {
+ "id": "7cf0a66c-65b7-11ed-b904-fb49f034fbbb",
+ "email": "seandemo@hasura.io",
+ "name": "Sean"
+ },
+ {
+ "id": "82001336-65b7-11ed-b905-7fa26a16d198",
+ "email": "robdemo@hasura.io",
+ "name": "Rob"
+ },
+ {
+ "id": "86d5fba0-65b7-11ed-b906-afb985970e2e",
+ "email": "mariondemo@hasura.io",
+ "name": "Marion"
+ },
+ {
+ "id": "8dea1160-65b7-11ed-b907-e3c5123cb650",
+ "email": "sandeepdemo@hasura.io",
+ "name": "Sandeep"
+ },
+ {
+ "id": "9bd9d300-65b7-11ed-b908-571fef22d2ba",
+ "email": "abbydemo@hasura.io",
+ "name": "Abby"
+ }
+ ]
+ }
+}
+```
+
+Uncheck the `x-hasura-admin-secret` request header. Re-run the query; this time, your output should be similar to this:
+
+```json
+{
+ "data": {
+ "users": [
+ {
+ "id": "7cf0a66c-65b7-11ed-b904-fb49f034fbbb",
+ "email": "seandemo@hasura.io",
+ "name": "Sean"
+ }
+ ]
+ }
+}
+```
+
+:::tip Did you see that?!
+
+If you weren't watching closely, you may have missed it. When you deselected your admin secret in the request headers
+and used only the `authorization` header, the available schema changed to what you defined in step 2 🔥
+
+You can see that in the screenshot below, the only field available to the user is the `users` table:
+
+
+
+:::
+
+## Recap
+
+What did we just do? Well, you just implemented a JWT-based authorization system with Hasura 🎉
+
+Is this production-grade? Not quite. In a real-world application, you'd need to generate and verify the
+[JWTs](/auth/authentication/jwt.mdx) on the server-side. You'd also need to implement a mechanism to refresh the JWTs.
+What we've demonstrated is how Hasura utilizes the JWT to determine the role of the user and the
+[permissions](/auth/authorization/index.mdx) that they have access to.
+
+The environment variable we set up in the beginning contains a secret; this secret is used to encode your JWTs wherever
+they're generated, be it on your own server, a third-party service, or even a client-side library. Hasura is agnostic
+about how or where you generate your JWTs. Saving that secret as an environment variable allows Hasura to decode the
+JWTs and verify that they're valid.
+
+If you're curious about the composition of the JWT, you can view the decoded version one of two ways. By visiting
+[this link](https://jwt.io/#debugger-io?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IlNlYW4iLCJlbWFpbCI6InNlYW5kZW1vQGhhc3VyYS5pbyIsImlhdCI6MTUxNjIzOTAyMiwiaHR0cHM6Ly9oYXN1cmEuaW8vand0L2NsYWltcyI6eyJ4LWhhc3VyYS1hbGxvd2VkLXJvbGVzIjpbInVzZXIiLCJhZG1pbiJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6IjdjZjBhNjZjLTY1YjctMTFlZC1iOTA0LWZiNDlmMDM0ZmJiYiJ9fQ.FQJp6we0EFXWtmeqcM3-gAqxeNURL3Qa6AMDM6qv2NE),
+you can see the payload and other data associated with the JWT we used in this example. Alternatively, Hasura provides a
+JWT decoder tool that you can use to decode any JWT. You can utilize this by clicking the "detective" icon next to the
+`Authorization` header's value in the GraphiQL explorer.
+
+The permissions we set up in step 2 are the most basic form of access control. We created a new role called `user` and
+limited the rows returned on the `users` table to only those whose `id` matches the `x-hasura-user-id` claim in the JWT.
+
+As you can see from the example, Hasura automatically provides a schema that only exposes the `users` table to the
+`user` role. This is a great way to limit the exposure of your data to the outside world and ensure that your users only
+have access to the data they're authorized to see.
diff --git a/docs/docs/data-federation/apollo-federation.mdx b/docs/docs/data-federation/apollo-federation.mdx
index 5fbf274bb2a..def79bc1d6e 100644
--- a/docs/docs/data-federation/apollo-federation.mdx
+++ b/docs/docs/data-federation/apollo-federation.mdx
@@ -1,6 +1,6 @@
---
sidebar_label: Apollo Federation
-sidebar_position: 3
+sidebar_position: 4
description: Use Hasura as a subgraph in an Apollo gateway
keywords:
- hasura
diff --git a/docs/docs/data-federation/data-federation-types.mdx b/docs/docs/data-federation/data-federation-types.mdx
index a2b9706f054..41d6ad18bde 100644
--- a/docs/docs/data-federation/data-federation-types.mdx
+++ b/docs/docs/data-federation/data-federation-types.mdx
@@ -1,6 +1,6 @@
---
sidebar_label: Data federation types
-sidebar_position: 2
+sidebar_position: 3
description: Join data across remote data sources
keywords:
- hasura
diff --git a/docs/docs/data-federation/index.mdx b/docs/docs/data-federation/index.mdx
deleted file mode 100644
index 4e79058e77e..00000000000
--- a/docs/docs/data-federation/index.mdx
+++ /dev/null
@@ -1,33 +0,0 @@
----
-sidebar_label: Data Federation
-sidebar_position: 1
-description: Join data across remote data sources
-title: Data Federation
-keywords:
- - hasura
- - docs
- - remote join
- - data federation
-slug: index
----
-
-import DataFederation from '@site/static/icons/features/data_federation.svg';
-
-# Data Federation
-
-## Introduction
-
-Hasura’s data federation capabilities allow you to compose data from different sources that reside in independent data
-stores but are semantically related. This is done by creating a single GraphQL schema from multiple data sources thereby
-making the data access process self-serve, allowing you to query, mutate or federate real-time and stream data across
-services without writing any custom code.
-
-The remote data sources can either be a table from a [database source](/databases/index.mdx), a GraphQL API added as a
-[Remote Schema](/remote-schemas/index.mdx), or a REST API added as an [action](/actions/index.mdx). Once you create
-relationships between types from your database tables, Remote Schemas and actions, you can then "join" data across them
-by running GraphQL queries.
-
-## Explore data federation
-
-- [Explore data federation types](/data-federation/data-federation-types.mdx)
-- [Using hasura in Apollo federated gateway](/data-federation/apollo-federation.mdx)
diff --git a/docs/docs/data-federation/overview.mdx b/docs/docs/data-federation/overview.mdx
new file mode 100644
index 00000000000..0e6c266803c
--- /dev/null
+++ b/docs/docs/data-federation/overview.mdx
@@ -0,0 +1,67 @@
+---
+description: Hasura Data Federation
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - data
+ - federation
+ - data federation
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import DataFederation from '@site/static/icons/features/data_federation.svg';
+
+# Data Federation
+
+
+
+
+ Hasura's data federation capabilities allow you to compose data from different sources that reside in independent
+ data stores but are semantically related.
+
+
+ Hasura creates a single GraphQL schema from multiple data sources thereby making the data access process
+ self-serve, allowing you to query, mutate or federate real-time and stream data across services without writing
+ any custom code.
+
+
Quick Links
+
+
+ Learn about data federation types.
+
+
+
+
+
+
+## Using Data Federation
+
+
+
+
+
Create a Database-to-Remote-Database Relationship
+
Learn how to create a database-to-database relationship using remote relationships.
+
+
+
+
+
Create a Database-to-Remote-Schema Relationship
+
Learn how to create a database-to-remote-schema relationship using remote relationships.
+
+
+
+
+
Apollo Federation
+
Learn how to use Apollo Federation to compose data from multiple sources using Hasura.
+
+
+
diff --git a/docs/docs/databases/connect-db/_category_.json b/docs/docs/databases/connect-db/_category_.json
deleted file mode 100644
index 2fa56d1f076..00000000000
--- a/docs/docs/databases/connect-db/_category_.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "label": "Connecting databases",
- "position": 1
-}
\ No newline at end of file
diff --git a/docs/docs/databases/connect-db/cloud-databases/_category_.json b/docs/docs/databases/connect-db/cloud-databases/_category_.json
deleted file mode 100644
index 9c3927815f4..00000000000
--- a/docs/docs/databases/connect-db/cloud-databases/_category_.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "label": "Cloud database guides",
- "position": 1
-}
diff --git a/docs/docs/databases/connect-db/cloud-databases/index.mdx b/docs/docs/databases/connect-db/cloud-databases/index.mdx
deleted file mode 100644
index 0d9b9ccb197..00000000000
--- a/docs/docs/databases/connect-db/cloud-databases/index.mdx
+++ /dev/null
@@ -1,191 +0,0 @@
----
-description: Use an existing database with Hasura Cloud
-title: 'Cloud: Guides for connecting Hasura Cloud with different cloud databases'
-keywords:
- - hasura
- - cloud databases
- - docs
- - existing database
-slug: index
----
-
-import HeadingIcon from '@site/src/components/HeadingIcon';
-import useBaseUrl from '@docusaurus/useBaseUrl';
-import VersionedLink from '@site/src/components/VersionedLink';
-import ArrowRight from '@site/static/icons/arrow_right.svg';
-import Aiven from '@site/static/img/cloud-dbs/logos/aiven.png';
-import Alloy from '@site/static/img/cloud-dbs/logos/alloydb.png';
-import Aurora from '@site/static/img/cloud-dbs/logos/aws-aurora.png';
-import Azure from '@site/static/img/cloud-dbs/logos/azure.png';
-import Cosmos from '@site/static/img/cloud-dbs/logos/cosmos.png';
-import RDS from '@site/static/img/cloud-dbs/logos/aws.png';
-import RollTide from '@site/static/img/cloud-dbs/logos/crunchy.png';
-import DO from '@site/static/img/cloud-dbs/logos/DO.png';
-import Elephant from '@site/static/img/cloud-dbs/logos/elephant.png';
-import Enterprise from '@site/static/img/cloud-dbs/logos/enterprisedb.png';
-import GCP from '@site/static/img/cloud-dbs/logos/gcp.png';
-import MSSQL from '@site/static/img/cloud-dbs/logos/mssql.png';
-import Neon from '@site/static/img/cloud-dbs/logos/neon.png';
-import Railway from '@site/static/img/cloud-dbs/logos/railway.png';
-import Render from '@site/static/img/cloud-dbs/logos/render.png';
-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 with Different Cloud Databases
-
-## Overview
-
-Check out the following guides for tutorials on how to use Hasura with a new or existing database provided by
-specific cloud vendors.
-
-
-
-
-
-
-
-
Aiven
-
-
-
-
-
-
-
-
AlloyDB
-
-
-
-
-
-
-
-
AWS RDS Aurora Postgres
-
-
-
-
-
-
-
-
AWS RDS Postgres
-
-
-
-
-
-
-
-
Azure Cosmos
-
-
-
-
-
-
-
-
Azure MS SQL
-
-
-
-
-
-
-
-
Azure Postgres
-
-
-
-
-
-
-
-
Crunchy Postgres
-
-
-
-
-
-
-
-
DigitalOcean Postgres
-
-
-
-
-
-
-
-
ElephantSQL
-
-
-
-
-
-
-
-
EnterpriseDB
-
-
-
-
-
-
-
-
GCP Postgres
-
-
-
-
-
-
-
-
Neon Postgres
-
-
-
-
-
-
-
-
Railway Postgres
-
-
-
-
-
-
-
-
Render Postgres
-
-
-
-
-
-
-
-
Supabase Postgres
-
-
-
-
-
-
-
-
TimescaleDB
-
-
-
-
-
-
-
-
YugabyteDB
-
-
-
diff --git a/docs/docs/databases/database-config/_category_.json b/docs/docs/databases/database-config/_category_.json
new file mode 100644
index 00000000000..4e4a6b61b05
--- /dev/null
+++ b/docs/docs/databases/database-config/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Database Config",
+ "position": 1.5
+}
\ No newline at end of file
diff --git a/docs/docs/databases/connect-db/cloud-connection-pooling.mdx b/docs/docs/databases/database-config/cloud-connection-pooling.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-connection-pooling.mdx
rename to docs/docs/databases/database-config/cloud-connection-pooling.mdx
index bff9140f118..8af43846992 100644
--- a/docs/docs/databases/connect-db/cloud-connection-pooling.mdx
+++ b/docs/docs/databases/database-config/cloud-connection-pooling.mdx
@@ -9,7 +9,7 @@ keywords:
- connection
- pools
- autoscaling
-sidebar_label: Elastic connection pools
+sidebar_label: Elastic connection pools ☁️
sidebar_position: 2
sidebar_class_name: cloud-icon
---
diff --git a/docs/docs/databases/connect-db/dynamic-db-connection.mdx b/docs/docs/databases/database-config/dynamic-db-connection.mdx
similarity index 98%
rename from docs/docs/databases/connect-db/dynamic-db-connection.mdx
rename to docs/docs/databases/database-config/dynamic-db-connection.mdx
index c782b298026..bfcd5a42e51 100644
--- a/docs/docs/databases/connect-db/dynamic-db-connection.mdx
+++ b/docs/docs/databases/database-config/dynamic-db-connection.mdx
@@ -14,7 +14,7 @@ keywords:
- routing
- connections
- pool
-sidebar_label: Dynamic DB connection routing
+sidebar_label: Dynamic DB connection routing ☁️🏢
sidebar_position: 3
sidebar_class_name: cloud-and-enterprise-icon
---
@@ -400,7 +400,7 @@ differs in the Postgres schema from the primary connection.
### Event Triggers
-[Hasura Event Triggers](/event-triggers/index.mdx) are triggered only for mutations executed on the primary connection.
+[Hasura Event Triggers](/event-triggers/overview.mdx) are triggered only for mutations executed on the primary connection.
Mutations routed to the members of the connection set will not trigger Event Triggers.
### Migrations
diff --git a/docs/docs/databases/connect-db/index.mdx b/docs/docs/databases/database-config/index.mdx
similarity index 94%
rename from docs/docs/databases/connect-db/index.mdx
rename to docs/docs/databases/database-config/index.mdx
index 8f3a34d8bd0..634b04501c9 100644
--- a/docs/docs/databases/connect-db/index.mdx
+++ b/docs/docs/databases/database-config/index.mdx
@@ -43,7 +43,7 @@ button to open the Hasura Console in your browser.
Hasura Cloud does not host databases, but does provide integrations with which you can connect databases from
many 3rd party managed cloud providers. Check out a
-[list of supported databases here](/databases/index.mdx#supported-databases).
+[list of supported databases here](/databases/overview.mdx).
To get started quickly with a Postgres database, choose `Create New Database`:
@@ -53,7 +53,7 @@ To get started quickly with a Postgres database, choose `Create New Database`:
database"
/>
-Follow the prompts or [check out our detailed Neon connect page](/databases/connect-db/cloud-databases/neon.mdx).
+Follow the prompts or [check out our detailed Neon connect page](/databases/postgres/neon.mdx).
Hasura Cloud will integrate with your Neon account and manage the initial setup of a Postgres instance. You can
always upgrade the instance and manage options later through your Neon account.
@@ -63,8 +63,7 @@ To use an existing database, choose `Connect existing database` and enter your d
database connection string.
For help finding your particular connection string for your database provider check out our
-[supported databases](/databases/index.mdx#supported-databases) and
-[cloud providers](/databases/connect-db/cloud-databases/index.mdx) pages.
+[databases page](/databases/overview.mdx).
@@ -205,7 +204,7 @@ Hasura Metadata is stored on the same database as specified in the `HASURA_GRAPH
## Connect different Hasura instances to the same database
You can connect different Hasura instances (i.e. instances with different Metadata) to the same database as long as
-there are no [Event Triggers](/event-triggers/index.mdx) in any of the Metadata. Event Triggers store their data in the
+there are no [Event Triggers](/event-triggers/overview.mdx) in any of the Metadata. Event Triggers store their data in the
underlying database and hence different instances acting on the same data can cause undefined behavior during
run-time. This should not be a problem if the Hasura instances have the same Metadata.
@@ -219,4 +218,4 @@ To connect multiple Hasura instances to the same database, simply follow the ste
## More databases
Support for more databases is coming soon. Stay up to date with
-[supported databases here](/databases/index.mdx#supported-databases).
+[supported databases here](/databases/overview.mdx).
diff --git a/docs/docs/databases/connect-db/read-replicas.mdx b/docs/docs/databases/database-config/read-replicas.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/read-replicas.mdx
rename to docs/docs/databases/database-config/read-replicas.mdx
index 9cc646c5c2a..6024b699369 100644
--- a/docs/docs/databases/connect-db/read-replicas.mdx
+++ b/docs/docs/databases/database-config/read-replicas.mdx
@@ -9,7 +9,7 @@ keywords:
- read replicas
- connections
- pool
-sidebar_label: Read replicas
+sidebar_label: Read replicas ☁️🏢
sidebar_position: 1
sidebar_class_name: cloud-and-enterprise-icon
---
diff --git a/docs/docs/databases/index.mdx b/docs/docs/databases/feature-support.mdx
similarity index 81%
rename from docs/docs/databases/index.mdx
rename to docs/docs/databases/feature-support.mdx
index 460a20fa6f9..c6eda5f1b95 100644
--- a/docs/docs/databases/index.mdx
+++ b/docs/docs/databases/feature-support.mdx
@@ -1,50 +1,45 @@
---
-title: Databases
-description: Hasura databases support
+description: Database feature support
+sidebar_label: Feature Support
keywords:
- hasura
- docs
- databases
-slug: index
+ - feature support
+sidebar_position: 1.3
---
-import Databases from '@site/static/icons/features/database.svg';
+import VersionedLink from '@site/src/components/VersionedLink';
+import PostgreSQL from '@site/static/img/databases/logos/postgresql.png';
+import SQLServer from '@site/static/img/databases/logos/sql-server.png';
+import BigQuery from '@site/static/img/databases/logos/bigquery.png';
+import MySQL from '@site/static/img/databases/logos/mysql.png';
+import Snowflake from '@site/static/img/databases/logos/snowflake.png';
+import AmazonAthena from '@site/static/img/databases/logos/amazon-athena.png';
-# Databases
+import HeadingIcon from '@site/src/components/HeadingIcon';
+import useBaseUrl from '@docusaurus/useBaseUrl';
+import ArrowRight from '@site/static/icons/arrow_right.svg';
+import Aiven from '@site/static/img/cloud-dbs/logos/aiven.png';
+import Alloy from '@site/static/img/cloud-dbs/logos/alloydb.png';
+import Aurora from '@site/static/img/cloud-dbs/logos/aws-aurora.png';
+import Azure from '@site/static/img/cloud-dbs/logos/azure.png';
+import Cosmos from '@site/static/img/cloud-dbs/logos/cosmos.png';
+import RDS from '@site/static/img/cloud-dbs/logos/aws.png';
+import RollTide from '@site/static/img/cloud-dbs/logos/crunchy.png';
+import DO from '@site/static/img/cloud-dbs/logos/DO.png';
+import Elephant from '@site/static/img/cloud-dbs/logos/elephant.png';
+import Enterprise from '@site/static/img/cloud-dbs/logos/enterprisedb.png';
+import GCP from '@site/static/img/cloud-dbs/logos/gcp.png';
+import MSSQL from '@site/static/img/cloud-dbs/logos/mssql.png';
+import Neon from '@site/static/img/cloud-dbs/logos/neon.png';
+import Railway from '@site/static/img/cloud-dbs/logos/railway.png';
+import Render from '@site/static/img/cloud-dbs/logos/render.png';
+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';
-## Introduction
-
-The Hasura GraphQL Engine automatically generates your GraphQL schema and resolvers based on tables/views in your
-database . **You don't need to write a GraphQL schema or resolvers.** See
-[How Hasura GraphQL Engine works](/getting-started/how-it-works/index.mdx) for more details.
-
-The Hasura Console gives you UI tools that speed up your data-modeling process, or working with your existing databases.
-The Console also automatically generates Migrations or Metadata files that you can edit directly and check into your
-version control.
-
-## Supported databases
-
-Hasura GraphQL Engine supports:
-
-- [Postgres & Postgres compatible flavours](/databases/postgres/index.mdx)
-- [MS SQL Server](/databases/ms-sql-server/index.mdx)
-- [Citus / Hyperscale](/databases/postgres/citus-hyperscale-postgres/index.mdx)
-- [CockroachDB](/databases/postgres/cockroachdb/index.mdx)
-- [BigQuery](/databases/bigquery/index.mdx)
-- [Snowflake](/databases/snowflake/index.mdx)
-- [Amazon Athena](/databases/athena/index.mdx)
-- [MySQL Alpha](/databases/mysql/index.mdx)
-
-Hasura also [supports many other cloud database services](/databases/connect-db/cloud-databases/index.mdx).
-
-:::tip Tip
-
-Although it is safe to use Hasura with a serverless database, caution must be maintained because some functionalities -
-such as subscriptions or Event Triggers - will force a serverless database to be always on.
-
-:::
-
-### Feature support
+# Database Feature Support
The below matrices show the database wise support for the different GraphQL features under schema, queries, mutations
and subscriptions.
@@ -55,7 +50,7 @@ Each ✅ below links **directly** to the feature within a particular type of dat
:::
-#### Schema
+## Schema
diff --git a/docs/docs/databases/connect-db/cloud-databases/mssql.mdx b/docs/docs/databases/ms-sql-server/mssql.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-databases/mssql.mdx
rename to docs/docs/databases/ms-sql-server/mssql.mdx
index 4484f19f17b..cfcff8b5b64 100644
--- a/docs/docs/databases/connect-db/cloud-databases/mssql.mdx
+++ b/docs/docs/databases/ms-sql-server/mssql.mdx
@@ -182,6 +182,6 @@ Voilà. You are ready to start developing.
:::info Note
For more information on which SQL Server features we support, check out
-[this page](/databases/index.mdx#feature-support)!
+[this page]/databases/supported-databases.mdx).
:::
diff --git a/docs/docs/databases/mysql/_category_.json b/docs/docs/databases/mysql/_category_.json
index 389d373243e..1ee1f0b5f89 100644
--- a/docs/docs/databases/mysql/_category_.json
+++ b/docs/docs/databases/mysql/_category_.json
@@ -1,5 +1,5 @@
{
"label": "MySQL",
- "position": 5,
+ "position": 100,
"className": "alpha-cat"
}
diff --git a/docs/docs/databases/mysql/cloud.mdx b/docs/docs/databases/mysql/cloud.mdx
index 38fb1d56ea2..eeed46aab61 100644
--- a/docs/docs/databases/mysql/cloud.mdx
+++ b/docs/docs/databases/mysql/cloud.mdx
@@ -21,7 +21,7 @@ import Thumbnail from '@site/src/components/Thumbnail';
## Introduction
-This guide will help you get set up with [Hasura Cloud](/hasura-cloud/index.mdx) and our MySQL integration. This is
+This guide will help you get set up with [Hasura Cloud](/hasura-cloud/overview.mdx) and our MySQL integration. This is
the easiest way to set up Hasura Engine and the MySQL GraphQL Data Connector.
:::tip Supported versions:
@@ -29,7 +29,7 @@ the easiest way to set up Hasura Engine and the MySQL GraphQL Data Connector.
1. Hasura GraphQL Engine `v2.19.0` onwards
2. MySQL version 8.0 and higher
3. Currently only standard implementations of MySQL are supported. PlanetScale and certain other providers are
-unsupported.
+ unsupported.
:::
@@ -49,16 +49,20 @@ create a new Hasura Cloud account.
Once you create a project on Hasura Cloud, hit the "Launch Console" button to open the Hasura Console for your project.
-
+
-### Step 2: Connect to a MySQL database
+### Step 2: Connect to a MySQL database
From the Console, click the `Data` tab:
-Select the MySQL (Alpha) data source driver. Enter a database display name and the JDBC Connection URL for your
-MySQL instance.
+Select the MySQL (Alpha) data source driver. Enter a database display name and the JDBC Connection URL for your MySQL
+instance.
The JDBC connection URL should look like this:
@@ -67,27 +71,26 @@ jdbc:mysql://:/?user=&password=
HASURA_GRAPHQL_ADMIN_SECRET:
-...
```
:::caution Secure the admin secret
The `HASURA_GRAPHQL_ADMIN_SECRET` should never be passed from the client to the Hasura GraphQL Engine as it would give
-the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/index.mdx) for
+the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/overview.mdx) for
information on setting up auth in Hasura.
:::
@@ -117,17 +116,17 @@ b0b1aac0508d postgres ... 1m ago Up 1m 5432/tcp ...
### Step 5: Load the Hasura Console
-Open the Hasura Console by navigating to `http://localhost:8080/console`. You will need to input your admin secret
-key as set in your Docker Compose file to log in.
+Open the Hasura Console by navigating to `http://localhost:8080/console`. You will need to input your admin secret key
+as set in your Docker Compose file to log in.
-### Step 6: Connect to a MySQL database
+### Step 6: Connect to a MySQL database
From the Console, click the `Data` tab:
-Select the MySQL (Alpha) data source driver, enter in a display name for the database and set the JDBC Connection
-URL for your MySQL instance.
+Select the MySQL (Alpha) data source driver, enter in a display name for the database and set the JDBC Connection URL
+for your MySQL instance.
The JDBC connection URL should look like this:
@@ -136,13 +135,14 @@ jdbc:mysql://:/?user=&password= Databases
+
+
+
+
+ The Hasura GraphQL Engine can connect to a wide range of databases in order to generate a full featured data
+ API for you automatically, without needing to write handlers, schemas or resolvers.
+
+
+ Hasura can connect to your existing databases or you can create new databases and connect to, and manage them
+ with Hasura Engine.
+
+
Quick Links
+
+
+ Get started with databases in 60 seconds.
+
+
+ Check Hasura feature support for databases.
+
+
+
+
+
+
+
+## Supported databases
+
+
+
+
+
+
+
+
Postgres & Compatible
+
+
+
+
+
+
+
+
Microsoft SQL Server
+
+
+
+
+
+
+
+
Google BigQuery
+
+
+
+
+
+
+
+
Amazon Athena
+
+
+
+
+
+
+
+
Snowflake
+
+
+
+
+
+
+
+
MySQL (Alpha)
+
+
+
+
+## Using Databases
+
+
+
+
+
Connect to a Neon Serverless Postgres Database
+
Create a database with our partners at Neon with a generous free starter tier.
+
+
+
+
+
Connect to a BigQuery Database
+
Utilize Google's leading enterprise data warehouse platform.
+
+
+
+
+
Connect to a MySQL Database
+
The world's most popular open source database. Currently in Alpha preview.
+
+
+
diff --git a/docs/docs/databases/postgres/_category_.json b/docs/docs/databases/postgres/_category_.json
index 541c4402eec..4633e497893 100644
--- a/docs/docs/databases/postgres/_category_.json
+++ b/docs/docs/databases/postgres/_category_.json
@@ -1,4 +1,4 @@
{
- "label": "Postgres",
+ "label": "Postgres & Compatible",
"position": 2
}
diff --git a/docs/docs/databases/connect-db/cloud-databases/aiven.mdx b/docs/docs/databases/postgres/aiven.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-databases/aiven.mdx
rename to docs/docs/databases/postgres/aiven.mdx
index ab7979186b8..7c3a055b252 100644
--- a/docs/docs/databases/connect-db/cloud-databases/aiven.mdx
+++ b/docs/docs/databases/postgres/aiven.mdx
@@ -158,6 +158,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/alloy.mdx b/docs/docs/databases/postgres/alloy.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-databases/alloy.mdx
rename to docs/docs/databases/postgres/alloy.mdx
index 5490bac31cc..113bcea3773 100644
--- a/docs/docs/databases/connect-db/cloud-databases/alloy.mdx
+++ b/docs/docs/databases/postgres/alloy.mdx
@@ -230,6 +230,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/aws-aurora.mdx b/docs/docs/databases/postgres/aws-aurora.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-databases/aws-aurora.mdx
rename to docs/docs/databases/postgres/aws-aurora.mdx
index 5410b072625..bbe0a02899c 100644
--- a/docs/docs/databases/connect-db/cloud-databases/aws-aurora.mdx
+++ b/docs/docs/databases/postgres/aws-aurora.mdx
@@ -203,6 +203,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/aws-postgres.mdx b/docs/docs/databases/postgres/aws-postgres.mdx
similarity index 96%
rename from docs/docs/databases/connect-db/cloud-databases/aws-postgres.mdx
rename to docs/docs/databases/postgres/aws-postgres.mdx
index ea9c039b324..1ae011abe53 100644
--- a/docs/docs/databases/connect-db/cloud-databases/aws-postgres.mdx
+++ b/docs/docs/databases/postgres/aws-postgres.mdx
@@ -104,7 +104,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 {#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).
+selected or added in [step 3](/databases/postgres/aws-postgres.mdx#create-aws-rds-postgres-db).
@@ -202,6 +202,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/azure-cosmos.mdx b/docs/docs/databases/postgres/azure-cosmos.mdx
similarity index 98%
rename from docs/docs/databases/connect-db/cloud-databases/azure-cosmos.mdx
rename to docs/docs/databases/postgres/azure-cosmos.mdx
index cba77d66cd5..d07d49a79a3 100644
--- a/docs/docs/databases/connect-db/cloud-databases/azure-cosmos.mdx
+++ b/docs/docs/databases/postgres/azure-cosmos.mdx
@@ -117,6 +117,6 @@ Voilà. You are ready to start developing.
:::info Note
For more information on which Azure Cosmos DB features we support, check out
-[this page](/databases/index.mdx#feature-support)!
+[this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/azure.mdx b/docs/docs/databases/postgres/azure.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-databases/azure.mdx
rename to docs/docs/databases/postgres/azure.mdx
index a0193f6d4ff..6a8145bded4 100644
--- a/docs/docs/databases/connect-db/cloud-databases/azure.mdx
+++ b/docs/docs/databases/postgres/azure.mdx
@@ -170,6 +170,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/crunchy.mdx b/docs/docs/databases/postgres/crunchy.mdx
similarity index 98%
rename from docs/docs/databases/connect-db/cloud-databases/crunchy.mdx
rename to docs/docs/databases/postgres/crunchy.mdx
index 3c430d5924f..dfa8848c08c 100644
--- a/docs/docs/databases/connect-db/cloud-databases/crunchy.mdx
+++ b/docs/docs/databases/postgres/crunchy.mdx
@@ -146,6 +146,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/digital-ocean.mdx b/docs/docs/databases/postgres/digital-ocean.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-databases/digital-ocean.mdx
rename to docs/docs/databases/postgres/digital-ocean.mdx
index 0083d8a7640..cd46c26a49b 100644
--- a/docs/docs/databases/connect-db/cloud-databases/digital-ocean.mdx
+++ b/docs/docs/databases/postgres/digital-ocean.mdx
@@ -159,6 +159,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/elephant.mdx b/docs/docs/databases/postgres/elephant.mdx
similarity index 98%
rename from docs/docs/databases/connect-db/cloud-databases/elephant.mdx
rename to docs/docs/databases/postgres/elephant.mdx
index 46ab8c42981..8d8fb6a9163 100644
--- a/docs/docs/databases/connect-db/cloud-databases/elephant.mdx
+++ b/docs/docs/databases/postgres/elephant.mdx
@@ -146,6 +146,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/enterprisedb.mdx b/docs/docs/databases/postgres/enterprisedb.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-databases/enterprisedb.mdx
rename to docs/docs/databases/postgres/enterprisedb.mdx
index 90cd0b7b20b..1c7c17ca807 100644
--- a/docs/docs/databases/connect-db/cloud-databases/enterprisedb.mdx
+++ b/docs/docs/databases/postgres/enterprisedb.mdx
@@ -175,6 +175,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/gcp.mdx b/docs/docs/databases/postgres/gcp.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-databases/gcp.mdx
rename to docs/docs/databases/postgres/gcp.mdx
index 2640d3318c0..42602fa913c 100644
--- a/docs/docs/databases/connect-db/cloud-databases/gcp.mdx
+++ b/docs/docs/databases/postgres/gcp.mdx
@@ -224,6 +224,6 @@ Finally, click on the `Update Connection` button to apply the SSL settings.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/heroku.mdx b/docs/docs/databases/postgres/heroku.mdx
similarity index 97%
rename from docs/docs/databases/connect-db/cloud-databases/heroku.mdx
rename to docs/docs/databases/postgres/heroku.mdx
index 7202031fcc5..07d5ad3d590 100644
--- a/docs/docs/databases/connect-db/cloud-databases/heroku.mdx
+++ b/docs/docs/databases/postgres/heroku.mdx
@@ -39,7 +39,7 @@ If you are interested in connecting to a Heroku database, our
Hasura works well with popular database providers. Most of these providers offer generous free tiers. We have guides you
can use to provision and connect a new database in a matter of minutes. You can check them out
-[here](/databases/connect-db/cloud-databases/index.mdx).
+[here](/databases/overview.mdx).
If you're interested in migrating away from Heroku, our different cloud database providers have guides and documentation
to help you:
@@ -109,6 +109,6 @@ to help you:
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/postgres/index.mdx b/docs/docs/databases/postgres/index.mdx
index 3ebdb9e9f54..2be071768e6 100644
--- a/docs/docs/databases/postgres/index.mdx
+++ b/docs/docs/databases/postgres/index.mdx
@@ -8,7 +8,27 @@ keywords:
slug: index
---
-# Postgres
+import VersionedLink from '@site/src/components/VersionedLink';
+import Aiven from '@site/static/img/cloud-dbs/logos/aiven.png';
+import Alloy from '@site/static/img/cloud-dbs/logos/alloydb.png';
+import Aurora from '@site/static/img/cloud-dbs/logos/aws-aurora.png';
+import Azure from '@site/static/img/cloud-dbs/logos/azure.png';
+import Cosmos from '@site/static/img/cloud-dbs/logos/cosmos.png';
+import RDS from '@site/static/img/cloud-dbs/logos/aws.png';
+import RollTide from '@site/static/img/cloud-dbs/logos/crunchy.png';
+import DO from '@site/static/img/cloud-dbs/logos/DO.png';
+import Elephant from '@site/static/img/cloud-dbs/logos/elephant.png';
+import Enterprise from '@site/static/img/cloud-dbs/logos/enterprisedb.png';
+import GCP from '@site/static/img/cloud-dbs/logos/gcp.png';
+import Postgres from '@site/static/img/databases/logos/postgresql.png';
+import Neon from '@site/static/img/cloud-dbs/logos/neon.png';
+import Railway from '@site/static/img/cloud-dbs/logos/railway.png';
+import Render from '@site/static/img/cloud-dbs/logos/render.png';
+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';
+
+# Postgres & Compatible Databases
## Introduction
@@ -22,26 +42,169 @@ Hasura GraphQL Engine supports all supported versions of Postgres per the
:::
-## Postgres compatibility & flavors {#postgres-compatible-flavors}
+## Postgres compatible {#postgres-compatible-flavors}
Hasura supports most databases with full Postgres compatibility such as:
-- [Yugabyte](https://www.yugabyte.com/)
-- [Timescale](https://www.timescale.com/)
-- [Citus](https://www.citusdata.com/)
-- [CockroachDB](https://www.cockroachlabs.com/product/)
-- [Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.AuroraPostgreSQL.html)
-- [RDS](https://aws.amazon.com/rds/postgresql/)
-- [Crunchy](https://www.crunchydata.com/)
-- [AlloyDB](https://cloud.google.com/alloydb)
-- [Neon](https://neon.tech/)
-- [CosmosDB](https://azure.microsoft.com/en-gb/products/cosmos-db/)
+
+
+
+
+
+
+
Postgres
+
+
+
+
+
+
+
+
Aiven
+
+
+
+
+
+
+
+
AlloyDB
+
+
+
+
+
+
+
+
AWS RDS Aurora Postgres
+
+
+
+
+
+
+
+
AWS RDS Postgres
+
+
+
+
+
+
+
+
Azure Cosmos
+
+
+
+
+
+
+
+
Azure Postgres
+
+
+
+
+
+
+
+
Crunchy Postgres
+
+
+
+
+
+
+
+
Digital Ocean Postgres
+
+
+
+
+
+
+
+
ElephantSQL
+
+
+
+
+
+
+
+
EnterpriseDB
+
+
+
+
+
+
+
+
GCP Postgres
+
+
+
+
+
+
+
+
Neon Postgres
+
+
+
+
+
+
+
+
Railway Postgres
+
+
+
+
+
+
+
+
Render Postgres
+
+
+
+
+
+
+
+
Supabase Postgres
+
+
+
+
+
+
+
+
TimescaleDB
+
+
+
+
+
+
+
+
YugabyteDB
+
+
+
-Hasura also [supports many other cloud database services](/databases/connect-db/cloud-databases/index.mdx).
+:::tip Other Postgres flavors
-Curious about any other Postgres flavours? Any other questions? Ask us on
+Curious about any other Postgres flavors? Any other questions? Ask us on
[GitHub discussions](https://github.com/hasura/graphql-engine/discussions)
+:::
+
+
## Know more
- [Schema](/schema/postgres/index.mdx)
diff --git a/docs/docs/databases/connect-db/cloud-databases/neon.mdx b/docs/docs/databases/postgres/neon.mdx
similarity index 98%
rename from docs/docs/databases/connect-db/cloud-databases/neon.mdx
rename to docs/docs/databases/postgres/neon.mdx
index cdb0a7a5087..382a1b1ca68 100644
--- a/docs/docs/databases/connect-db/cloud-databases/neon.mdx
+++ b/docs/docs/databases/postgres/neon.mdx
@@ -116,6 +116,6 @@ the Hasura Console.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/railway.mdx b/docs/docs/databases/postgres/railway.mdx
similarity index 98%
rename from docs/docs/databases/connect-db/cloud-databases/railway.mdx
rename to docs/docs/databases/postgres/railway.mdx
index ee4ad769d79..676c9710b79 100644
--- a/docs/docs/databases/connect-db/cloud-databases/railway.mdx
+++ b/docs/docs/databases/postgres/railway.mdx
@@ -127,6 +127,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/render.mdx b/docs/docs/databases/postgres/render.mdx
similarity index 98%
rename from docs/docs/databases/connect-db/cloud-databases/render.mdx
rename to docs/docs/databases/postgres/render.mdx
index a5bb036a111..db7e6dc75df 100644
--- a/docs/docs/databases/connect-db/cloud-databases/render.mdx
+++ b/docs/docs/databases/postgres/render.mdx
@@ -119,6 +119,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/supabase.mdx b/docs/docs/databases/postgres/supabase.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-databases/supabase.mdx
rename to docs/docs/databases/postgres/supabase.mdx
index d9d1e0a279a..d892e297457 100644
--- a/docs/docs/databases/connect-db/cloud-databases/supabase.mdx
+++ b/docs/docs/databases/postgres/supabase.mdx
@@ -178,6 +178,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/timescale-cloud.mdx b/docs/docs/databases/postgres/timescale-cloud.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-databases/timescale-cloud.mdx
rename to docs/docs/databases/postgres/timescale-cloud.mdx
index 0c9c9813cb8..b952e58f910 100644
--- a/docs/docs/databases/connect-db/cloud-databases/timescale-cloud.mdx
+++ b/docs/docs/databases/postgres/timescale-cloud.mdx
@@ -154,6 +154,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/connect-db/cloud-databases/yugabyte.mdx b/docs/docs/databases/postgres/yugabyte.mdx
similarity index 99%
rename from docs/docs/databases/connect-db/cloud-databases/yugabyte.mdx
rename to docs/docs/databases/postgres/yugabyte.mdx
index d0c1d47af3a..3e1f73c043a 100644
--- a/docs/docs/databases/connect-db/cloud-databases/yugabyte.mdx
+++ b/docs/docs/databases/postgres/yugabyte.mdx
@@ -174,6 +174,6 @@ Voilà. You are ready to start developing.
:::info Note
-For more information on which Postgres features we support, check out [this page](/databases/index.mdx#feature-support)!
+For more information on which Postgres features we support, check out [this page](/databases/feature-support.mdx).
:::
diff --git a/docs/docs/databases/quickstart.mdx b/docs/docs/databases/quickstart.mdx
new file mode 100644
index 00000000000..8631c9bd6b1
--- /dev/null
+++ b/docs/docs/databases/quickstart.mdx
@@ -0,0 +1,214 @@
+---
+sidebar_label: Quickstart
+sidebar_position: 1
+description: Connect a database to Hasura
+keywords:
+ - hasura
+ - docs
+ - databases
+ - connect
+toc_max_heading_level: 2
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import Thumbnail from '@site/src/components/Thumbnail';
+
+# Connect Databases to Hasura GraphQL Engine
+
+## Introduction
+
+You can quickly and easily connect a new, existing, or demo database to Hasura GraphQL Engine in either Hasura Cloud or
+you can run Hasura Engine using Docker.
+
+:::tip Connect multiple databases
+
+You can also connect to multiple databases in order to build a unified GraphQL API.
+
+:::
+
+## Connect a database via the Hasura Console {#connect-database-v2-0}
+
+
+
+
+If you have [created your project with Hasura Cloud](/hasura-cloud/projects/create.mdx), click on the `Launch Console`
+button to open the Hasura Console in your browser.
+
+
+
+Hasura Cloud does not host databases, but does provide integrations with which you can connect databases from many 3rd
+party managed cloud providers. Check out a [list of supported databases here](/databases/overview.mdx).
+
+To get started quickly with a Postgres database, choose `Create New Database`:
+
+
+
+Follow the prompts or [check out our detailed Neon connect page](/databases/postgres/neon.mdx). Hasura Cloud will
+integrate with your Neon account and manage the initial setup of a Postgres instance. You can always upgrade the
+instance and manage options later through your Neon account.
+
+### Connect to an existing database
+
+To use an existing database, choose `Connect existing database` and enter your database connection URL and enter your
+database connection string.
+
+For help finding your particular connection string for your database provider check out our
+[databases page](/databases/overview.mdx).
+
+
+
+You can connect to databases by using environment variables, the raw connection string or connection parameters. It is
+recommended to use environment variables for better security _(as connection details set via a string will be exposed as
+part of the Hasura Metadata)_ as well as to allow configuring different databases in different environments _(like
+staging or production)_ easily.
+
+A database can be connected to using the `HASURA_GRAPHQL_DATABASE_URL` environment variable as well in which case it
+gets added automatically as a database named `default`.
+
+### Allow connections from the Hasura Cloud IP {#cloud-projects-create-allow-nat-ip}
+
+When using Hasura Cloud, you may need to adjust your connection settings of your database provider to allow connections
+from the Hasura Cloud IP address.
+
+You can copy the IP address of your Hasura Engine instance from the copy icon in the `Hasura Cloud IP` field on the
+Project's details view which you can shortcut to by clicking on your Project name in the Console.
+
+
+
+
+
+
+
+
+If you've [spun up the Hasura Engine with Docker](/getting-started/docker-simple.mdx), you can access the Hasura Console
+by accessing it in a browser at the URL of your Hasura Engine instance, usually `http://localhost:8080`.
+
+:::info Enable Hasura Console
+
+To access the Hasura Console via and URL and not [via the CLI](/hasura-cli/commands/hasura_console.mdx) the
+`HASURA_GRAPHQL_ENABLE_CONSOLE` [environment variable](/deployment/graphql-engine-flags/reference.mdx##database-url) or
+`--enable-console` flag must be set to `true`.
+
+:::
+
+On the Hasura Console, navigate to the `Data` tab, you will see the "Connect Database" screen.
+
+
+
+You can connect to databases by using environment variables, the raw connection string or connection parameters. It is
+recommended to use environment variables for better security _(as connection details set via a string will be exposed as
+part of the Hasura Metadata)_ as well as to allow configuring different databases in different environments _(like
+staging or production)_ easily.
+
+A database can be connected to using the `HASURA_GRAPHQL_DATABASE_URL` environment variable as well in which case it
+gets added automatically as a database named default.
+
+
+
+
+## Connect a database via the Hasura CLI or API
+
+
+
+
+In your `config v3` project, head to the `/metadata/databases/databases.yaml` file and add the database configuration as
+below. If you're using the `HASURA_GRAPHQL_DATABASE_URL` environment variable then the database will get automatically
+added and named default.
+
+```yaml
+- name:
+ configuration:
+ connection_info:
+ database_url:
+ from_env:
+ pool_settings:
+ idle_timeout: 180
+ max_connections: 50
+ retries: 1
+ tables: []
+ functions: []
+```
+
+Apply the Metadata by running:
+
+```bash
+hasura metadata apply
+```
+
+
+
+
+Depending on the type of database, you can add a database using the
+[sources Metadata API](/api-reference/metadata-api/source.mdx).
+
+For example:
+
+```http
+POST /v1/metadata HTTP/1.1
+Content-Type: application/json
+X-Hasura-Role: admin
+
+{
+ "type": "pg_add_source",
+ "args": {
+ "name": "",
+ "configuration": {
+ "connection_info": {
+ "database_url": {
+ "from_env": ""
+ },
+ "pool_settings": {
+ "retries": 1,
+ "idle_timeout": 180,
+ "max_connections": 50
+ }
+ }
+ }
+ }
+}
+```
+
+
+
+
+:::info On-the-fly connecting and removing of databases
+
+In versions `v2.0.0` and above, databases can be connected and removed dynamically without having to restart the Hasura
+Engine instance.
+
+:::
+
+## Hasura Metadata storage
+
+When using Hasura Cloud, Metadata is stored for you in separate data storage to your connected database(s). When using
+Docker, if you want to
+[store the Hasura Metadata on a separate database](/deployment/graphql-engine-flags/reference.mdx#metadata-database-url),
+you can use the `HASURA_GRAPHQL_METADATA_DATABASE_URL` env var to specify which database to use. By default, the Hasura
+Metadata is stored on the same database as specified in the `HASURA_GRAPHQL_DATABASE_URL` environment variable.
+
+## Connect different Hasura instances to the same database
+
+You can connect different Hasura instances (i.e. instances with different Metadata) to the same database as long as
+there are no [Event Triggers](/event-triggers/overview.mdx) in any of the Metadata. Event Triggers store their data in
+the underlying database and hence different instances acting on the same data can cause undefined behavior during
+run-time. This should not be a problem if the Hasura instances have the same Metadata.
+
+To connect multiple Hasura instances to the same database, simply follow the steps above for
+[Connect to an existing database](#connect-to-an-existing-database) for each instance.
+
+## Connecting to a database not exposed over the internet
+
+[Contact us](https://hasura.io/contact-us/) for VPC peering and on-premise solutions.
+
+## More databases
+
+Support for more databases is coming soon. Stay up to date with [supported databases here](/databases/overview.mdx).
diff --git a/docs/docs/deployment/best-practices/metadata.mdx b/docs/docs/deployment/best-practices/metadata.mdx
index a7e928f5fdd..3467e9750db 100644
--- a/docs/docs/deployment/best-practices/metadata.mdx
+++ b/docs/docs/deployment/best-practices/metadata.mdx
@@ -15,7 +15,7 @@ real-world practices, user experiences, and challenges when managing enterprise-
### Recommended patterns
-- Use the [Hasura CLI](/hasura-cli/index.mdx) to manage and export Metadata.
+- Use the [Hasura CLI](/hasura-cli/overview.mdx) to manage and export Metadata.
- The CLI exports [YAML files](/migrations-metadata-seeds/manage-metadata.mdx) which is much more source-control
friendly than JSON (exported by the Console and API).
@@ -36,8 +36,8 @@ real-world practices, user experiences, and challenges when managing enterprise-
:::info Note
-Hasura Cloud users can leverage the [GitHub integration](/hasura-cloud/ci-cd/github-integration.mdx) to
-automate deployments.
+Hasura Cloud users can leverage the [GitHub integration](/hasura-cloud/ci-cd/github-integration.mdx) to automate
+deployments.
:::
diff --git a/docs/docs/deployment/best-practices/security.mdx b/docs/docs/deployment/best-practices/security.mdx
index c14b7d5bdd5..543e092f9f8 100644
--- a/docs/docs/deployment/best-practices/security.mdx
+++ b/docs/docs/deployment/best-practices/security.mdx
@@ -119,7 +119,7 @@ permissions as the provided credentials in the connection string.
- Use database connections strings with the least privileges required for API operations.
-- Configure [read replicas](/databases/connect-db/read-replicas.mdx) to route read-only operations (queries) to one (or
+- Configure [read replicas](/databases/database-config/read-replicas.mdx) to route read-only operations (queries) to one (or
many) read replicas.
## Networking/API gateway
diff --git a/docs/docs/deployment/deployment-guides/docker.mdx b/docs/docs/deployment/deployment-guides/docker.mdx
index 950c5737927..dc75b524fc0 100644
--- a/docs/docs/deployment/deployment-guides/docker.mdx
+++ b/docs/docs/deployment/deployment-guides/docker.mdx
@@ -77,7 +77,7 @@ graphql-engine:
:::info Note
The `HASURA_GRAPHQL_ADMIN_SECRET` should never be passed from the client to the Hasura GraphQL Engine as it would give
-the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/index.mdx) for
+the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/overview.mdx) for
information on setting up authentication.
:::
diff --git a/docs/docs/deployment/deployment-guides/kubernetes.mdx b/docs/docs/deployment/deployment-guides/kubernetes.mdx
index 18e806e5c94..6fd06cb6f42 100644
--- a/docs/docs/deployment/deployment-guides/kubernetes.mdx
+++ b/docs/docs/deployment/deployment-guides/kubernetes.mdx
@@ -117,7 +117,7 @@ spec:
:::info Note
The `HASURA_GRAPHQL_ADMIN_SECRET` should never be passed from the client to the Hasura GraphQL Engine as it would give
-the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/index.mdx) for
+the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/overview.mdx) for
information on setting up authentication.
:::
diff --git a/docs/docs/deployment/graphql-engine-flags/reference.mdx b/docs/docs/deployment/graphql-engine-flags/reference.mdx
index f3d2f5be04a..59a5cf2beee 100644
--- a/docs/docs/deployment/graphql-engine-flags/reference.mdx
+++ b/docs/docs/deployment/graphql-engine-flags/reference.mdx
@@ -208,7 +208,7 @@ for JSON encoding-decoding.
### Connections per Read-Replica
-The maximum number of Postgres connections per [read-replica](databases/connect-db/read-replicas.mdx) that can be opened
+The maximum number of Postgres connections per [read-replica](databases/database-config/read-replicas.mdx) that can be opened
per stripe. When the maximum is reached we will block until a new connection becomes available, even if there is
capacity in other stripes.
@@ -242,7 +242,7 @@ List of domains, **including scheme (http/https) and port**, to allow for CORS.
value will block requests from all other domains**.
| | |
-| ------------------- | ----------------------------------------------------------------------------------------------|
+| ------------------- | --------------------------------------------------------------------------------------------- |
| **Flag** | `--cors-domain ` |
| **Env var** | `HASURA_GRAPHQL_CORS_DOMAIN` |
| **Accepted values** | String (comma separated list of domains) |
@@ -407,7 +407,7 @@ Setting this enables or disables [anonymous telemetry](/policies/telemetry.mdx).
### Enabled APIs
-List of [APIs](/api-reference/index.mdx) to be enabled on a Hasura GraphQL Engine instance.
+List of [APIs](/api-reference/overview.mdx) to be enabled on a Hasura GraphQL Engine instance.
| | |
| ------------------- | ---------------------------------------------------- |
@@ -483,8 +483,8 @@ List of experimental features to be enabled.
### Graceful Shutdown Timeout
-The timeout, expressed in seconds, to wait for in-flight events (such as [Event Triggers](/event-triggers/index.mdx) and
-[Scheduled Triggers](/scheduled-triggers/index.mdx)) and async actions to complete before the server shuts down
+The timeout, expressed in seconds, to wait for in-flight events (such as [Event Triggers](/event-triggers/overview.mdx)
+and [Scheduled Triggers](/scheduled-triggers/overview.mdx)) and async actions to complete before the server shuts down
completely. If the in-flight events are not completed within the timeout, those events are marked as pending.
| | |
@@ -802,7 +802,7 @@ Whether to use TLS to connect to a caching [Redis instance](/enterprise/caching.
### Read Replica URL
-The [URL for a read replica](/databases/connect-db/read-replicas.mdx#adding-read-replica-urls) of the database.
+The [URL for a read replica](/databases/database-config/read-replicas.mdx#adding-read-replica-urls) of the database.
:::warning Notice
@@ -940,7 +940,7 @@ Stringify certain [Postgres numeric types](/schema/postgres/postgresql-types.mdx
:::
-The number of stripes (connection pools) to maintain per [read replica](/databases/connect-db/read-replicas.mdx).
+The number of stripes (connection pools) to maintain per [read replica](/databases/database-config/read-replicas.mdx).
| | |
| ------------------- | ----------------------------------------- |
diff --git a/docs/docs/deployment/health-checks/source-health-check.mdx b/docs/docs/deployment/health-checks/source-health-check.mdx
index 7558db0b677..6bc16cc9ec1 100644
--- a/docs/docs/deployment/health-checks/source-health-check.mdx
+++ b/docs/docs/deployment/health-checks/source-health-check.mdx
@@ -7,7 +7,7 @@ keywords:
- enterprise
- source health check
- source health
-sidebar_label: Source Health Check
+sidebar_label: Source Health Check ☁️
sidebar_position: 20
sidebar_class_name: cloud-icon
---
diff --git a/docs/docs/deployment/index.mdx b/docs/docs/deployment/index.mdx
deleted file mode 100644
index 0e0476b8b60..00000000000
--- a/docs/docs/deployment/index.mdx
+++ /dev/null
@@ -1,60 +0,0 @@
----
-description: Deploy Hasura GraphQL Engine
-title: Deploy Hasura GraphQL Engine
-sidebar_label: Deployment
-keywords:
- - hasura
- - docs
- - deployment
-slug: index
-sidebar_position: 1
----
-
-import Deployment from '@site/static/icons/features/deployment.svg';
-
-# Deploy Hasura GraphQL Engine
-
-## Deployment guides
-
-This section contains guides to deploy the Hasura GraphQL Engine and connect it to a Postgres database.
-
-If you're looking for quick deployment options, check out the following guides:
-
-- [One-click deployment guides](/deployment/deployment-guides/index.mdx#one-click-deployment-guides)
-
-The following is a list of all deployment guides:
-
-- [Deployment guides](/deployment/deployment-guides/index.mdx#all-deployment-guides)
-
-## Configuration
-
-By default, Hasura GraphQL Engine runs in a very permissive mode for easier development. Check out the below pages to
-configure the Hasura GraphQL Engine for your production environment:
-
-- [GraphQL Engine server configuration](/deployment/graphql-engine-flags/index.mdx)
-- [Postgres requirements](/deployment/postgres-requirements.mdx#postgres-permissions)
-- [Securing the GraphQL endpoint](/deployment/securing-graphql-endpoint.mdx)
-- [Enable HTTPS](/deployment/enable-https.mdx)
-- [Allow-list of operations](/security/allow-list.mdx)
-- [HTTP compression](/deployment/compression.mdx)
-- [Updating GraphQL Engine](/deployment/updating-graphql-engine.mdx)
-- [Downgrading GraphQL Engine](/deployment/downgrading.mdx)
-
-## Logs
-
-For access to Hasura GraphQL Engine logs, check the below page for details:
-
-- [Logging](/deployment/logging.mdx)
-
-## Production checklist
-
-If you're moving your Hasura GraphQL Engine to production, consult the following guide:
-
-- [Production checklist](/deployment/production-checklist.mdx)
-
-:::info Security Announcements
-
-Join the [Hasura Security Announcements](https://groups.google.com/forum/#!forum/hasura-security-announce) group for
-emails about security announcements.
-
-:::
diff --git a/docs/docs/deployment/logging.mdx b/docs/docs/deployment/logging.mdx
index 0725b63e14a..fdf6ac2615d 100644
--- a/docs/docs/deployment/logging.mdx
+++ b/docs/docs/deployment/logging.mdx
@@ -28,7 +28,7 @@ Based on your deployment method, the Hasura GraphQL Engine logs can be accessed
:::info Detailed Logging in Hasura Cloud
If you’re looking for more in-depth logging information, along with a Console for browsing logs, please see
-[Observability with Hasura Cloud](/observability/index.mdx).
+[Observability with Hasura Cloud](/observability/overview.mdx).
:::
@@ -630,267 +630,6 @@ The `detail` field value is an object contains the following members.
| `num_one_off_scheduled_events_fetched` | int | The count of total one-off scheduled events fetched |
| `num_fetches` | int | The number of fetches happened within 10 minutes |
-### **cron-event-generator-process** log structure
-
-Every 10 minutes, the Hasura Engine logs the cron triggers fetched from metadata storage for events generation. The log
-also contains the number of times new triggers are fetched within the 10 minute timeframe.
-
-```json
-{
- "detail": {
- "cron_triggers": [
- {
- "max_scheduled_time": "2023-01-31T13:18:00Z",
- "name": "every_two_minutes",
- "upcoming_events_count": 99
- }
- ],
- "num_fetches": 10
- },
- "level": "info",
- "timestamp": "2023-01-31T15:31:55.773+0530",
- "type": "cron-event-generator-process"
-}
-```
-
-The `type` in the log will be `cron-event-generator-process` and details of the cron event generator process will be
-under the `detail` key.
-
-The `detail` field value is an object containing the following members.
-
-| Name | Type | Description |
-| --------------- | ---------------------------------- | ------------------------------------------------ |
-| `cron_triggers` | List of `CronTriggerStats` objects | The list of cron triggers fetched |
-| `num_fetches` | int | The number of fetches happened within 10 minutes |
-
-The `CronTriggerStats` object contains the following members.
-
-| Name | Type | Description |
-| ----------------------- | ------ | ---------------------------------------------- |
-| `name` | string | The name of the cron trigger |
-| `upcoming_events_count` | int | The number of undelivered upcoming cron events |
-| `max_scheduled_time` | string | The timestamp of the cron event occurring last |
-
-:::info Note
-
-A new set of cron events will be generated only for triggers with fewer than 100 upcoming events. Thus, the
-`upcoming_events_count` will be always `< 100`.
-
-:::
-
-### **livequery-poller-log** structure {#livequery-poller-log}
-
-The Hasura GraphQL Engine emits `livequery-poller-log` when a live query or streaming subscription is running. A
-subscription is run via a poller internally, which executes a multiplexed query on the database. Various internal
-metrics are emitted to this log.
-
-Below, you can find examples of the `livequery-poller-log` as seen from the Community and Self-hosted Enterprise
-Editions:
-
-
-
-
-```json
-{
- "detail": {
- "execution_batches": [
- {
- "batch_id": 1,
- "batch_response_size_bytes": 106,
- "db_execution_time": 0.001570364,
- "pg_execution_time": 0.001570364,
- "push_time": 0.000163488
- }
- ],
- "generated_sql": "SELECT \"__subs\".\"result_id\" , \"__fld_resp\".\"root\" AS \"result\" FROM UNNEST(($1)::uuid[], ($2)::json[]) AS \"__subs\"(\"result_id\", \"result_vars\") LEFT OUTER JOIN LATERAL (SELECT json_build_object('test', \"_test\".\"root\" ) AS \"root\" FROM (SELECT coalesce(json_agg(\"root\" ), '[]' ) AS \"root\" FROM (SELECT row_to_json((SELECT \"_e\" FROM (SELECT \"_root.base\".\"id\" AS \"id\", \"_root.base\".\"name\" AS \"name\" ) AS \"_e\" ) ) AS \"root\" FROM (SELECT * FROM \"public\".\"test\" WHERE ('true') ) AS \"_root.base\" ) AS \"_root\" ) AS \"_test\" ) AS \"__fld_resp\" ON ('true') ",
- "kind": "live-query",
- "poller_id": "605369b0-69c4-44fb-b3a1-9897bae5007c",
- "role": "admin",
- "snapshot_time": 0.000032141,
- "source": "default",
- "subscriber_count": 1,
- "subscription_options": {
- "batch_size": 100,
- "refetch_delay": 1
- },
- "total_time": 0.001851686
- },
- "level": "info",
- "timestamp": "2023-02-06T14:36:46.194+0530",
- "type": "livequery-poller-log"
-}
-```
-
-
-
-
-```json
-{
- "detail": {
- "cohort_size": 1,
- "cohorts": [
- {
- "batch_id": 1,
- "cohort_id": "1f5e2cc6-56b9-4215-ab55-fadc725d3737",
- "cohort_variables": {
- "cursor": {},
- "query": {},
- "session": {},
- "synthetic": []
- },
- "response_size_bytes": 106,
- "subscribers": [
- {
- "operation_id": "2",
- "operation_name": "testSubs",
- "request_id": "b928d8f8-96bf-4274-a0a9- da8dce63183f",
- "subscriber_id": "350402f5-f2d5-4620-9f22-f320ab0da048",
- "websocket_id": "75dccf63-37d6-4f30-b840-2c56f0fab18e"
- }
- ]
- }
- ],
- "execution_batch_size": 1,
- "execution_batches": [
- {
- "batch_id": 1,
- "batch_response_size_bytes": 106,
- "batch_size": 1,
- "db_execution_time": 0.002743811,
- "pg_execution_time": 0.002743811,
- "push_cohorts_time": 0.000212959
- }
- ],
- "generated_sql": "SELECT \"__subs\".\"result_id\" , \"__fld_resp\".\"root\" AS \"result\" FROM UNNEST(($1)::uuid[], ($2):: json[]) AS \"__subs\"(\"result_id\", \"result_vars\") LEFT OUTER JOIN LATERAL (SELECT json_build_object('test', \"_test\".\"root\" ) AS \"root\" FROM (SELECT coalesce(json_agg(\"root\" ), '[]' ) AS \"root\" FROM (SELECT row_to_json((SELECT \"_e\" FROM (SELECT \"_root.base\".\"id\" AS \"id\", \"_root.base\".\"name\" AS \"name\" ) AS \"_e\" ) ) AS \"root\" FROM (SELECT * FROM \"public\".\"test\" WHERE ('true') ) AS \"_root. base\" ) AS \"_root\" ) AS \"_test\" ) AS \"__fld_resp\" ON ('true') /* field_name=test, parameterized_query_hash=678ff296b384af45bfa1d52af398de475f509250 */",
- "kind": "live-query",
- "parameterized_query_hash": "678ff296b384af45bfa1d52af398de475f509250",
- "poller_id": "70344ef5-8a52-4a78-b2ad-ef7ff1bd46f8",
- "role": "admin",
- "snapshot_time": 0.000108982,
- "source": "one",
- "subscriber_count": 1,
- "subscription_options": {
- "batch_size": 100,
- "refetch_delay": 1
- },
- "total_time": 0.003222237
- },
- "level": "info",
- "timestamp": "2023-02-06T14:43:34.536+0530",
- "type": "livequery-poller-log"
-}
-```
-
-
-
-
-The `type` is `livequery-poller-log` and internal details/metrics are nested in the `detail` key.
-
-The `detail` field's value is an object containing the following properties:
-
-| Name | Type | Description |
-| ---------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `kind` | string | "live-query" or "streaming" |
-| `poller_id` | string | UUID that uniquely identifies the poller |
-| `subscriber_count` | number | Total number of subscribers in the poller |
-| `cohorts`\* | [[Cohort]](/deployment/logging.mdx#subscription-log-cohort) | List of cohorts |
-| `cohort_size`\* | number | Number of cohorts (length of the above list) |
-| `execution_batches` | [[ExecutionBatch]](/deployment/logging.mdx#subscription-log-execution-batch) | List of execution batches |
-| `execution_batch_size`\* | number | Number of execution batches (length of the above list) |
-| `total_time` | number | Total time (in seconds) spent on running the poller once (which may concurrently process more than one batch) and then pushing the results to each subscriber |
-| `snapshot_time` | number | The time taken (in seconds) to group identical subscribers in cohorts and then split cohorts into different batches |
-| `generated_sql` | string | The multiplexed SQL query to be run against database |
-| `parameterized_query_hash`\* | string | The [parameterized query hash](/deployment/logging.mdx#http-log-structure) of the query |
-| `subscription_options` | [SubscriptionOptions](/deployment/logging.mdx#subscription-log-config-options) | Subscription options configured (like refetch delay, batch size etc.) |
-| `source` | string | Name of the source on which the query is being run |
-| `role` | string | Role associated with the client that is making the subscription |
-
-:::info FIELD AVAILABILITY
-
-Fields marked with an asterisk(\*) are only available on Self-hosted Enterprise
-
-:::
-
-#### Cohort {#subscription-log-cohort}
-
-A cohort is a batched group of subscribers running the same query with identical session and query variables. Each
-result pushed to a cohort is forwarded along to each of its subscribers.
-
-The cohort field is an object with the following properties:
-
-| Name | Type | Description |
-| --------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
-| `batch_id` | number | A monotonically increasing (from 1) batch number assigned to each batch in a cohort |
-| `cohort_id` | string | UUID that uniquely identifies a cohort |
-| `cohort_variables` | [CohortVariables](/deployment/logging.mdx#subscription-log-cohort-vars) | All the variables of the cohort. This includes query, session and cursor variables |
-| `response_size_bytes` | number | Response size in bytes |
-| `subscribers` | [[Subscriber]](/deployment/logging.mdx#subscription-log-subscriber) | List of subscribers |
-
-#### Subscriber {#subscription-log-execution-batch}
-
-A subscriber is a client running a subscription operation.
-
-The subscriber field is an object with the following properties:
-
-| Name | Type | Description |
-| ---------------- | ------ | -------------------------------------------------------------------------- |
-| `operation_id` | string | Operation ID provided by the client (as per the Apollo websocket protocol) |
-| `operation_name` | string | Name of the GraphQL operation |
-| `request_id` | string | UUID generated by HGE for each operation request |
-| `subscriber_id` | string | UUID generated by HGE for the subscriber |
-| `websocket_id` | string | UUID generated by HGE for websocket connection of the client |
-
-:::info SUBSCRIBER NOTES
-
-- A `request_id` is generated on every operation sent by the client. This can include queries and mutations.
-- A `subscriber_id` is generated on every subscription operation sent by the client. Co-incidentally, a `request_id` is
- also generated.
-- A `websocket_id` is generated per client, when a client connects over websocket (irrespective of if they ever ran a
- subscription operation)
-
-:::
-
-#### Execution Batch {#subscription-log-execution-batch}
-
-A cohort is further divided into batches (according to the
-[`HASURA_GRAPHQL_LIVE_QUERIES_MULTIPLEXED_BATCH_SIZE` config](/deployment/graphql-engine-flags/reference.mdx#multiplexed-batch-size))
-for concurrent execution.
-
-The execution batch field is an object with the following properties:
-
-| Name | Type | Description |
-| --------------------------- | ------ | ------------------------------------------------------------------------------------ |
-| `batch_id` | number | A monotonically increasing (from 1) batch number |
-| `batch_response_size_bytes` | number | Response size of the batch in bytes (which will be `null` in case of errors) |
-| `batch_size` | string | Number of cohorts in this batch |
-| `pg_execution_time` | number | Database execution time (in seconds) of the batch (present only in vanilla Postgres) |
-| `db_execution_time` | number | Database execution time (in seconds) of the batch |
-| `push_cohorts_time` | number | Time taken (in seconds) to push response to all cohorts in this batch |
-
-#### Cohort Variables {#subscription-log-cohort-vars}
-
-This includes various variables of the cohort. This includes query, session, cursor variables and synthetic variables.
-
-This field is an object with the following properties:
-
-| Name | Type | Description |
-| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `query` | object | The variables provided along with the GraphQL query by the subscriber |
-| `session` | object | The session variables (`x-hasura-*`) resolved by Hasura during authentication |
-| `cursor` | object | The cursor variables in case of a streaming subscription. Empty in live query subscription |
-| `synthetic` | object | All SQL literals are converted to what are called synthetic variables. [See this for more details](https://github.com/hasura/graphql-engine-mono/blob/d96d7fa5aaf0c1e71d1c4c0fa8f0162abce39e18/server/src-lib/Hasura/GraphQL/Execute/Subscription/Plan.hs#L186-L205) |
-
-#### Subscription Options {#subscription-log-config-options}
-
-These are all configured options for a live query.
-
-The `subscription_options` field is an object with the following properties:
-
-| Name | Type | Description |
-| --------------- | ------ | ---------------------------------------------------------------------------------------------- |
-| `batch_size` | number | The batch size configured via `HASURA_GRAPHQL_LIVE_QUERIES_MULTIPLEXED_BATCH_SIZE` |
-| `refetch_delay` | number | The refetch interval configured via `HASURA_GRAPHQL_LIVE_QUERIES_MULTIPLEXED_REFETCH_INTERVAL` |
-
## Monitoring frameworks
You can integrate the logs emitted by the Hasura Engine with external monitoring tools for better visibility as per your
diff --git a/docs/docs/deployment/overview.mdx b/docs/docs/deployment/overview.mdx
new file mode 100644
index 00000000000..db3f2fc9b4e
--- /dev/null
+++ b/docs/docs/deployment/overview.mdx
@@ -0,0 +1,81 @@
+---
+description: Hasura Deployment
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - deployment
+ - CI/CD
+ - cloud
+ - docker
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Deployment from '@site/static/icons/features/deployment.svg';
+
+# Deploy Hasura GraphQL Engine
+
+
+
+
+ To deploy the Hasura GraphQL Engine, we recommend using Hasura Cloud, which is a fully-managed, highly-optimized, production-ready,
+ hosted option. With Hasura Cloud, you can deploy your GraphQL API in less than 60 seconds plus you get high availability,
+ automatic upgrades, and observability out of the box. Alternatively, you can deploy the Hasura GraphQL Engine to a
+ cloud provider of your choice using Docker or Kubernetes.
+
+
+ Regardless of where you deploy, the Hasura GraphQL Engine is highly configurable, allowing you to tailor
+ everything to your needs.
+
+
Quick Links
+
+
+
+ Deploy to Hasura Cloud in less than 60 seconds.
+
+
+
+ Learn about configuring Hasura.
+
+
+
+
+
+
+
+## Deployment Topics
+
+
+
+
+
Hasura Cloud
+
In just a couple of clicks, connect your existing data and have a production-ready GraphQL API.
+
+
+
+
+
Deployment Guides
+
+ Deploy Hasura GraphQL Engine to a cloud provider of your choice using one of our guides. We have guides for AWS,
+ GCP, Azure, DigitalOcean, and more.
+
+
+
+
+
+
Self-hosted Docker
+
+ Not sure where to start? We have a guide to help you get up and running with Hasura GraphQL Engine on Docker,
+ regardless of where you want to host.
+
+
+
+
diff --git a/docs/docs/deployment/performance-tuning.mdx b/docs/docs/deployment/performance-tuning.mdx
index d5a04d0814a..957c9150d48 100644
--- a/docs/docs/deployment/performance-tuning.mdx
+++ b/docs/docs/deployment/performance-tuning.mdx
@@ -124,8 +124,8 @@ It's recommended to monitor resource usage patterns and vertically scale up the
your workload, DB size etc. 4 CPUs with 8GB RAM is usually a good sweet spot to handle a wide variety of production
workloads.
-Horizontal **auto-scaling** can be set up based on CPU & memory. It's advisable to start with this, monitor it for a
-few days and see if there's a need to change based on your workload.
+Horizontal **auto-scaling** can be set up based on CPU & memory. It's advisable to start with this, monitor it for a few
+days and see if there's a need to change based on your workload.
However, you need to be aware of the total Postgres connections, too. The default `HASURA_GRAPHQL_PG_CONNECTIONS` value
is `50`, meanwhile the default Postgres `max_connections` configuration is `100`. The Postgres server will easily be out
@@ -140,7 +140,7 @@ pg_max_connections >= hasura_nodes * hasura_pg_connections + event_nodes * event
Observability tools help us track issues, alert us to errors, and allow us to monitor performance and hardware usage. It
is critical in production. There are many open-source and commercial services. However, you may have to combine many
tools because of the architectural complexity. For more information, check out our
-[observability section](/observability/index.mdx) and our
+[observability section](/observability/overview.mdx) and our
[observability best practices](/deployment/best-practices/observability.mdx).
## Software architecture and best practices
@@ -198,7 +198,7 @@ Hardware has its limits. It's expensive to scale servers as well as optimize dat
master-master replica, so it will be a bottleneck if you store all the data in one database. Therefore, you can divide
your business logic into multiple smaller services, or microservices.
-Hasura encourages microservices with [Remote Schemas](/remote-schemas/index.mdx). This can act as an API Gateway that
+Hasura encourages microservices with [Remote Schemas](/remote-schemas/overview.mdx). This can act as an API Gateway that
routes to multiple, smaller GraphQL servers.
diff --git a/docs/docs/deployment/production-checklist.mdx b/docs/docs/deployment/production-checklist.mdx
index 180c2db9428..549dada77b2 100644
--- a/docs/docs/deployment/production-checklist.mdx
+++ b/docs/docs/deployment/production-checklist.mdx
@@ -80,7 +80,7 @@ graphql-engine --database-url= serve --enabled-apis=graphql
By setting the above flag or env var, we are disabling the `metadata`, `pgdump` and `config` APIs. `health` and
`version` APIs are public and cannot be disabled.
-Read more about all the API types at the [API reference](/api-reference/index.mdx).
+Read more about all the API types at the [API reference](/api-reference/overview.mdx).
:::info Note
diff --git a/docs/docs/deployment/securing-graphql-endpoint.mdx b/docs/docs/deployment/securing-graphql-endpoint.mdx
index a91a3713068..1bae9b312c0 100644
--- a/docs/docs/deployment/securing-graphql-endpoint.mdx
+++ b/docs/docs/deployment/securing-graphql-endpoint.mdx
@@ -25,8 +25,8 @@ access to your GraphQL endpoint and the Hasura Console:
:::info Note
If you're looking at adding access control rules for your data to your GraphQL API then head to
-[Authentication / access control](/auth/index.mdx). You can also find more information about
-[Hasura security in general here](/security/index.mdx) and best practices
+[Authentication / access control](/auth/overview.mdx). You can also find more information about
+[Hasura security in general here](/security/overview.mdx) and best practices
[here](/deployment/best-practices/security.mdx).
:::
diff --git a/docs/docs/enterprise/_category_.json b/docs/docs/enterprise/_category_.json
index 3ec6cc9e632..dce880d3034 100644
--- a/docs/docs/enterprise/_category_.json
+++ b/docs/docs/enterprise/_category_.json
@@ -1,5 +1,5 @@
{
- "label": "Hasura Enterprise",
+ "label": "Hasura Enterprise 🏢",
"position": 210,
"className": "enterprise-icon"
}
diff --git a/docs/docs/enterprise/getting-started/quickstart-aws-ecs.mdx b/docs/docs/enterprise/getting-started/quickstart-aws-ecs.mdx
index 2d68d8d0435..0ec7ceddb24 100644
--- a/docs/docs/enterprise/getting-started/quickstart-aws-ecs.mdx
+++ b/docs/docs/enterprise/getting-started/quickstart-aws-ecs.mdx
@@ -117,7 +117,7 @@ Examples of `HASURA_GRAPHQL_REDIS_URL` and `HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`
[Postgres permissions](/deployment/postgres-requirements.mdx#postgres-permissions).
- The `HASURA_GRAPHQL_ADMIN_SECRET` should never be passed from the client to the Hasura GraphQL Engine as it would give
- the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/index.mdx) for
+ the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/overview.mdx) for
information on setting up authentication.
- Convert confidential environment variables such as Postgres / Redis URLs, admin / metrics secrets to fetch from
diff --git a/docs/docs/enterprise/getting-started/quickstart-docker.mdx b/docs/docs/enterprise/getting-started/quickstart-docker.mdx
index 2ec87a21e32..f9e9b4d9c4f 100644
--- a/docs/docs/enterprise/getting-started/quickstart-docker.mdx
+++ b/docs/docs/enterprise/getting-started/quickstart-docker.mdx
@@ -68,7 +68,7 @@ graphql-engine:
:::info Note
The `HASURA_GRAPHQL_ADMIN_SECRET` should never be passed from the client to the Hasura GraphQL Engine as it would give
-the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/index.mdx) for
+the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/overview.mdx) for
information on setting up authentication.
:::
diff --git a/docs/docs/enterprise/getting-started/quickstart-google-cloud-run.mdx b/docs/docs/enterprise/getting-started/quickstart-google-cloud-run.mdx
index f04453dd810..a33111a19df 100644
--- a/docs/docs/enterprise/getting-started/quickstart-google-cloud-run.mdx
+++ b/docs/docs/enterprise/getting-started/quickstart-google-cloud-run.mdx
@@ -80,7 +80,7 @@ Examples of `HASURA_GRAPHQL_REDIS_URL` and `HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`
[Postgres permissions](/deployment/postgres-requirements.mdx#postgres-permissions).
- The `HASURA_GRAPHQL_ADMIN_SECRET` should never be passed from the client to the Hasura GraphQL Engine as it would give
- the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/index.mdx) for
+ the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/overview.mdx) for
information on setting up authentication.
- Convert confidential environment variables such as Postgres / Redis URLs, admin / metrics secrets to fetch them from
diff --git a/docs/docs/enterprise/getting-started/quickstart-kubernetes.mdx b/docs/docs/enterprise/getting-started/quickstart-kubernetes.mdx
index 8781bb6f25e..b8dc6805927 100644
--- a/docs/docs/enterprise/getting-started/quickstart-kubernetes.mdx
+++ b/docs/docs/enterprise/getting-started/quickstart-kubernetes.mdx
@@ -86,7 +86,7 @@ Examples of `HASURA_GRAPHQL_REDIS_URL` and `HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`
[Postgres permissions](/deployment/postgres-requirements.mdx#postgres-permissions).
- The `HASURA_GRAPHQL_ADMIN_SECRET` should never be passed from the client to the Hasura GraphQL Engine as it would give
- the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/index.mdx) for
+ the client full admin rights to your Hasura instance. See [Authentication & Authorization](/auth/overview.mdx) for
information on setting up authentication.
- Move confidential environment variables such as Postgres / Redis URLs, admin / metrics secrets to fetch from
diff --git a/docs/docs/enterprise/getting-started/start-using-hasura-ee.mdx b/docs/docs/enterprise/getting-started/start-using-hasura-ee.mdx
index 0bf416aa159..57c0ceb6c3c 100644
--- a/docs/docs/enterprise/getting-started/start-using-hasura-ee.mdx
+++ b/docs/docs/enterprise/getting-started/start-using-hasura-ee.mdx
@@ -19,8 +19,8 @@ After following one of the Hasura EE get started guides:
- Head to `http://localhost:8080/console` to open the Hasura Console.
- Log in using the admin secret key that you set.
-- Learn more about [connecting data sources](/databases/connect-db/index.mdx).
-- Check out the [Hasura Enterprise features](/enterprise/index.mdx).
+- Learn more about [connecting data sources](/databases/quickstart.mdx).
+- Check out the [Hasura Enterprise features](/enterprise/overview.mdx).
## Complete your production-readiness checklist (optional)
diff --git a/docs/docs/enterprise/index.mdx b/docs/docs/enterprise/index.mdx
deleted file mode 100644
index 9a9abfddac8..00000000000
--- a/docs/docs/enterprise/index.mdx
+++ /dev/null
@@ -1,48 +0,0 @@
----
-sidebar_label: Hasura Enterprise (EE)
-description: Documentation for the Hasura Enterprise edition
-title: 'EE: Hasura Enterprise'
-keywords:
- - hasura
- - docs
- - enterprise
-slug: index
----
-
-import Enterprise from '@site/static/icons/features/enterprise.svg';
-
-# Hasura Enterprise
-
-
Available on: Self-hosted Enterprise
-
-## Introduction
-
-Hasura Enterprise Edition (EE) has built-in enterprise features for running Hasura in production. These features have
-key capabilities for observability, security and performance.
-
-## Features
-
-Hasura EE capabilities include all the features of the Hasura Open Source Community Edition plus:
-
-- **Databases**
- - [Snowflake](/databases/snowflake/index.mdx)
- - [Amazon Athena](/databases/athena/index.mdx)
- - [MySQL](/databases/mysql/index.mdx)
-- **Performance**
- - [Caching](/enterprise/caching.mdx)
- - [Read Replicas](/databases/connect-db/read-replicas.mdx)
-- **Security**
- - [API Limiting](/security/api-limits.mdx)
- - [Role Based Allow List](/security/allow-list.mdx/#role-based-allow-list)
- - [Disable GraphQL Introspection](/security/disable-graphql-introspection.mdx)
- - [Multiple Admin Secrets](/security/multiple-admin-secrets.mdx)
- - [Multiple JWT Secrets](/security/multiple-jwt-secrets.mdx)
-- **Event Triggers**
- - [Auto Cleanup of Event Triggers](/event-triggers/clean-up/auto-cleanup.mdx)
-- **Observability**
- - [Logs](/deployment/logging.mdx)
- - [Metrics via Prometheus](/enterprise/metrics.mdx)
- - [Traces via OpenTelemetry](/enterprise/opentelemetry.mdx)
-
-Hasura EE also has additional capabilities for SSO, tracing, and APM integrations. If you'd like to learn more, please
-[contact us](mailto:sales@hasura.io).
diff --git a/docs/docs/enterprise/overview.mdx b/docs/docs/enterprise/overview.mdx
new file mode 100644
index 00000000000..af503d102e7
--- /dev/null
+++ b/docs/docs/enterprise/overview.mdx
@@ -0,0 +1,81 @@
+---
+description: Documentation for Hasura Enterprise Edition
+title: 'EE: Hasura Enterprise'
+keywords:
+ - hasura
+ - docs
+ - enterprise
+hide_table_of_contents: true
+sidebar_position: 1
+sidebar_label: Overview
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Enterprise from '@site/static/icons/features/enterprise.svg';
+
+# Hasura Enterprise
+
+
+ Available on: Self-hosted Enterprise
+
+
+
+
+
+ The open-source version of Hasura is highly capable, but Hasura Enterprise Edition (EE) has additional built-in
+ features for running Hasura in production on your own infrastructure. These features have key capabilities for observability, security,
+ and performance.
+
+
+ Hasura Enterprise Edition is available as a self-hosted product with support from the Hasura team. You can deploy
+ the Hasura Enterprise Edition on your own infrastructure, or on a cloud provider of your choice.
+
+
+ If you'd like to learn more, please contact us.
+
+
Quick Links
+
+
+
+ Quickstart with Docker.
+
+
+
+
+ Upgrade from Hasura CE to Hasura Enterprise.
+
+
+
+
+
+
+
+
+## Using Hasura Enterprise Edition
+
+
+
+
+
Quickstart with AWS ECS
+
Learn how to deploy Hasura Enterprise Edition on AWS ECS.
+
+
+
+
+
GraphQL Caching
+
Learn how to enable GraphQL caching in Hasura Enterprise Edition to supercharge performance.
+
+
+
+
+
Configure Prometheus
+
Learn how to configure Prometheus in Hasura Enterprise Edition to monitor your GraphQL API.
+
+
+
diff --git a/docs/docs/event-triggers/clean-up/auto-cleanup.mdx b/docs/docs/event-triggers/clean-up/auto-cleanup.mdx
index 8e8cf99ddba..b1d0cfa15dd 100644
--- a/docs/docs/event-triggers/clean-up/auto-cleanup.mdx
+++ b/docs/docs/event-triggers/clean-up/auto-cleanup.mdx
@@ -1,5 +1,5 @@
---
-sidebar_label: Auto cleanup
+sidebar_label: Auto cleanup ☁️🏢
description: Cleanup Event Trigger logs for Hasura Cloud/Enterprise Edition
title: 'Auto cleanup of Event Trigger logs'
keywords:
diff --git a/docs/docs/event-triggers/create-trigger.mdx b/docs/docs/event-triggers/create-trigger.mdx
index 3e554d6850c..191fb3098b8 100644
--- a/docs/docs/event-triggers/create-trigger.mdx
+++ b/docs/docs/event-triggers/create-trigger.mdx
@@ -1,6 +1,6 @@
---
sidebar_label: Create an Event Trigger
-sidebar_position: 1
+sidebar_position: 1.5
description: Create an Event Trigger with Hasura
keywords:
- hasura
@@ -20,6 +20,21 @@ import Thumbnail from '@site/src/components/Thumbnail';
Event Triggers can be created using the Hasura Console, Hasura CLI, or Metadata APIs. Currently, support for event
triggers exists for Postgres and MSSQL databases.
+:::info Note
+
+- Event Triggers are supported for **Postgres and MS SQL Server** databases.
+- Event webhook notifications will be delivered at least once, and may arrive out of order with respect to the
+underlying event.
+
+:::
+
+:::caution Caveat on different Hasura instances connected to the same database
+
+Event Triggers store their data in the underlying database and hence different instances acting on the same data can
+cause undefined behavior during run-time. This should not be a problem if the Hasura instances have the same metadata.
+
+:::
+
## Creating triggers
diff --git a/docs/docs/event-triggers/index.mdx b/docs/docs/event-triggers/index.mdx
deleted file mode 100644
index c8bd958c433..00000000000
--- a/docs/docs/event-triggers/index.mdx
+++ /dev/null
@@ -1,59 +0,0 @@
----
-description: Manage Event Triggers with Hasura
-title: Event Triggers
-keywords:
- - hasura
- - docs
- - event trigger
-slug: index
----
-
-import Thumbnail from '@site/src/components/Thumbnail';
-import EventTriggers from '@site/static/icons/features/event_triggers.svg';
-
-# Event Triggers
-
-## Introduction
-
-Hasura can be used to create Event Triggers on tables in the database. Event Triggers reliably capture events on
-specified tables and invoke HTTP webhooks to carry out any custom logic.
-
-
-
-Events can be of the following types:
-
-- INSERT: When a row is inserted into a table
-- UPDATE: When a row is updated in a table
-- DELETE: When a row is deleted from a table
-- MANUAL: Using the Console or API, an event can be triggered manually on a row
-
-:::info Note
-
-- Event Triggers are supported for **Postgres and MS SQL Server** databases.
-- Event webhook notifications will be delivered at least once, and may arrive out of order with respect to the
- underlying event.
-
-:::
-
-:::caution Caveat on different Hasura instances connected to the same database
-
-Event Triggers store their data in the underlying database and hence different instances acting on the same data can
-cause undefined behavior during run-time. This should not be a problem if the Hasura instances have the same metadata.
-
-:::
-
-## Learn more
-
-- [Creating an Event Trigger](/event-triggers/create-trigger.mdx)
-- [Event Trigger payload](/event-triggers/payload.mdx)
-- [REST Connectors for Event Triggers](/event-triggers/rest-connectors.mdx)
-- [Invoke trigger manually](/event-triggers/invoke-trigger-manually.mdx)
-- [Using serverless functions](/event-triggers/serverless.mdx)
-- [Event Trigger samples](/event-triggers/samples.mdx)
-- [Clean up event data](/event-triggers/clean-up/index.mdx)
-- [Remove Event Triggers](/event-triggers/remove-event-triggers.mdx)
diff --git a/docs/docs/event-triggers/overview.mdx b/docs/docs/event-triggers/overview.mdx
new file mode 100644
index 00000000000..02050b5eed5
--- /dev/null
+++ b/docs/docs/event-triggers/overview.mdx
@@ -0,0 +1,72 @@
+---
+description: Hasura Event Triggers
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - event triggers
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import VersionedLink from '@site/src/components/VersionedLink';
+import EventTriggers from '@site/static/icons/features/event_triggers.svg';
+import Thumbnail from '@site/src/components/Thumbnail';
+
+# Event Triggers
+
+
+
+
+ Hasura Event triggers are a way to automate asynchronous logic when changes are made in a connected database.
+
+
+ Event Triggers can be configured to activate when there is an INSERT, UPDATE or
+ DELETE event in a table.
+ Additionally, you can manually trigger an event through a button set up in the Hasura Console.
+
+
Quick Links
+
+
+ Quickstart with Event Triggers.
+
+
+
+
+
+
+
+
+
+## Event Trigger Links
+
+
+
+
+
Payload structure
+
Check out the format and structure of the request payload.
+
+
+
+
+
Call a serverless endpoint
+
Call serverless functions with Event Triggers to not have to manage any dedicated infrastructure.
+
+
+
+
+
Invoke a trigger manually
+
Optionally set an Event Trigger to be invoked with a button in the Console.
+
+
+
diff --git a/docs/docs/event-triggers/quickstart.mdx b/docs/docs/event-triggers/quickstart.mdx
new file mode 100644
index 00000000000..6879d005c1f
--- /dev/null
+++ b/docs/docs/event-triggers/quickstart.mdx
@@ -0,0 +1,77 @@
+---
+description: Quickstart with Event Triggers
+title: Quickstart
+keywords:
+ - hasura
+ - docs
+ - event triggers
+sidebar_position: 1.3
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import SampleAppBlock from '@site/src/components/SampleAppBlock';
+
+# Quickstart Event Triggers
+
+Let's imagine that we want to send a welcome email to every new user who signs up. We can do this by creating an Event
+Trigger that calls out to a webhook whenever a new user is inserted into the `users` table. The webhook payload will
+contain the user's email address, and we can use this in the endpoint which we create to send them the welcome email.
+
+
+
+## Step 1: Navigate to Event Triggers {#step-2}
+
+To create an Event Trigger, navigate to the `Event` tab in the Console and click the `Create` button while on the
+`Event Triggers` tab in the left navigation.
+
+
+
+## Step 2: Create a new Event Trigger {#step-3}
+
+On the Event Trigger creation page, input the name of the trigger, `send_welcome_email`, and select the database, schema
+and table that the trigger will be listening to. In this case we'll be listening to the `users` table for an INSERT
+event.
+
+For the endpoint to call when the event is triggered, we'll use the `https://httpbin.org/post` endpoint. This is a demo
+endpoint which will just return a `200` success status code and the data that we initially sent it.
+
+For now, ignore `Auto-cleanup Event Logs`, `Advanced Settings` and `Configure REST Connectors`.
+
+Click `Create Event Trigger` to create the Event Trigger.
+
+
+
+## Step 3: Test the Event Trigger {#step-4}
+
+Now that we've created the Event Trigger, let's test it out by inserting a new user into the `users` table. To do this,
+navigate to the `Data` tab in the Console and click the `Insert Row` tab in the `users` table. Insert some dummy data
+and click `Save`.
+
+
+
+## Step 4: Check the Event Logs {#step-5}
+
+Navigate back to the `send_welcome_email` Event Trigger and click the `Processed Events` tab. You should see a new log
+showing a successfully delivered event as it received a `200` status code as the response. You can inspect the `Request`
+and `Response` tabs to see exactly what data was sent to and received from the `httpbin.org` endpoint.
+
+
+
+## Recap
+
+What just happened? Congrats! You just called a remote endpoint asynchronously when something happened in your database
+and your user (theoretically) received a welcome email. 🎉
+
+In a real world scenario, you would create a custom endpoint to send the welcome email, but in this example we showed
+you just the mechanics of how to create an Event Trigger and test it out.
+
+You can enable your Event Triggers for any table and event type, INSERT, UPDATE or DELETE, and you can also enable the
+[manual invocation of your Event Trigger via a button in the Console](/event-triggers/invoke-trigger-manually.mdx).
+
+You can also thoroughly customize your Event Triggers to your needs using the
+[`Retry Configuration`](/event-triggers/create-trigger.mdx/#retry-logic),
+[`Advanced Settings`](/event-triggers/create-trigger.mdx#advanced-settings) and
+[`Configure REST Connectors`](/event-triggers/rest-connectors.mdx) options.
diff --git a/docs/docs/faq.mdx b/docs/docs/faq.mdx
index e65ae095453..d2e1d4b6b69 100644
--- a/docs/docs/faq.mdx
+++ b/docs/docs/faq.mdx
@@ -37,7 +37,7 @@ import FAQ from '@site/static/icons/features/faq.svg';
## What databases does Hasura support? {#faq-db}
-Check out the list of [compatible databases](/databases/index.mdx#supported-databases).
+Check out the list of [compatible databases](/databases/overview.mdx).
## How does Hasura work? {#faq-how-hasura-works}
@@ -69,7 +69,7 @@ The easiest and fastest way to get Hasura up and running quickly is by using our
## What does my first-time demo experience look like?
Using the Hasura Console, click on the Data tab and connect up a new Postgres database from our partner company
-[Neon](/databases/connect-db/cloud-databases/neon.mdx). Then create tables, insert some demo data and test out some
+[Neon](/databases/postgres/neon.mdx). Then create tables, insert some demo data and test out some
queries and mutations using the GraphiQL interface in the API tab. Alternatively, from your connected database in the
Data tab, try one of our demo templates from the Template Gallery which can demonstrate key Hasura features for you
quickly. If you already have an existing database with tables and data you can also just have Hasura connect to it,
@@ -82,9 +82,9 @@ popularity due to its unique features, benefits and advantages over REST APIs an
As opposed to multiple disparate endpoints with REST APIs, GraphQL uses one `POST`-enabled endpoint which can service
many types of data requests from the client. Queries, mutations and subscriptions are made with a simple and intuitive
-syntax which describes the shape of the resulting data, so you know exactly what you're getting back. This
-declarative syntax makes it easier to understand and reason about the code and allows for more complex, nested, joined,
-queries to be written in a simple, clear and concise way.
+syntax which describes the shape of the resulting data, so you know exactly what you're getting back. This declarative
+syntax makes it easier to understand and reason about the code and allows for more complex, nested, joined, queries to
+be written in a simple, clear and concise way.
GraphQL allows developers to retrieve only the data they need and nothing more, resolving problems with over and
under-fetching. This can lead to faster and more efficient performance and reduced network traffic.
@@ -96,8 +96,8 @@ GraphQL has a thriving ecosystem of libraries, tools, and services that make it
things like code generators, testing frameworks, and middleware.
Overall, GraphQL is a powerful tool for building APIs that are flexible, efficient, and easy to use. Its popularity
-continues to grow, and it is likely to become an increasingly important part of more developers and businesses
-toolkits in the coming years.
+continues to grow, and it is likely to become an increasingly important part of more developers and businesses toolkits
+in the coming years.
## How do I manage my database once it's connected to Hasura?
@@ -134,15 +134,16 @@ or a similar CI/CD service to build a custom deployment pipeline for your Hasura
## How can I preview changes to my Hasura instance?
-With [Preview Apps](/hasura-cloud/ci-cd/preview-apps.mdx) on Hasura Cloud you can automatically create an app on
-Hasura Cloud for every pull request you make to your GitHub repo enabling quick and easy testing of changes as you work.
+With [Preview Apps](/hasura-cloud/ci-cd/preview-apps.mdx) on Hasura Cloud you can automatically create an app on Hasura
+Cloud for every pull request you make to your GitHub repo enabling quick and easy testing of changes as you work.
## How would I work collaboratively with my team using Hasura?
-Using [Projects](/hasura-cloud/projects/index.mdx) in Hasura Cloud you are able to add collaborators and assign each different access
-permissions on your instance. Since the Hasura [Metadata and Migrations](/migrations-metadata-seeds/index.mdx) can be
-committed to version control, you can also use the user permissions systems of a version control host (eg: GitHub) in
-order to control how your team collaborates on your Hasura Project.
+Using [Projects](/hasura-cloud/projects/index.mdx) in Hasura Cloud you are able to add collaborators and assign each
+different access permissions on your instance. Since the Hasura
+[Metadata and Migrations](/migrations-metadata-seeds/overview.mdx) can be committed to version control, you can also use
+the user permissions systems of a version control host (eg: GitHub) in order to control how your team collaborates on
+your Hasura Project.
## How do I connect business logic or extend the GraphQL schema? {#faq-business-logic}
@@ -156,7 +157,7 @@ the GraphQL schema that Hasura exposes. This is useful not just when you have le
transactional or application logic, but also when you want to build and serve custom logic with cloud-native code
deployed as containers or serverless functions.
-- Read more about [Hasura Actions](/actions/index.mdx).
+- Read more about [Hasura Actions](/actions/overview.mdx).
### Hasura Event Triggers:
@@ -166,7 +167,7 @@ pieces of logic to events, this is especially useful if you’re thinking about
applications.
- Read more about this architecture at [https://3factor.app](https://3factor.app).
-- Read more about Event Triggers in the Hasura [docs](/event-triggers/index.mdx).
+- Read more about Event Triggers in the Hasura [docs](/event-triggers/overview.mdx).
- Go through a quick tutorial on how to set Event Triggers up at [https://learn.hasura.io](https://learn.hasura.io).
### GraphQL APIs via Hasura Remote Schemas:
@@ -176,7 +177,7 @@ custom logic, or if you’d like to extend your overall GraphQL API with a “su
may not directly own, you can use “Remote Schemas” in Hasura to bring in GraphQL services as data & logic providers to
your GraphQL API.
-- Read more about [Remote Schemas](/remote-schemas/index.mdx).
+- Read more about [Remote Schemas](/remote-schemas/overview.mdx).
### Stored procedures / functions in the database:
diff --git a/docs/docs/getting-started/docker-simple.mdx b/docs/docs/getting-started/docker-simple.mdx
index 2e5dcbb26b5..429d8a90069 100644
--- a/docs/docs/getting-started/docker-simple.mdx
+++ b/docs/docs/getting-started/docker-simple.mdx
@@ -1,5 +1,6 @@
---
sidebar_label: Quickstart with Hasura using Docker
+title: 'Quickstart with Docker'
sidebar_position: 3
description: Get started with Hasura using Docker
keywords:
@@ -103,17 +104,17 @@ CRUD GraphQL API for our Postgres database which we could then easily query, mut
The Hasura CLI is a powerful tool that helps you manage your Hasura project and is recommended for the majority of
development workflows. It helps track and manage your
-[Hasura Metadata and Migrations](/migrations-metadata-seeds/index.mdx) and commit them to version control and allows you
-to quickly move between environments like development and production.
+[Hasura Metadata and Migrations](/migrations-metadata-seeds/overview.mdx) and commit them to version control and allows
+you to quickly move between environments like development and production.
### Database operations
We omitted the CLI steps in this guide for the sake of simplicity and brevity, but in a typical new project, you would
always include the CLI setup steps.
-Every developer working with Hasura should have the Hasura CLI installed. You can do so by
-[following this guide](/hasura-cli/install-hasura-cli.mdx) and learn more by checking out our
-[Advanced Hasura course](https://hasura.io/learn/graphql/hasura-advanced/introduction/).
+Every developer working with Hasura should have the [Hasura CLI installed](/hasura-cli/install-hasura-cli.mdx). You can
+quickly get up and running with a new project [using the CLI quickstart](/hasura-cli/quickstart.mdx) and learn more by
+checking out our [Advanced Hasura course](https://hasura.io/learn/graphql/hasura-advanced/introduction/).
:::
@@ -124,14 +125,14 @@ Every developer working with Hasura should have the Hasura CLI installed. You ca
- There are several options for the implementation of business logic, depending on your use case.
- - [Actions](/actions/index.mdx): Actions can be used if you'd like to extend your GraphQL schema by integrating with a
- REST endpoint.
- - [Remote Schemas](/remote-schemas/index.mdx): If you have an existing GraphQL server or if you're comfortable with
+ - [Actions](/actions/overview.mdx): Actions can be used if you'd like to extend your GraphQL schema by integrating
+ with a REST endpoint.
+ - [Remote Schemas](/remote-schemas/overview.mdx): If you have an existing GraphQL server or if you're comfortable with
implementing one, you can use Remote Schemas.
- - [Event Triggers](/event-triggers/index.mdx): To trigger a serverless function based on a database event, use Event
- Triggers.
- - [Scheduled Triggers](/scheduled-triggers/index.mdx): Scheduled Triggers are used to execute custom business logic at
- specific points in time.
+ - [Event Triggers](/event-triggers/overview.mdx): To trigger a serverless function based on a database event, use
+ Event Triggers.
+ - [Scheduled Triggers](/scheduled-triggers/overview.mdx): Scheduled Triggers are used to execute custom business logic
+ at specific points in time.
- If you're new to database modeling, check out these guides:
@@ -140,16 +141,9 @@ Every developer working with Hasura should have the Hasura CLI installed. You ca
- [Querying data](/queries/postgres/index.mdx): Use GraphQL queries to query data from your GraphQL API.
- [Inserting data](/mutations/postgres/index.mdx): Use GraphQL mutations to insert data into your GraphQL API.
-- **Security Announcements**: Join the [Hasura Security Announcements](https://groups.google.com/forum/#!forum/hasura-security-announce) group for
-emails about security announcements.
-
+- **Security Announcements**: Join the
+ [Hasura Security Announcements](https://groups.google.com/forum/#!forum/hasura-security-announce) group for emails
+ about security announcements.
- We release new features every month. Sign up for our newsletter by using the link below. We send newsletters only once
a month. .
-
-:::info Additional Resources
-
-Get Started with Hasura today -
-[Watch video guide](https://hasura.io/events/webinar/get-started-with-hasura/?pg=docs&plcmt=body&cta=getting-started&tech=).
-
-:::
diff --git a/docs/docs/getting-started/getting-started-cloud.mdx b/docs/docs/getting-started/getting-started-cloud.mdx
index db2e591a3ac..b671968af96 100644
--- a/docs/docs/getting-started/getting-started-cloud.mdx
+++ b/docs/docs/getting-started/getting-started-cloud.mdx
@@ -1,13 +1,13 @@
---
description: Quickstart with Hasura Cloud
-title: 'Cloud: Quickstart with Hasura Cloud'
+title: 'Quickstart with Hasura Cloud'
sidebar_position: 2
keywords:
- hasura
- cloud
- docs
- signup
-sidebar_label: Quickstart with Hasura Cloud
+sidebar_label: Quickstart with Hasura Cloud ☁️
sidebar_class_name: cloud-icon
---
@@ -68,28 +68,8 @@ Click `Connect Database`.
-If your database is hosted via any of the following managed cloud database services, check out their respective detailed
-guides to get the database connection URL and any other steps required to ensure connectivity from Hasura Cloud:
-
-- [Aiven Postgres](/databases/connect-db/cloud-databases/aiven.mdx)
-- [AlloyDB Postgres](/databases/connect-db/cloud-databases/alloy.mdx)
-- [AWS RDS Aurora Postgres](/databases/connect-db/cloud-databases/aws-aurora.mdx)
-- [AWS RDS Postgres](/databases/connect-db/cloud-databases/aws-postgres.mdx)
-- [Azure Cosmos DB](/databases/connect-db/cloud-databases/azure-cosmos.mdx)
-- [Azure MS SQL](/databases/connect-db/cloud-databases/mssql.mdx)
-- [Azure Postgres](/databases/connect-db/cloud-databases/azure.mdx)
-- [Crunchy Postgres](/databases/connect-db/cloud-databases/crunchy.mdx)
-- [DigitalOcean Postgres](/databases/connect-db/cloud-databases/digital-ocean.mdx)
-- [ElephantSQL Postgres](/databases/connect-db/cloud-databases/elephant.mdx)
-- [EnterpriseDB (BigAnimal) Postgres](/databases/connect-db/cloud-databases/enterprisedb.mdx)
-- [GCP Postgres](/databases/connect-db/cloud-databases/gcp.mdx)
-- [Heroku Postgres](/databases/connect-db/cloud-databases/heroku.mdx)
-- [Neon Postgres](/databases/connect-db/cloud-databases/neon.mdx)
-- [Railway Postgres](/databases/connect-db/cloud-databases/railway.mdx)
-- [Render Postgres](/databases/connect-db/cloud-databases/render.mdx)
-- [Supabase Postgres](/databases/connect-db/cloud-databases/supabase.mdx)
-- [TimescaleDB Cloud](/databases/connect-db/cloud-databases/timescale-cloud.mdx)
-- [YugabyteDB](/databases/connect-db/cloud-databases/yugabyte.mdx)
+Check out our [extensive list of databases](/databases/overview.mdx) that Hasura Cloud supports in order to get the
+database connection URL and for other steps required to ensure connectivity from Hasura Cloud.
## Step 4: Try out Hasura
@@ -142,22 +122,24 @@ For a full hands-on tour of Hasura, check out our
### Database operations
+- [Databases overview](/databases/overview.mdx)
- [Database modeling](/schema/postgres/index.mdx): Learn how to model your database schema, as well as how to extend it.
- [Querying data](/queries/postgres/index.mdx): Use GraphQL queries to query data from your GraphQL API.
- [Inserting data](/mutations/postgres/index.mdx): Use GraphQL mutations to insert data into your GraphQL API.
+- [Postgres permissions](/deployment/postgres-requirements.mdx#managed-pg-permissions)
### Business logic
There are several options for the implementation of business logic, depending on your use case.
-- [Actions](/actions/index.mdx): Actions can be used if you'd like to extend your GraphQL schema by integrating with a
- REST endpoint.
-- [Remote Schemas](/remote-schemas/index.mdx): If you have an existing GraphQL server or if you're comfortable with
+- [Actions](/actions/overview.mdx): Actions can be used if you'd like to extend your GraphQL schema by integrating with
+ a REST endpoint.
+- [Remote Schemas](/remote-schemas/overview.mdx): If you have an existing GraphQL server or if you're comfortable with
implementing one, you can use Remote Schemas.
-- [Event Triggers](/event-triggers/index.mdx): To trigger a serverless function based on a database event, use event
+- [Event Triggers](/event-triggers/overview.mdx): To trigger a serverless function based on a database event, use event
triggers.
-- [Scheduled Triggers](/scheduled-triggers/index.mdx): Scheduled Triggers are used to execute custom business logic at
- specific points in time.
+- [Scheduled Triggers](/scheduled-triggers/overview.mdx): Scheduled Triggers are used to execute custom business logic
+ at specific points in time.
### Manage Hasura Cloud project
@@ -166,13 +148,3 @@ You can click the gear icon in the Hasura Cloud dashboard to manage your Hasura
[custom domains](/hasura-cloud/projects/domains.mdx)).
-
-:::info Additional Resources
-
-Get Started with Hasura today -
-[Watch video guide](https://hasura.io/events/webinar/get-started-with-hasura/?pg=docs&plcmt=body&cta=getting-started&tech=).
-
-:::
-
-- [Cloud databases guides](/databases/connect-db/cloud-databases/index.mdx)
-- [Postgres permissions](/deployment/postgres-requirements.mdx#managed-pg-permissions)
diff --git a/docs/docs/getting-started/how-it-works/index.mdx b/docs/docs/getting-started/how-it-works/index.mdx
index 558bf5de2f3..ab11122a4f8 100644
--- a/docs/docs/getting-started/how-it-works/index.mdx
+++ b/docs/docs/getting-started/how-it-works/index.mdx
@@ -23,7 +23,7 @@ engine for powering your API.
Given a database, the Hasura GraphQL Engine automatically generates a GraphQL schema and processes GraphQL queries,
subscriptions and mutations.
-By default, Hasura supports [PostgreSQL and multiple other databases](/databases/index.mdx#supported-databases).
+By default, Hasura supports [PostgreSQL and multiple other databases](/databases/overview.mdx).
## Tracking Tables & Schema Generation
@@ -53,7 +53,7 @@ When you track a table in the Hasura GraphQL Engine, it automatically generates
## Views
-When you track a view with a [database which supports views](/databases/index.mdx#schema) in Hasura GraphQL Engine,
+When you track a view with a [database which supports views](/databases/feature-support.mdx) in Hasura GraphQL Engine,
it also automatically generates the same as the above but without the `_by_pk` fields. Depending on the type of
view created, Hasura may not generate the `insert`, `update` and `delete` mutation fields.
diff --git a/docs/docs/getting-started/index.mdx b/docs/docs/getting-started/index.mdx
deleted file mode 100644
index 9dc083c134c..00000000000
--- a/docs/docs/getting-started/index.mdx
+++ /dev/null
@@ -1,67 +0,0 @@
----
-title: Get started
-description: Get started with Hasura
-keywords:
- - hasura
- - docs
- - start
- - core
- - cloud
- - get started
-slug: index
----
-
-import HeadingIcon from '@site/src/components/HeadingIcon';
-import Basics from '@site/static/icons/features/basics.svg';
-
-# Get Started
-
-## Introduction
-
-To use the Hasura GraphQL Engine, you'll need to:
-
-- Deploy the Hasura GraphQL Engine, with access to a Postgres database to store its metadata.
-- Connect new/existing database(s) and set up and test your GraphQL API using the Hasura Console UI (also possible via
- CLI or API).
-- Consume the generated GraphQL API from your client apps.
-
-You have a couple of options when getting started.
-
-### Hasura Cloud
-
-[Hasura Cloud](https://cloud.hasura.io) is the preferred choice when getting started. Hasura Cloud is a hosted service
-for Hasura GraphQL Engine projects with added features for reliability and security. If you're looking for the least
-friction between trying out Hasura and moving into production,
-[check out this quickstart guide](/getting-started/getting-started-cloud.mdx) and **get started for free**.
-
-### Docker Compose
-
-Alternatively, if you'd like to get a local version up and running that you can eventually deploy to a host of your
-choice, [check out our quickstart using Docker Compose](/getting-started/docker-simple.mdx). At its heart, Hasura is
-open-source and within minutes you'll have a fully functional Hasura GraphQL Engine instance running locally with which
-you can experiment. If you're looking to learn more about Hasura GraphQL Engine's core features and see if it's right
-for you, consider this option.
-
-### Supported databases
-
-Regardless of which option above you choose, Hasura GraphQL Engine supports:
-
-- [Postgres](/databases/postgres/index.mdx)
-- [MS SQL Server](/databases/ms-sql-server/index.mdx)
-- [Citus / Hyperscale](/databases/postgres/citus-hyperscale-postgres/index.mdx)
-- [BigQuery](/databases/bigquery/index.mdx)
-- [Snowflake](/databases/snowflake/index.mdx)
-- [Amazon Athena](/databases/athena/index.mdx)
-- [MySQL Alpha](/databases/mysql/index.mdx)
-
-
-
-:::info Additional Resources
-
-Get Started with Hasura today -
-[Watch video guide](https://hasura.io/events/webinar/get-started-with-hasura/?pg=docs&plcmt=body&cta=getting-started&tech=).
-
-Additionally, check out our [Hasura Basics](https://hasura.io/learn/graphql/hasura/introduction/) course for a
-step-by-step deep dive!
-
-:::
diff --git a/docs/docs/getting-started/overview.mdx b/docs/docs/getting-started/overview.mdx
new file mode 100644
index 00000000000..b7b882da6c1
--- /dev/null
+++ b/docs/docs/getting-started/overview.mdx
@@ -0,0 +1,49 @@
+---
+description: Get started with Hasura
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - get started
+ - docker
+ - cloud
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Basics from '@site/static/icons/features/basics.svg';
+
+# Getting Started with Hasura
+
+
+
+
+ The Hasura GraphQL Engine is a blazingly-fast GraphQL server that gives you instant, real-time GraphQL APIs over many popular databases and other data sources.
+
+
+ You can quickly get started with Hasura by using Hasura Cloud, our hosted platform, or by running
+ it on your own infrastructure.
+
+
Quick Links
+
+
+ Get started using Hasura Cloud.
+
+
+ Get started using Docker or check out one of our deployment guides.
+
+
+
+ To learn more about the functionalities of Hasura, check out how it works.
+
+
+
+
+
diff --git a/docs/docs/graphql-api-explorer.mdx b/docs/docs/graphql-api-explorer.mdx
index 9557b126b6f..8996e848ba4 100644
--- a/docs/docs/graphql-api-explorer.mdx
+++ b/docs/docs/graphql-api-explorer.mdx
@@ -10,7 +10,7 @@ keywords:
- public
- graphQL
- graphiQL
-sidebar_label: GraphQL API Explorer
+sidebar_label: GraphQL API Explorer ☁️
sidebar_position: 240
sidebar_class_name: cloud-icon
# adding index slug in case this root doc becomes a directory later
diff --git a/docs/docs/hasura-cli/commands/_category_.json b/docs/docs/hasura-cli/commands/_category_.json
index 1d6f7616e28..e6ef82b0917 100644
--- a/docs/docs/hasura-cli/commands/_category_.json
+++ b/docs/docs/hasura-cli/commands/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Commands",
- "position": 2
+ "position": 3
}
diff --git a/docs/docs/hasura-cli/config-reference.mdx b/docs/docs/hasura-cli/config-reference.mdx
index 896cdca1cdb..a0105a703f3 100644
--- a/docs/docs/hasura-cli/config-reference.mdx
+++ b/docs/docs/hasura-cli/config-reference.mdx
@@ -23,8 +23,8 @@ When using the Hasura CLI, you'll pass various values to different commands. The
:::info Note
-The order of precedence by which the CLI processes these values is flag -> environment variables -> `.env` file
-values -> configuration file values -> default.
+The order of precedence by which the CLI processes these values is flag -> environment variables -> `.env` file values
+-> configuration file values -> default.
In the sections below, we'll explain how to configure the CLI for each of these use cases.
@@ -103,8 +103,8 @@ defaults to `.env` if you don't provide it.
It's important to note that this will not override an environment variable that already exists.
-As an example, the command below will read environment variables from the `production.env` file present at the
-project's root directory.
+As an example, the command below will read environment variables from the `production.env` file present at the project's
+root directory.
```bash
hasura console --envfile production.env
@@ -130,11 +130,11 @@ the CLI:
| `HASURA_GRAPHQL_ACCESS_KEY` | `access_key` | Access key for Hasura GraphQL Engine. Note: Deprecated. Use admin secret instead. |
| `HASURA_GRAPHQL_INSECURE_SKIP_TLS_VERIFY` | `insecure_skip_tls_verify` | Skip verifying SSL certificate for the Hasura endpoint. Useful if you have a self-singed certificate and don't have access to the CA cert. |
| `HASURA_GRAPHQL_CERTIFICATE_AUTHORITY` | `certificate_authority` | Path to the CA certificate for validating the self-signed certificate for the Hasura endpoint. |
-| `HASURA_GRAPHQL_API_PATHS_QUERY` | `api_paths.query` | Schema/ Metadata API endpoint. More details at [Schema / Metadata API (Deprecated)](/api-reference/index.mdx#schema-metadata-api). |
-| `HASURA_GRAPHQL_API_PATHS_GRAPHQL` | `api_paths.graphql` | GraphQL API endpoint. More details at [GraphQL API](/api-reference/index.mdx#graphql-api). |
-| `HASURA_GRAPHQL_API_PATHS_CONFIG` | `api_paths.config` | Config API endpoint. More details at [Config API](/api-reference/index.mdx#config-api)`. |
-| `HASURA_GRAPHQL_API_PATHS_PG_DUMP` | `api_paths.pg_dump` | PG Dump API endpoint. More details at [pg_dump API](/api-reference/index.mdx#pg-dump-api). |
-| `HASURA_GRAPHQL_API_PATHS_VERSION` | `api_paths.version` | Version API endpoint. More details at [RESTified GraphQL API](/api-reference/index.mdx#version-api). |
+| `HASURA_GRAPHQL_API_PATHS_QUERY` | `api_paths.query` | Schema/ Metadata API endpoint. More details at [Schema / Metadata API (Deprecated)](/api-reference/overview.mdx#schema-metadata-api). |
+| `HASURA_GRAPHQL_API_PATHS_GRAPHQL` | `api_paths.graphql` | GraphQL API endpoint. More details at [GraphQL API](/api-reference/overview.mdx#graphql-api). |
+| `HASURA_GRAPHQL_API_PATHS_CONFIG` | `api_paths.config` | Config API endpoint. More details at [Config API](/api-reference/overview.mdx#config-api)`. |
+| `HASURA_GRAPHQL_API_PATHS_PG_DUMP` | `api_paths.pg_dump` | PG Dump API endpoint. More details at [pg_dump API](/api-reference/overview.mdx#pg-dump-api). |
+| `HASURA_GRAPHQL_API_PATHS_VERSION` | `api_paths.version` | Version API endpoint. More details at [RESTified GraphQL API](/api-reference/overview.mdx#version-api). |
| `HASURA_GRAPHQL_METADATA_DIRECTORY` | `metadata_directory` | Defines the directory where the Metadata files were stored. |
| `HASURA_GRAPHQL_MIGRATIONS_DIRECTORY` | `migrations_directory` | Defines the directory where the migration files were stored. |
| `HASURA_GRAPHQL_SEEDS_DIRECTORY` | `seeds_directory` | Defines the directory where the seed files were stored. |
diff --git a/docs/docs/hasura-cli/index.mdx b/docs/docs/hasura-cli/index.mdx
deleted file mode 100644
index 8ef97a6184a..00000000000
--- a/docs/docs/hasura-cli/index.mdx
+++ /dev/null
@@ -1,51 +0,0 @@
----
-title: Hasura CLI
-description: Use Hasura's command line tooling
-keywords:
- - hasura
- - docs
- - CLI
-slug: index
----
-
-import CLI from '@site/static/icons/features/cli.svg';
-
-# Hasura CLI
-
-## Introduction
-
-The Hasura CLI is a command-line tool you can use to manage your Hasura instances.
-
-We offer two primary methods for working with your Hasura instances: the Hasura Console and the Hasura CLI. While the
-Console is robust and provides an easy-to-navigate GUI for interacting with your project, the CLI offers a more powerful
-interface for managing your project.
-
-The CLI is useful for:
-
-- [managing Metadata](/migrations-metadata-seeds/manage-metadata.mdx).
-- [creating and applying Migrations](/migrations-metadata-seeds/manage-migrations.mdx).
-- integrating with your CI/CD pipeline.
-- automating tasks.
-
-You can use the CLI to initialize a new Hasura Project from the very beginning, or you can use it to manage an
-existing one.
-
-## Installation
-
-Install the Hasura CLI by executing the following command in your terminal:
-
-```bash
-curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | bash
-```
-
-For more details, check out our [installation guide](/hasura-cli/install-hasura-cli.mdx).
-
-## Usage
-
-The CLI has a number of commands you can use to manage your project. You can see the full list of commands by running:
-`hasura --help`.
-
-There are many subcommands too; you can see the available subcommands and their arguments by running a command with the
-`--help` flag, for example: `hasura metadata --help`.
-
-After installing, we suggest getting started by heading to the [CLI commands reference](/hasura-cli/commands/index.mdx).
diff --git a/docs/docs/hasura-cli/install-hasura-cli.mdx b/docs/docs/hasura-cli/install-hasura-cli.mdx
index 925f024b7e4..1c79acc417c 100644
--- a/docs/docs/hasura-cli/install-hasura-cli.mdx
+++ b/docs/docs/hasura-cli/install-hasura-cli.mdx
@@ -1,6 +1,6 @@
---
sidebar_label: Install / Uninstall
-sidebar_position: 1
+sidebar_position: 3
description: Install the Hasura CLI on Linux, Mac OS, Windows
keywords:
- hasura
@@ -80,7 +80,7 @@ curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | VERSION
Download the binary `cli-hasura-windows-amd64.exe` available under `Assets` of the latest release from the GitHub
release page :
-https://github.com/hasura/graphql-engine/releases
+https://github.com/hasura/graphql-engine/releases
Rename the downloaded file to `hasura`. You can add the path to the environment variable `PATH` for making `hasura`
accessible globally.
@@ -98,7 +98,8 @@ To add command auto-completion in your shell, refer to the
### Install through npm
The Hasura CLI is available as an [npm package](https://www.npmjs.com/package/hasura-cli) which wraps the compiled
-binary and is **independently maintained by members of the community. Hasura does not offer maintenance or support for this package**.
+binary and is **independently maintained by members of the community. Hasura does not offer maintenance or support for
+this package**.
## Uninstall the Hasura CLI
diff --git a/docs/docs/hasura-cli/overview.mdx b/docs/docs/hasura-cli/overview.mdx
new file mode 100644
index 00000000000..bf326c31eca
--- /dev/null
+++ b/docs/docs/hasura-cli/overview.mdx
@@ -0,0 +1,77 @@
+---
+title: Hasura CLI
+description: Use Hasura's command line tooling
+keywords:
+ - hasura
+ - docs
+ - CLI
+hide_table_of_contents: true
+sidebar_position: 1
+sidebar_label: Overview
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import CLI from '@site/static/icons/features/cli.svg';
+
+# Hasura CLI
+
+
+
+
+ We offer two primary methods for working with your Hasura instances: the Hasura Console and the Hasura CLI. While
+ the Console provides an easy-to-use GUI for interacting with your project, the CLI offers a powerful, text-based
+ interface for managing your project.
+
+
+ The Hasura CLI is a command line tool that acts as an interface to the Hasura GraphQL Engine's Metadata API,
+ providing a set of commands that you can use to create, migrate, and manage your Hasura projects.
+
+
Quick Links
+
+
+ Create a project with the Hasura CLI in 60 seconds.
+
+
+ View all the available commands.
+
+
+
+
+
+
+## Using the CLI
+
+
+
+
+
Install the Hasura CLI
+
Learn how to install the Hasura CLI using the binaries or a package manager.
+
+
+
+
+
+ The hasura console command
+
+
+ Learn how to use the hasura console command to launch the Hasura Console via the CLI and track
+ Metadata changes.
+
+
+
+
+
+
Configure the CLI
+
+ Learn how to configure the Hasura CLI to connect to your Hasura instance and to use the Hasura CLI with multiple
+ projects.
+
+
+
+
diff --git a/docs/docs/hasura-cli/pro-cli/_category_.json b/docs/docs/hasura-cli/pro-cli/_category_.json
index edb7e91a91a..907b5ea30ae 100644
--- a/docs/docs/hasura-cli/pro-cli/_category_.json
+++ b/docs/docs/hasura-cli/pro-cli/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Hasura Pro CLI",
- "position": 20
+ "position": 5
}
diff --git a/docs/docs/hasura-cli/pro-cli/index.mdx b/docs/docs/hasura-cli/pro-cli/index.mdx
index ed127908372..2fc67827c4a 100644
--- a/docs/docs/hasura-cli/pro-cli/index.mdx
+++ b/docs/docs/hasura-cli/pro-cli/index.mdx
@@ -5,7 +5,7 @@ keywords:
- docs
- command line interface
- cli
-sidebar_label: Hasura Pro CLI
+sidebar_label: Hasura Pro CLI ☁️
sidebar_class_name: cloud-icon
---
diff --git a/docs/docs/hasura-cli/pro-cli/installing-uninstalling.mdx b/docs/docs/hasura-cli/pro-cli/installing-uninstalling.mdx
index 46a782e8b36..4da8d0f846b 100644
--- a/docs/docs/hasura-cli/pro-cli/installing-uninstalling.mdx
+++ b/docs/docs/hasura-cli/pro-cli/installing-uninstalling.mdx
@@ -14,7 +14,7 @@ sidebar_position: 2
## Install the Hasura Pro CLI plugin
-The Hasura Pro CLI is distributed as a plugin to the [Hasura CLI](/hasura-cli/index.mdx).
+The Hasura Pro CLI is distributed as a plugin to the [Hasura CLI](/hasura-cli/overview.mdx).
:::warning Note
diff --git a/docs/docs/hasura-cli/quickstart.mdx b/docs/docs/hasura-cli/quickstart.mdx
new file mode 100644
index 00000000000..e78f72eed34
--- /dev/null
+++ b/docs/docs/hasura-cli/quickstart.mdx
@@ -0,0 +1,280 @@
+---
+description: Create a new project, manage Metadata, apply Migrations and more with the Hasura CLI
+keywords:
+ - hasura
+ - docs
+ - CLI
+ - getting started
+ - quickstart
+sidebar_label: Quickstart
+sidebar_position: 2
+toc_max_heading_level: 2
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+
+# Quickstart Hasura CLI
+
+The Hasura CLI is a command line tool that helps you create a new project, manage Metadata, apply Migrations, and more.
+In this guide, we will create a new project using the Hasura CLI. We will also see how to add a data source, track
+tables, and deploy the project to another environment.
+
+## Prerequisites
+
+Before continuing, please make sure you have the following:
+
+- [The Hasura CLI](/hasura-cli/install-hasura-cli.mdx) installed
+- [Docker](https://docs.docker.com/get-docker/) installed and running
+
+## Step 1: Init the local project
+
+Let's create a new project locally called `cli-demo`:
+
+```bash
+hasura init cli-demo
+```
+
+This will create a new directory called `cli-demo` with the following structure:
+
+```bash
+cli-demo
+├── config.yaml
+├── migrations
+├── metadata
+├── seeds
+```
+
+:::info What if I already have a project?
+
+If you followed our [Quickstart with Docker](/getting-started/docker-simple.mdx), you'll already have a local project.
+In that case, in the project's directory, you can run the following command to initialize the current directory as a
+Hasura project:
+
+```bash
+hasura init .
+```
+
+Then, [skip to step 3](#step-3-run-the-hasura-console).
+
+:::
+
+## Step 2: Get the docker compose file and start the containers
+
+The `docker-compose.yaml` file contains the configuration for the Hasura GraphQL Engine and a Postgres database. If you
+haven't yet followed our [getting started guide for Docker](/getting-started/docker-simple.mdx), inside the `cli-demo`
+directory, run:
+
+```bash
+curl https://raw.githubusercontent.com/hasura/graphql-engine/master/install-manifests/docker-compose/docker-compose.yaml > docker-compose.yaml
+```
+
+
+
+:::info Why does the docker-compose.yaml file contain the Postgres container?
+
+Curious? [Read this](#why-do-i-need-to-include-the-postgres-container-in-the-docker-composeyaml-file) in the recap to
+find out why.
+
+:::
+
+
+
+Now, start the containers:
+
+```bash
+docker compose up -d
+```
+
+## Step 3: Run the Hasura Console
+
+If you've followed our [simple getting started guide for Docker](/getting-started/docker-simple.mdx), you'll already be
+familiar with the Hasura Console. However, the way we access the Console is slightly different when using the Hasura
+CLI. Instead of opening your browser and navigating to `http://localhost:8080/console`, we'll use the Hasura CLI to open
+the Console in our browser. In the directory containing your project, run:
+
+```bash
+hasura console
+```
+
+
+
+:::info Why are we opening the Console from the CLI?
+
+Curious? [Read this](#why-are-we-opening-the-console-from-the-cli) in the recap to find out why.
+
+:::
+
+
+
+## Step 4: Add a data source
+
+Now that we have the Hasura Console open, let's add a data source. Click on the `Data` tab in the top navigation bar.
+Our `docker-compose.yaml` file already contains the `PG_DATABASE_URL` environment variable which is set equal to a
+connection string for the local Postgres database running in a container:
+
+```yaml
+PG_DATABASE_URL: postgres://postgres:postgres@postgres:5432/postgres
+```
+
+We'll enter the name `default` for the ` Database Display Name` field. This name is used to identify the data source in
+Hasura's Metadata and is not your database's name. Should you choose to use the `HASURA_GRAPHQL_DATABASE_URL`
+environment variable instead, `default` is the default name assigned to your data source by Hasura.
+
+Next, we'll choose `Environment Variable` from the `Connect Database Via` options; enter `PG_DATABASE_URL` as the name:
+
+
+
+This will add the local Postgres database running in a container as a data source. Later, we'll see that we can use the
+same environment variable - with different values - to connect to a different database on either our staging or
+production environments.
+
+Click `Connect Database`.
+
+
+
+:::info Why aren't we just pasting in a connection string?
+
+Curious? [Read this](#why-arent-we-just-pasting-in-a-connection-string) in the recap to find out why.
+
+:::
+
+
+
+## Step 5: Add some data and track the tables
+
+Now that we have a data source, let's add some data and track the tables. From the `Data` tab, click the `SQL` option on
+the left-hand navigation. If you already have some seed data, you can paste it in the editor. Otherwise, you can use the
+SQL below this image to create a table called `users` and insert some data:
+
+
+
+```sql
+CREATE TABLE users (
+ id SERIAL PRIMARY KEY,
+ name TEXT NOT NULL,
+ email TEXT NOT NULL UNIQUE
+);
+
+INSERT INTO users (name, email) VALUES ('John', 'john.doe@hasura.io');
+INSERT INTO users (name, email) VALUES ('Jane', 'jane.doe@hasura.io');
+```
+
+After pasting the seed data, check the `Track this` and `This is a migration` boxes before clicking the `Run` button.
+This will create the `users` table, insert the data, and track the table in the Metadata. Optionally, you can include a
+name (in our example, `add_users`) for the Migration, which the GraphQL Engine appends to the end of the Migration's
+version number. This is useful if you're working on a team and want to keep track of the changes you're making.
+
+If we navigate to our `Data` tab, we'll see that the `users` table has been added to the `Tables` section:
+
+
+
+Additionally, if we look inside our `migrations` directory, we'll see that a new Migration - complete with `up` and
+`down` sql files - has been created with a timestamped version number and our name for the Migration:
+
+```bash
+cli-demo
+├── config.yaml
+├── migrations
+│ └── 1675957424387_add_users
+│ ├── down.sql
+│ └── up.sql
+├── metadata
+├── seeds
+```
+
+## Step 6: Init a new git repository
+
+While this is a basic example, we've achieved a lot in just a few steps. Let's commit our changes to Git so we can
+deploy our project to another environment.
+
+```bash
+git init
+git add .
+git commit -m "Initial commit"
+```
+
+With our repository initialized, we can now deploy our project to another environment. Depending on where you're
+deploying to, you'll need to use a different method. You can pick up right where we've left off in the next section.
+
+## Step 7: Deploy to another environment
+
+If you're deploying to Hasura Cloud, you can use the Hasura CLI or our
+[GitHub integration](/hasura-cloud/ci-cd/github-integration.mdx). If you're deploying to a different environment, you'll
+need to use the Hasura CLI.
+
+### Deploy to Hasura Cloud
+
+If you're deploying to Hasura Cloud, you can use the Hasura CLI or the GitHub integration. We recommend the latter as
+it's an easier way to deploy your project and allows you the benefits of version control. If you're using the GitHub
+integration, you'll need to push your changes to a GitHub repository.
+
+**Picking up from the previous section, we'll push our changes to GitHub**:
+
+```bash
+git remote add origin
+git branch -M main
+git push -u origin main
+```
+
+From here, you can follow the instructions in the
+[GitHub integration guide](/hasura-cloud/ci-cd/github-integration.mdx#initial-setup) to deploy your project to Hasura
+Cloud. With this connection in place, you can iterate and develop your project locally - and then push your changes to
+GitHub to deploy to Hasura Cloud 🎉
+
+Head down to the [recap section](#recap) to learn more about some of the design decisions we made in this guide.
+
+:::info Curious about testing your changes?
+
+Hasura Cloud can be used as a staging or production environment. If you're curious about testing your project in a
+staging environment, consider our [Preview Apps](/hasura-cloud/ci-cd/preview-apps.mdx) feature.
+
+:::
+
+### Deploy to a hosted environment
+
+If you're deploying to a provider other than Hasura Cloud, you can use your own CI/CD pipeline or the Hasura CLI.
+Assuming you have a Hasura instance running, you can use the following command to deploy your project:
+
+```bash
+hasura deploy --endpoint http://your-other-instance.com --admin-secret your-admin-secret
+```
+
+This command will will apply the local changes of your Metadata and Migrations to the remote Hasura instance running at
+`http://your-other-instance.com` using the `your-admin-secret` as the admin secret.
+
+## Recap
+
+What did you just do? Well, in just a few steps, you've created a new local project, added a data source, and deployed
+your project to another environment! 🎉
+
+If you're curious about why we did some of the things we did, read on for some answers to common questions.
+
+### Why do I need to include the Postgres container in the docker-compose.yaml file?
+
+If you're not using a Postgres database as one of your data sources, you'll still need to include the Postgres container
+in the `docker-compose.yaml` file. This is because the Hasura GraphQL Engine requires a Postgres database to store its
+Metadata. [Click here to head back up to Step 2](#pg-admonition).
+
+### Why are we opening the Console from the CLI?
+
+So that the Metadata and Migrations are tracked in the local project directory, we need to use the Hasura CLI to open
+the Console. The Console served directly by the Hasura GraphQL Engine in Docker will not track any changes to the
+Metadata or Migrations. [Click here to head back up to Step 3](#console-admonition).
+
+### Why aren't we just pasting in a connection string?
+
+The Hasura CLI allows you to manage your project using
+[environment variables](/deployment/graphql-engine-flags/reference.mdx). This means that you can use the same project
+directory on different environments and not have to worry about updating different values in your CI/CD pipeline. This
+is ideal for iterating on your database's schema and data locally before deploying to another environment (e.g., staging
+or production).
+
+If we were to paste in a connection string, we'd have to change that value - to match the database used by an
+environment - every time we wanted to deploy our project to a different environment.
+
+Hasura Cloud does not host databases. If you don't already have a database hosted somewhere, take a look at our list of
+[cloud databases](/databases/overview.mdx) to quickly get started.
+
+Additionally, it's a security vulnerability to store connection strings in version control. These values are safer in an
+`.env` file or the environment variables wherever your project is deployed.
+[Click here to head back up to Step 4](#string-admonition).
diff --git a/docs/docs/hasura-cloud/_category_.json b/docs/docs/hasura-cloud/_category_.json
index 029c1591dc0..3ebbddcb844 100644
--- a/docs/docs/hasura-cloud/_category_.json
+++ b/docs/docs/hasura-cloud/_category_.json
@@ -1,4 +1,5 @@
{
- "label": "Hasura Cloud",
- "position": 200
-}
\ No newline at end of file
+ "label": "Hasura Cloud ☁️",
+ "position": 200,
+ "className": "cloud-icon"
+}
diff --git a/docs/docs/hasura-cloud/account-management/_category_.json b/docs/docs/hasura-cloud/account-management/_category_.json
index 2054aaee021..0556d21db63 100644
--- a/docs/docs/hasura-cloud/account-management/_category_.json
+++ b/docs/docs/hasura-cloud/account-management/_category_.json
@@ -1,5 +1,5 @@
{
- "label": "Account management",
+ "label": "Account management ☁️",
"position": 30,
"className": "cloud-icon"
}
diff --git a/docs/docs/hasura-cloud/account-management/billing/_category_.json b/docs/docs/hasura-cloud/account-management/billing/_category_.json
index d7b8713243a..9310266489e 100644
--- a/docs/docs/hasura-cloud/account-management/billing/_category_.json
+++ b/docs/docs/hasura-cloud/account-management/billing/_category_.json
@@ -1,5 +1,5 @@
{
- "label": "Billing",
+ "label": "Billing ☁️",
"position": 20,
"className": "cloud-icon"
}
diff --git a/docs/docs/hasura-cloud/account-management/billing/billing-data-calculation.mdx b/docs/docs/hasura-cloud/account-management/billing/billing-data-calculation.mdx
index 9839c1b975a..0e968aa523a 100644
--- a/docs/docs/hasura-cloud/account-management/billing/billing-data-calculation.mdx
+++ b/docs/docs/hasura-cloud/account-management/billing/billing-data-calculation.mdx
@@ -25,9 +25,9 @@ Hasura Cloud projects are billed based on the amount of data that passes through
the operations that are performed by you, your apps, or your clients.
The data pass-through is calculated by analyzing the logs that are sent from your project. All data transfer from Hasura
-Cloud to external networks - such as your database server, external webhooks for [Actions](/actions/index.mdx),
-[Event Triggers](/event-triggers/index.mdx), [Scheduled Triggers](/scheduled-triggers/index.mdx) or your
-[Remote Schema](/remote-schemas/index.mdx) - is accounted for in Hasura Cloud billing.
+Cloud to external networks - such as your database server, external webhooks for [Actions](/actions/overview.mdx),
+[Event Triggers](/event-triggers/overview.mdx), [Scheduled Triggers](/scheduled-triggers/overview.mdx) or your
+[Remote Schema](/remote-schemas/overview.mdx) - is accounted for in Hasura Cloud billing.
We account for the following types of logs in Hasura Cloud data pass-through:
diff --git a/docs/docs/hasura-cloud/one-click-deploy/create-one-click-to-deploy-apps.mdx b/docs/docs/hasura-cloud/one-click-deploy/create-one-click-to-deploy-apps.mdx
index dfb9dc1c3a4..01d50e16a9c 100644
--- a/docs/docs/hasura-cloud/one-click-deploy/create-one-click-to-deploy-apps.mdx
+++ b/docs/docs/hasura-cloud/one-click-deploy/create-one-click-to-deploy-apps.mdx
@@ -228,7 +228,7 @@ manually deploying your Hasura app via the [Hasura CLI](/hasura-cli/pro-cli/inst
- Navigate to [Hasura Cloud](https://cloud.hasura.io/) and create a new Hasura Cloud project.
-- Connect the required database(s) needed for your app as shown [here](/databases/connect-db/index.mdx).
+- Connect the required database(s) needed for your app as shown [here](/databases/overview.mdx).
- Set any environment variables required for your app as shown [here](/hasura-cloud/projects/env-vars.mdx).
diff --git a/docs/docs/hasura-cloud/one-click-deploy/index.mdx b/docs/docs/hasura-cloud/one-click-deploy/index.mdx
index eaf3cb14566..fcb3f186787 100644
--- a/docs/docs/hasura-cloud/one-click-deploy/index.mdx
+++ b/docs/docs/hasura-cloud/one-click-deploy/index.mdx
@@ -8,7 +8,7 @@ keywords:
slug: index
---
-import Thumbnail from "@site/src/components/Thumbnail";
+import Thumbnail from '@site/src/components/Thumbnail';
# One Click Deploy to Hasura Cloud
@@ -46,7 +46,9 @@ Cloud workflow.
A One Click Deploy to Hasura Cloud URL follows the following format:
```html
-https://cloud.hasura.io/deploy?github_repo=&hasura_dir=&branch=
+https://cloud.hasura.io/deploy?github_repo=&hasura_dir=&branch=
```
- **Base URL**: `https://cloud.hasura.io/deploy`
@@ -82,22 +84,14 @@ Once the Project is created, you will be redirected to the Project's Console for
Next, we clone the Hasura assets, i.e. Metadata, Migrations and seeds, from the source GitHub repository to be applied
on your Project.
-
+
### Step 4: Set Environment Variables
If the app you're deploying requires environment variables, like database connection strings, we'll prompt you to enter
those before the assets can be applied
-
+
If the app requires a Postgres database, you can create and connect to a free new Neon Postgres database by clicking
`Create New Database`. You can also connect an existing database by clicking `Connect Existing Database`.
@@ -109,11 +103,7 @@ After populating the environment variables as required, click on `Set Environmen
Next, the Hasura assets, i.e. Metadata, Migrations and seeds, are applied on your Project to complete the application
setup.
-
+
### Step 6: Explore!!
@@ -121,13 +111,9 @@ Your Hasura Cloud App deployment is now complete!
Play around and explore the capabilities of the Hasura GraphQL Engine's pre-generated GraphQL queries. To get started,
try running a few queries from the Hasura Console to interact with the data. See more information on GraphQL queries
-generated by Hasura [here](/queries/index.mdx).
+generated by Hasura [here](/queries/overview.mdx).
-
+
## Troubleshooting
@@ -144,9 +130,8 @@ generated by Hasura [here](/queries/index.mdx).
- There might be an issue with your database connection. Please check if the database URL entered is accurate. You can
see the env vars set for your project on the [Env vars](/hasura-cloud/projects/env-vars.mdx) page. In case the
- provided env var is not correct, update its value and hit `Launch console` to continue the One Click
- Deploy workflow.
+ provided env var is not correct, update its value and hit `Launch console` to continue the One Click Deploy workflow.
- If an existing database is connected, there might be a conflict between the existing schema and the schema being
deployed by the One Click Deploy workflow. In this case, either connect another database or update the connected
database's schema to not conflict with the app schema. You can update the database connection env vars for your
- project on the [Env vars](/hasura-cloud/projects/env-vars.mdx) page.
\ No newline at end of file
+ project on the [Env vars](/hasura-cloud/projects/env-vars.mdx) page.
diff --git a/docs/docs/hasura-cloud/overview.mdx b/docs/docs/hasura-cloud/overview.mdx
new file mode 100644
index 00000000000..2093d317b09
--- /dev/null
+++ b/docs/docs/hasura-cloud/overview.mdx
@@ -0,0 +1,80 @@
+---
+description: Use Hasura Cloud to host your Hasura GraphQL Engine
+title: 'Hasura Cloud'
+keywords:
+ - hasura
+ - cloud
+ - deployment
+hide_table_of_contents: true
+sidebar_position: 1
+sidebar_label: Overview
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Cloud from '@site/static/icons/features/cloud.svg';
+
+# Hasura Cloud
+
+
+
+
+ Hasura Cloud is a fully-managed version of Hasura's popular open-source GraphQL Engine that gives you a scalable,
+ highly-available, globally-distributed, secure GraphQL API over your data sources.
+
+
+ Hasura Cloud takes care of all the performance, security & reliability requirements of your API layer by adding a powerful
+ suite of production-ready features from day one.
+
+
Hasura Cloud is available on Amazon Web Services (AWS) and the Google Cloud Platform (GCP), world-wide.
+
Quick Links
+
+
+
+ Get started with Hasura Cloud in 60 seconds.
+
+
+
+ Learn more about plans and pricing.
+
+
+
+
+
+
+## Using Hasura Cloud
+
+
+
+
+
One Click Deployments
+
+ With One Click Deployments, you can instantly deploy a templated, functioning GraphQL API on Hasura Cloud -
+ complete with a database - in a single click.
+
+
+
+
+
+
GitHub Integration
+
+ Hasura Cloud integrates with GitHub to provide a seamless workflow for deploying your GraphQL API. You can
+ configure Hasura Cloud to automatically deploy your GraphQL API on every push to a GitHub branch.
+
diff --git a/docs/docs/hasura-cloud/projects/_category_.json b/docs/docs/hasura-cloud/projects/_category_.json
index 4a3d99def2d..11be54c80fc 100644
--- a/docs/docs/hasura-cloud/projects/_category_.json
+++ b/docs/docs/hasura-cloud/projects/_category_.json
@@ -1,5 +1,5 @@
{
- "label": "Projects & collaborators",
+ "label": "Projects & collaborators ☁️",
"position": 20,
"className": "cloud-icon"
}
diff --git a/docs/docs/hasura-cloud/projects/create.mdx b/docs/docs/hasura-cloud/projects/create.mdx
index b9bc0f49e88..d7810c850d6 100644
--- a/docs/docs/hasura-cloud/projects/create.mdx
+++ b/docs/docs/hasura-cloud/projects/create.mdx
@@ -21,7 +21,7 @@ import Thumbnail from '@site/src/components/Thumbnail';
## Introduction
You can create a new Hasura Cloud Project with either a new database, or an existing database with a publicly available
-IP address. For a list of supported databases and features [see here](/databases/index.mdx).
+IP address. For a list of supported databases and features [see here](/databases/feature-support.mdx).
## Project setup
@@ -45,4 +45,4 @@ Once created, you can specify a new name for your Project if you want.
## Connect to a database
Once your project is created you can connect to a new or existing database. For full details on how to connect to a
-database, see [connecting to a database here](/databases/connect-db/index.mdx).
+database, see [connecting to a database here](/databases/overview.mdx).
diff --git a/docs/docs/hasura-cloud/projects/environments.mdx b/docs/docs/hasura-cloud/projects/environments.mdx
index 7e5bc0cb435..1a0fcb1c75f 100644
--- a/docs/docs/hasura-cloud/projects/environments.mdx
+++ b/docs/docs/hasura-cloud/projects/environments.mdx
@@ -108,7 +108,7 @@ Also add any other ENV vars that you might have set on your local project.
In order to easily apply your local changes to your new Cloud project, we'll use the Hasura
[GitHub deployment](/hasura-cloud/ci-cd/github-integration.mdx) feature. But before we do that, we need to setup
Metadata & Migrations of your local setup that you can apply to your Cloud project. For a lowdown on Hasura Metadata &
-Migrations refer the guide [here](/migrations-metadata-seeds/index.mdx)
+Migrations refer the guide [here](/migrations-metadata-seeds/overview.mdx)
### Step 1: Install Hasura CLI
diff --git a/docs/docs/hasura-cloud/projects/heroku-url-sync.mdx b/docs/docs/hasura-cloud/projects/heroku-url-sync.mdx
index e3ec62668b7..cf23c3dc6fa 100644
--- a/docs/docs/hasura-cloud/projects/heroku-url-sync.mdx
+++ b/docs/docs/hasura-cloud/projects/heroku-url-sync.mdx
@@ -25,7 +25,7 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
:::info Note
To know more about Heroku's latest announcement on deprecation of free resources, please see
-[this page](/databases/connect-db/cloud-databases/heroku.mdx).
+[this page](/databases/postgres/heroku.mdx).
:::
diff --git a/docs/docs/hasura-cloud/index.mdx b/docs/docs/hasura-cloud/regions.mdx
similarity index 57%
rename from docs/docs/hasura-cloud/index.mdx
rename to docs/docs/hasura-cloud/regions.mdx
index 350ada3bde0..787ac17f788 100644
--- a/docs/docs/hasura-cloud/index.mdx
+++ b/docs/docs/hasura-cloud/regions.mdx
@@ -1,20 +1,16 @@
---
-description: Use Hasura Cloud to host your Hasura GraphQL Engine
-title: 'Hasura Cloud'
+description: Supported regions for Hasura Cloud
+title: 'Regions'
keywords:
- hasura
- cloud
- - deployment
-slug: index
-sidebar_position: 1
-sidebar_class_name: cloud-icon
+ - regions
+sidebar_position: 7
---
import Thumbnail from '@site/src/components/Thumbnail';
-import Cloud from '@site/static/icons/features/cloud.svg';
-
-# Hasura Cloud
+# Regions
Available on: Cloud Free, Cloud Standard, Cloud Professional, Cloud Enterprise
@@ -22,10 +18,8 @@ import Cloud from '@site/static/icons/features/cloud.svg';
## Introduction
-Hasura Cloud is a fully managed version of Hasura's popular open source GraphQL Engine that gives you a scalable, highly
-available, globally distributed, secure GraphQL API over your data sources. Hasura Cloud takes care of all the
-performance, security & reliability requirements of your API layer by adding a powerful suite of production-ready
-features from day one. Hasura Cloud is available on Amazon Web Services (AWS) and the Google Cloud Platform (GCP).
+Hasura Cloud is available in multiple regions on both Amazon Web Services (AWS) and Google Cloud Platform (GCP). This
+allows you to choose the region that is closest to your users to reduce latency and improve performance.
## Supported regions
diff --git a/docs/docs/index.mdx b/docs/docs/index.mdx
index d2873481a2f..69a25498e86 100644
--- a/docs/docs/index.mdx
+++ b/docs/docs/index.mdx
@@ -14,6 +14,7 @@ sidebar_position: 0
import Link from '@docusaurus/Link';
import VersionedLink from '@site/src/components/VersionedLink';
import ArrowRight from '@site/static/icons/arrow_right.svg';
+import Actions from '@site/static/icons/features/actions.svg';
import Basics from '@site/static/icons/features/basics.svg';
import GraphQL from '@site/static/icons/features/graphql.svg';
import BusinessLogic from '@site/static/icons/features/business_logic.svg';
@@ -24,32 +25,41 @@ import Learn from '@site/static/icons/features/learn.svg';
import Cloud from '@site/static/icons/features/cloud.svg';
import Observability from '@site/static/icons/features/observability.svg';
import Caching from '@site/static/icons/features/caching.svg';
-import Testing from '@site/static/icons/features/testing.svg';
+import Remote from '@site/static/icons/features/remote_schema.svg';
import Security from '@site/static/icons/features/security.svg';
+import Testing from '@site/static/icons/features/testing.svg';
# Hasura GraphQL Engine Documentation
-
- The Hasura GraphQL Engine makes your data instantly accessible over a real-time GraphQL API, so you can build and
- ship modern, performant apps and APIs 10x faster. Hasura connects to your databases, REST and GraphQL endpoints,
- and third party APIs to provide a unified, connected, real-time, secured GraphQL API for all of your data.
-
-
-
- Hasura Cloud
- {' '}
- empowers you to create highly optimized, managed and massively scalable Hasura instances in seconds and includes
- extra reliability, monitoring, caching, tracing, security and deployment features. You can also deploy Hasura
- manually using our Community Edition Docker image which includes all the core features of GraphQL Engine.
-
-
- Hasura Enterprise Edition (EE) builds on all the features of
- the Hasura GraphQL Engine while giving you an enterprise-ready solution - complete with key features like observability,
- security, and performance - deployable in minutes. Designed to work with your container platform of choice, Hasura
- EE can quickly be set up on AWS ECS, Kubernetes, and Google Cloud Run.
-
+
+
+ The Hasura GraphQL Engine makes your data instantly accessible over a GraphQL API, so you can build and ship
+ modern, performant apps and APIs 10x faster. Hasura connects to your databases, REST and GraphQL endpoints, and
+ third party APIs to provide a unified, connected, real-time, secured GraphQL API for all of your data.
+
+
+
+ Hasura Cloud
+ empowers you to create highly optimized, managed and massively scalable Hasura instances in seconds and includes
+ extra reliability, monitoring, caching, tracing, security and deployment features. You can also deploy Hasura manually
+ using our Community Edition Docker image which includes all the core features of GraphQL Engine.
+
+
+
+ Hasura Enterprise Edition (EE)
+ {' '}
+ builds on all the features of the Hasura GraphQL Engine while giving you an enterprise-ready solution - complete
+ with key features like observability, security, and performance - deployable in minutes.
+
+
+
Popular Topics
@@ -60,7 +70,7 @@ import Security from '@site/static/icons/features/security.svg';
Basics
You can get up and running with Hasura in minutes by following our Getting Started guide.
-
+
See Getting Started
@@ -70,20 +80,31 @@ import Security from '@site/static/icons/features/security.svg';
GraphQL API
We provide an instant GraphQL API by generating your GraphQL schema for you based on your data.
-
- See Schema
+
+ See GraphQL Schema
-
Business Logic
+
Actions
- With built-in extensibility, Hasura can handle business logic via Actions, Remote Schemas, and Event Triggers.
+ Hasura's Actions feature allows you to write custom business logic in your preferred language and expose it as a
+ GraphQL API.
-
- See Business Logic
+
+ See Actions
+
+
+
+
+
+
Remote Schemas
+
+
Hasura's Remote Schemas feature allows you to combine multiple GraphQL APIs into a single unified endpoint.
+
+ See Remote Schema
@@ -95,102 +116,21 @@ import Security from '@site/static/icons/features/security.svg';
By using role-based authorization and industry-standard authentication patterns, you can secure your app and your
data with ease.
-
+
See Auth
-
-
-
-
Enterprise
-
-
Deploy an enterprise-ready instance of Hasura in minutes using your container platform of choice.
-
- See Hasura Enterprise
-
-
Deployments
- Whether you're using Hasura Cloud or one of your favorite one-click services, Hasura's flexibility makes it quick
- to deploy.
+ Whether you're using Hasura Cloud or one of your favorite one-click services, Hasura's containerization makes it
+ quick and easy to deploy.
See Deployment Guides
-
-
-
-
Learn
-
-
Our Learn team is hard at work creating courses to help developers learn more about Hasura and GraphQL.
-
- See Courses
-
-
-
-
-
-
Cloud Projects
-
-
- Hasura Cloud gives you a fully managed, production ready GraphQL API as a service to help you build modern apps
- faster.
-
-
- See Getting Started with Cloud
-
-
-
-
-
-
Observability
-
-
- For enhanced reliability and performance, Hasura Cloud offers easy-to-integrate metrics and compatibility with
- different common services.
-
-
- See Metrics
-
-
-
-
-
-
Query Response Caching
-
-
- For frequently executed queries, Hasura Cloud offers caching to improve performance and your users' experience.
-
-
- See Query Response Caching
-
-
-
-
-
-
Regression Tests
-
-
- With regression tests, Hasura Cloud provides you a comprehensive test bench which is executable on any GraphQL
- Engine instance.
-
-
- See Regression Tests
-
-
-
-
-
-
API Security
-
-
Keep your API secure and healthy with tools like API limits, allow limits, multiple secrets, and more.
-
- See Security
-
-
diff --git a/docs/docs/migrations-metadata-seeds/index.mdx b/docs/docs/migrations-metadata-seeds/index.mdx
deleted file mode 100644
index 99ca29bbfaa..00000000000
--- a/docs/docs/migrations-metadata-seeds/index.mdx
+++ /dev/null
@@ -1,117 +0,0 @@
----
-sidebar_label: Migrations & Metadata
-description: Manage Hasura Migrations and Metadata
-title: Migrations & Metadata Introduction
-keywords:
- - hasura
- - migration
- - metadata
- - CI/CD
- - ci
- - cd
-slug: index
----
-
-import MMS from '@site/static/icons/features/mms.svg';
-
-# Migrations & Metadata Introduction
-
-Hasura needs two pieces of information which work together to describe your Hasura setup
-
-- **Migrations** - Representing the underlying database schema.
-- **Metadata** - Describing the exposed Hasura GraphQL API and all other configuration.
-
----
-
-## Hasura Migrations
-
-**Keep track of your database schema over time.**
-
-Hasura Migrations are a SQL representation of the state of your database schema which can be used to keep track of,
-update, roll-back or move your schema using the [Hasura CLI](/hasura-cli/index.mdx).
-
-They are automatically generated in a series of Unix nanosecond timestamped directories consisting of `up.sql` and
-`down.sql` files in pure SQL syntax, which describe to Hasura Server both how to create, (`up.sql`) and how to roll back
-(`down.sql`) each of your database changes step-by-step.
-
-When these files are committed to version control, your database schema state can be kept in-sync with your codebase.
-
-When used in combination with CI/CD, changes to your database schema can automatically and elegantly be applied to your
-app's development, staging or production versions.
-
-Example `migrations` directory created with the Hasura CLI:
-
-```text
-📂 migrations
-└─ 📂 default
- └─ 📂 1654696186008_init
- └─ 📄 up.sql
- └─ 📂 1654698227514_create_table_public_address
- ├─ 📄 down.sql
- └─ 📄 up.sql
-```
-
----
-
-## Hasura Metadata
-
-**The configuration of your Hasura Server**
-
-Hasura Metadata is a representation of the configuration of the Hasura Server. From Actions to databases and their
-tables, to permissions, Event Triggers and API limits, everything regarding the config of the Hasura Server is
-represented in Metadata.
-
-Metadata can also be tracked with version control, allowing your Hasura Metadata to be kept in-sync with your code and
-database schema changes.
-
-The state of Hasura Metadata is managed via snapshots of the state of the Hasura Server Metadata configuration. These
-snapshots can be applied as a whole, using the [Hasura CLI](/hasura-cli/index.mdx) to the Hasura Server.
-
-Example `metadata` directory created with the Hasura CLI:
-
-```text
-📂 metadata
-├─ 📂 databases
-│ ├─ 📂 default
-│ │ └─ 📂 tables
-│ │ ├─ 📄 public_address.yaml
-│ │ ├─ 📄 public_author.yaml
-│ │ ├─ 📄 public_article.yaml
-│ │ └─ 📄 tables.yaml
-│ └── 📄 databases.yaml
-├─ 📄 actions.graphql
-├─ 📄 actions.yaml
-├─ 📄 allow_list.yaml
-├─ 📄 api_limits.yaml
-├─ 📄 cron_triggers.yaml
-├─ 📄 graphql_schema_introspection.yaml
-├─ 📄 inherited_roles.yaml
-├─ 📄 network.yaml
-├─ 📄 query_collections.yaml
-├─ 📄 remote_schemas.yaml
-├─ 📄 rest_endpoints.yaml
-└─ 📄 version.yaml
-```
-
----
-
-### Config versions
-
-Migrations and Metadata follow their own versioning scheme separate to the that of the Hasura Server and CLI. This
-documentation is for the latest Hasura Migrations `config v3`, supported from `v2.0.0-alpha.1`. (See
-[upgrade guide](/migrations-metadata-seeds/legacy-configs/upgrade-v3.mdx)).
-
-For `config v2`, see [Migrations (config v2)](/migrations-metadata-seeds/legacy-configs/config-v2/index.mdx). For
-`config v1`, see [Migrations (config v1)](/migrations-metadata-seeds/legacy-configs/config-v1/index.mdx).
-
----
-
-## Setting up Migrations
-
-See [Setting up Hasura Migrations](/migrations-metadata-seeds/migrations-metadata-setup.mdx).
-
-:::info Additional Resources
-
-- Advanced Hasura - [Learn Tutorial](https://hasura.io/learn/graphql/hasura-advanced/introduction/).
-
-:::
diff --git a/docs/docs/migrations-metadata-seeds/legacy-configs/config-v2/index.mdx b/docs/docs/migrations-metadata-seeds/legacy-configs/config-v2/index.mdx
index e99cf32a1ce..325b33e06dc 100644
--- a/docs/docs/migrations-metadata-seeds/legacy-configs/config-v2/index.mdx
+++ b/docs/docs/migrations-metadata-seeds/legacy-configs/config-v2/index.mdx
@@ -19,7 +19,7 @@ reproduce the same setup. For example, to achieve a dev -> staging -> production
:::info Note
This documentation is for Hasura Migrations `config v2`. For `config v3`, see
-[Migrations & Metadata (CI/CD)](/migrations-metadata-seeds/index.mdx).
+[Migrations & Metadata (CI/CD)](/migrations-metadata-seeds/overview.mdx).
:::
@@ -28,7 +28,7 @@ This documentation is for Hasura Migrations `config v2`. For `config v3`, see
Hasura needs 2 pieces of information to recreate your GraphQL API, the underlying PG database schema and the Hasura
Metadata which is used to describe the exposed GraphQL API.
-The [Hasura CLI](/hasura-cli/index.mdx) lets you manage these pieces of information as you build your project via:
+The [Hasura CLI](/hasura-cli/overview.mdx) lets you manage these pieces of information as you build your project via:
### Database migration files
diff --git a/docs/docs/migrations-metadata-seeds/legacy-configs/config-v2/reference/metadata-format.mdx b/docs/docs/migrations-metadata-seeds/legacy-configs/config-v2/reference/metadata-format.mdx
index 155ee48f7c4..4a6090b7477 100644
--- a/docs/docs/migrations-metadata-seeds/legacy-configs/config-v2/reference/metadata-format.mdx
+++ b/docs/docs/migrations-metadata-seeds/legacy-configs/config-v2/reference/metadata-format.mdx
@@ -39,7 +39,7 @@ API is a JSON version of the Metadata files.
### actions.graphql
-The `actions.graphql` file contains all the [actions](/actions/index.mdx) definitions and
+The `actions.graphql` file contains all the [actions](/actions/overview.mdx) definitions and
[custom type](/actions/types.mdx) definitions.
**Example**: A query action called `greet` and two custom types called `SampleInput` and `SampleOutput`.
@@ -58,7 +58,7 @@ type SampleOutput {
### actions.yaml
-The `actions.yaml` file contains Metadata related to [Actions](/actions/index.mdx).
+The `actions.yaml` file contains Metadata related to [Actions](/actions/overview.mdx).
**Example**: An action called `greet` with the `handler` set to `/greet` and two custom types called
`SampleInput` and `SampleOutput`.
@@ -184,7 +184,7 @@ The `query_collections.yaml` file contains Metadata information about
### remote_schemas.yaml
-The `remote_schemas.yaml` file contains the Metadata related to [Remote Schemas](/remote-schemas/index.mdx).
+The `remote_schemas.yaml` file contains the Metadata related to [Remote Schemas](/remote-schemas/overview.mdx).
**Example**: A Remote Schema called `my-remote-schema` with URL ``.
diff --git a/docs/docs/migrations-metadata-seeds/legacy-configs/upgrade-v3.mdx b/docs/docs/migrations-metadata-seeds/legacy-configs/upgrade-v3.mdx
index b8368c3e9f0..f81218dd67b 100644
--- a/docs/docs/migrations-metadata-seeds/legacy-configs/upgrade-v3.mdx
+++ b/docs/docs/migrations-metadata-seeds/legacy-configs/upgrade-v3.mdx
@@ -263,7 +263,7 @@ and Migrations commands.
`HASURA_GRAPHQL_DATABASE_URL` env var, the database will be added
with the name `default` automatically.
- Else you can connect a database with the name `default` following
- the steps [here](/databases/connect-db/index.mdx#connect-database-v2-0).
+ the steps [here](/databases/quickstart.mdx).
Post this, the Metadata and Migration commands should work as usual.
diff --git a/docs/docs/migrations-metadata-seeds/manage-metadata.mdx b/docs/docs/migrations-metadata-seeds/manage-metadata.mdx
index 227fc191ff3..ba6e1d8c913 100644
--- a/docs/docs/migrations-metadata-seeds/manage-metadata.mdx
+++ b/docs/docs/migrations-metadata-seeds/manage-metadata.mdx
@@ -56,7 +56,7 @@ Example Metadata directory:
There is no way to create an export of partial Metadata.
-There are three ways to interact with the Hasura Metadata. Via the [Hasura CLI](/hasura-cli/index.mdx), the Hasura
+There are three ways to interact with the Hasura Metadata. Via the [Hasura CLI](/hasura-cli/overview.mdx), the Hasura
Console, and the Hasura API. We'll go over each Metadata command below and how it is executed with each method.
### Metadata Formats
diff --git a/docs/docs/migrations-metadata-seeds/metadata-format.mdx b/docs/docs/migrations-metadata-seeds/metadata-format.mdx
index ba2a9dbfc01..a88580fe274 100644
--- a/docs/docs/migrations-metadata-seeds/metadata-format.mdx
+++ b/docs/docs/migrations-metadata-seeds/metadata-format.mdx
@@ -243,7 +243,7 @@ permissions:
### actions.graphql
-The `actions.graphql` file contains all the GraphQL [Actions](/actions/index.mdx) and their
+The `actions.graphql` file contains all the GraphQL [Actions](/actions/overview.mdx) and their
[custom type](/actions/types.mdx) definitions.
**Example**: A query action called `greet` and two custom types called `SampleInput` and `SampleOutput`
@@ -262,7 +262,7 @@ type SampleOutput {
### actions.yaml
-The `actions.yaml` file contains Metadata related to [actions](/actions/index.mdx).
+The `actions.yaml` file contains Metadata related to [actions](/actions/overview.mdx).
**Example**: An action called `greet` with the `handler` set to `/greet` and two custom types called
`SampleInput` and `SampleOutput`
@@ -447,7 +447,7 @@ The `query_collections.yaml` file contains Metadata information about
### remote_schemas.yaml
-The `remote_schemas.yaml` file contains the Metadata related to [Remote Schemas](/remote-schemas/index.mdx).
+The `remote_schemas.yaml` file contains the Metadata related to [Remote Schemas](/remote-schemas/overview.mdx).
**Example**: A Remote Schema called `my-remote-schema` with the URL ``
diff --git a/docs/docs/migrations-metadata-seeds/migrations-metadata-setup.mdx b/docs/docs/migrations-metadata-seeds/migrations-metadata-setup.mdx
index c843909a56b..20d66b93900 100644
--- a/docs/docs/migrations-metadata-seeds/migrations-metadata-setup.mdx
+++ b/docs/docs/migrations-metadata-seeds/migrations-metadata-setup.mdx
@@ -1,22 +1,23 @@
---
-sidebar_label: Setup
+sidebar_label: Quickstart
description: Migrations & Metadata setup for an existing Hasura Server instance
sidebar_position: 2
keywords:
- hasura
- migration
- setup
+ - quickstart
- existing Hasura
---
import Thumbnail from '@site/src/components/Thumbnail';
-# Migrations & Metadata Setup
+# Quickstart Migrations & Metadata
## Introduction
-[Migrations and Metadata](/migrations-metadata-seeds/index.mdx) allow you to keep track of, update, roll-back or move
-your database and Hasura Server configurations using the [Hasura CLI](/hasura-cli/index.mdx).
+[Migrations and Metadata](/migrations-metadata-seeds/overview.mdx) allow you to keep track of, update, roll-back or move
+your database and Hasura Server configurations using the [Hasura CLI](/hasura-cli/overview.mdx).
## Get started
@@ -35,9 +36,9 @@ Any change made in the Console served by Hasura CLI which modifies your underlyi
in Migrations.
Let's set up Migrations starting with the following two tables in our schema. For this guide we're assuming you have a
-Hasura Server up and running, either on [Hasura Cloud](/getting-started/index.mdx) or as a
-[standalone installation in Docker](/getting-started/index.mdx) and have connected a database with a table that has some
-columns configured.
+Hasura Server up and running, either on [Hasura Cloud](/getting-started/getting-started-cloud.mdx) or as a
+[standalone installation in Docker](/getting-started/docker-simple.mdx) and have connected a database with a table that
+has some columns configured.
```sql
author (id uuid, name text, rating integer)
diff --git a/docs/docs/migrations-metadata-seeds/overview.mdx b/docs/docs/migrations-metadata-seeds/overview.mdx
new file mode 100644
index 00000000000..483277cd6a6
--- /dev/null
+++ b/docs/docs/migrations-metadata-seeds/overview.mdx
@@ -0,0 +1,72 @@
+---
+description: Hasura Migrations, Metadata, and Seeds
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - migrations
+ - metadata
+ - seeds
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import MMS from '@site/static/icons/features/mms.svg';
+
+# Migrations, Metadata, and Seeds
+
+
+
+
+ Hasura Migrations, Metadata, and Seeds are a set of tools that allow you to version control your Hasura project.
+ You can use these tools to track changes to your project and apply them to other environments. Hasura's Metadata
+ represents the configuration state of your project. Hasura Migrations are a set of SQL files representing changes
+ to your database over time, and Seeds are SQL files for populating your database with data.
+
+
+ Combined with git, you can use these tools to track changes to your project and apply them to other environments.
+
+
Quick Links
+
+
+
+ Get started with Migrations & Metadata.
+
+
+
+
+
+
+
+## Using Migrations & Metadata
+
+
+
+
+
Manage Migrations
+
Manage your Migrations using the Hasura CLI.
+
+
+
+
+
Manage Metadata
+
Manage your Metadata using the Hasura CLI.
+
+
+
+
+
Auto-apply Migrations & Metadata
+
+ You can configure Hasura to automatically apply Migrations and Metadata to your database. This is helpful for
+ CI/CD pipelines.
+
+
+
+
diff --git a/docs/docs/mutations/bigquery/_category_.json b/docs/docs/mutations/bigquery/_category_.json
index 49f5de48d76..b0926a21dfa 100644
--- a/docs/docs/mutations/bigquery/_category_.json
+++ b/docs/docs/mutations/bigquery/_category_.json
@@ -1,4 +1,4 @@
{
"label": "BigQuery",
- "position": 3
+ "position": 4
}
diff --git a/docs/docs/mutations/index.mdx b/docs/docs/mutations/index.mdx
deleted file mode 100644
index a174f77743e..00000000000
--- a/docs/docs/mutations/index.mdx
+++ /dev/null
@@ -1,41 +0,0 @@
----
-description: Manage mutations on your database with Hasura
-title: Mutations
-keywords:
- - hasura
- - docs
- - mutation
-slug: index
----
-
-import Mutations from '@site/static/icons/features/mutations.svg';
-
-# Mutations
-
-## Introduction
-
-GraphQL mutations are used to modify data on the server (i.e. write, update or delete data).
-
-Hasura GraphQL Engine auto-generates mutations as part of the GraphQL schema from your database's schema model.
-
-Data of all tables in the database tracked by the GraphQL Engine can be modified over the GraphQL endpoint. If you have
-a tracked table in your database, its insert/update/delete mutation fields are added as nested fields under the
-`mutation_root` root level type.
-
-## Authentication
-
-For information about authenticating your mutations see the [authentication section](/auth/authentication/index.mdx)
-here.
-
-## Explore mutations
-
-- [Explore mutations with Postgres / Citus / Hyperscale](/mutations/postgres/index.mdx)
-- [Explore mutations with MS SQL Server](/mutations/ms-sql-server/index.mdx)
-
-:::info Additional Resources
-
-- Learn how to use mutations with front-end applications -
- [Learn Tutorials](https://hasura.io/learn/#front-end-tutorials)
-- Build a full-stack application with Next.js - [Learn Tutorials](https://hasura.io/learn/#front-end-tutorials)
-
-:::
diff --git a/docs/docs/mutations/ms-sql-server/_category_.json b/docs/docs/mutations/ms-sql-server/_category_.json
index 078d4af2cad..0629758d354 100644
--- a/docs/docs/mutations/ms-sql-server/_category_.json
+++ b/docs/docs/mutations/ms-sql-server/_category_.json
@@ -1,4 +1,4 @@
{
"label": "MS SQL Server",
- "position": 2
+ "position": 5
}
diff --git a/docs/docs/mutations/overview.mdx b/docs/docs/mutations/overview.mdx
new file mode 100644
index 00000000000..85f2a07c762
--- /dev/null
+++ b/docs/docs/mutations/overview.mdx
@@ -0,0 +1,68 @@
+---
+description: Manage mutations on your database with Hasura
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - mutation
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Mutations from '@site/static/icons/features/mutations.svg';
+
+# Mutations
+
+
+
+
+ The Hasura GraphQL Engine automatically generates GraphQL mutation fields for inserting, updating, or deleting
+ data based on your database's schema. For any tracked table, a set of mutations are generated and exposed as part
+ of the GraphQL API.
+
+
+ Just as with queries, as soon you paste in your connection string and track your tables, you're ready to start
+ writing mutations!
+
+
Quick Links
+
+
+ Write your first mutation in 30 seconds.
+
+
+
+
+
+
+## Using Mutations
+
+
+
+
+
Insert data
+
Learn how to insert new data into your database using a mutation.
+
+
+
+
+
Execute multiple mutations
+
Learn how to execute multiple mutations in a single request using a single GraphQL request.
+
+
+
+
+
Update data
+
+ Learn how to update data in your database using a mutation, which enables you to update data in a single row or
+ multiple rows with one mutation.
+
+
+
+
diff --git a/docs/docs/mutations/postgres/_category_.json b/docs/docs/mutations/postgres/_category_.json
index cc7b39d0a33..c60ceebadb1 100644
--- a/docs/docs/mutations/postgres/_category_.json
+++ b/docs/docs/mutations/postgres/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Postgres",
- "position": 1
+ "position": 3
}
diff --git a/docs/docs/mutations/postgres/multiple-mutations.mdx b/docs/docs/mutations/postgres/multiple-mutations.mdx
index fce8a2e4099..e1d5808e980 100644
--- a/docs/docs/mutations/postgres/multiple-mutations.mdx
+++ b/docs/docs/mutations/postgres/multiple-mutations.mdx
@@ -21,7 +21,7 @@ any of the mutations fail, all the executed mutations will be rolled back.
:::info Note
-In requests where a [Remote Schema](/remote-schemas/index.mdx) or [Action](/actions/index.mdx) is present, and a
+In requests where a [Remote Schema](/remote-schemas/overview.mdx) or [Action](/actions/overview.mdx) is present, and a
mutation fails, rollback is not possible. Any mutations executed before the failed mutation will still succeed.
:::
diff --git a/docs/docs/mutations/quickstart.mdx b/docs/docs/mutations/quickstart.mdx
new file mode 100644
index 00000000000..863f42dd577
--- /dev/null
+++ b/docs/docs/mutations/quickstart.mdx
@@ -0,0 +1,145 @@
+---
+description: Quickstart Mutations
+title: Quickstart Mutations
+keywords:
+ - hasura
+ - docs
+ - mutations
+ - quickstart
+ - guide
+ - tutorial
+sidebar_label: Quickstart
+toc_max_heading_level: 2
+sidebar_position: 2
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
+import SampleAppBlock from '@site/src/components/SampleAppBlock';
+
+# Quickstart Mutations
+
+This quickstart will help you write your first GraphQL mutation. Mutations are used to modify data in your database.
+
+
+
+## Step 1: Open the API tab
+
+Open the `API` tab in the Hasura Console:
+
+
+
+## Step 2: Write and execute an insert mutation
+
+In the GraphiQL Explorer, paste the following `InsertReview` mutation and variables. Your API should return a similar
+response to the data on the right:
+
+
+
+## Step 3: Write and execute an update mutation
+
+In the GraphiQL Explorer, paste the `UpdateReview` mutation and the following variables. This should return a single,
+updated review with new `text`:
+
+
+
+## Step 4: Write and execute a delete mutation
+
+In the GraphiQL Explorer, paste the `DeleteReview` mutation and the following variables. This should return confirmation
+that the review was deleted by providing the `id`:
+
+
+
+## Recap
+
+What just happened? Well, you just wrote your first set of GraphQL mutations! They demonstrated the different ways in
+which you can modify data in your database using GraphQL. Let's break down each into a bit more detail.
+
+### Insert mutation
+
+Insertions are used to add new data to your database. In this case, we're adding a new review to the `reviews` table.
+
+The `InsertReview` mutation inserts a new review into the `reviews` table and returns the `id` of the newly inserted
+review. It takes the following arguments:
+
+- `rating`: The rating of the review, an integer between 1 and 5.
+- `text`: The text of the review, a string.
+- `user_id`: The ID of the user who wrote the review, a UUID.
+- `product_id`: The ID of the product that the review is for, a UUID.
+
+We made the different arguments required by using the `!` operator. This means that if you try to run the mutation
+without providing a value for one of these arguments, the GraphQL Engine will throw an error.
+
+### Update mutation
+
+Updates are used to modify existing data in your database.
+
+In this case, we're updating the `text` of an existing review. Since we're only updating the `text` of the review, we
+don't need to provide the other arguments. However, we do need to provide the `id` of the review we want to update, as
+this type uses the primary key of the table to identify which row to update.
+
+### Delete mutation
+
+Deletions are used to remove existing data from your database.
+
+With this example, we're deleting a review from the `reviews` table. We need to provide the `id` of the review we want
+to delete, as this type uses the primary key of the table to identify which row to delete.
diff --git a/docs/docs/observability/_category_.json b/docs/docs/observability/_category_.json
index e0963d47ad9..2b5e25b50b0 100644
--- a/docs/docs/observability/_category_.json
+++ b/docs/docs/observability/_category_.json
@@ -1,5 +1,5 @@
{
- "label": "Observability",
+ "label": "Observability ☁️",
"position": 150,
"className": "cloud-icon"
}
diff --git a/docs/docs/observability/how-it-works.mdx b/docs/docs/observability/how-it-works.mdx
new file mode 100644
index 00000000000..00fd5aed581
--- /dev/null
+++ b/docs/docs/observability/how-it-works.mdx
@@ -0,0 +1,57 @@
+---
+description: Hasura Observability is a set of tools that help you monitor and debug your GraphQL API
+title: How It Works
+keywords:
+ - hasura
+ - docs
+ - observability
+sidebar_position: 2
+---
+
+# Observability in Hasura Cloud
+
+Observability is a critical aspect of any application, and Hasura Cloud provides developers with a powerful set of tools
+to monitor and debug their applications. In this document, we'll explore the observability features available in Hasura
+Cloud and how they can help you build better applications.
+
+## Error Reporting
+
+Hasura Cloud provides detailed [error reporting](/observability/errors.mdx) for GraphQL queries and mutations. Whenever
+an error occurs, Hasura Cloud captures the error message, query, and other relevant information, allowing you to quickly
+identify and fix the issue. This feature is particularly useful when debugging complex GraphQL queries and mutations.
+
+## Usage Summaries
+
+Hasura Cloud provides [usage summaries](/observability/usage.mdx) for your GraphQL operations, allowing you to monitor
+the performance of your application and identify any performance bottlenecks. The usage summaries can be filtered by
+time range, operation type, and other parameters, making it easy to pinpoint performance issues.
+
+## GraphQL Operations
+
+Hasura Cloud provides detailed metrics for your [GraphQL operations](/observability/operations.mdx), including query
+latency, request count, and error rate. This information can be used to monitor the performance of your application and
+identify any issues that may be impacting your users.
+
+## Websockets
+
+Hasura Cloud supports [WebSockets](/observability/websockets.mdx), allowing you to build real-time applications that can
+push data updates to the client in real-time without having to continuously poll the server. Hasura Cloud provides
+detailed metrics for your WebSocket connections, including connection count, message count, and error rate.
+
+## Subscription Workers
+
+Hasura Cloud provides [subscription workers](/observability/subscription-workers.mdx) that can be used to process
+subscriptions and deliver real-time updates to your clients. The subscription workers are fully managed and can be
+scaled up or down based on your application's needs.
+
+## Distributed Tracing
+
+Hasura Cloud provides [distributed tracing](/observability/tracing.mdx) capabilities, allowing you to trace requests
+across multiple services and identify any performance bottlenecks. The tracing information can be used to optimize your
+application's performance and ensure that it is running smoothly.
+
+## Query Tags
+
+Hasura Cloud provides [query tags](/observability/query-tags.mdx), which can be used to tag your GraphQL queries and
+mutations with metadata. This metadata can be used to filter and group your usage summaries and metrics, making it easy
+to identify trends and patterns in your application's usage.
diff --git a/docs/docs/observability/index.mdx b/docs/docs/observability/index.mdx
deleted file mode 100644
index db31643f5f1..00000000000
--- a/docs/docs/observability/index.mdx
+++ /dev/null
@@ -1,39 +0,0 @@
----
-sidebar_label: Observability
-sidebar_position: 1
-slug: index
-title: 'Cloud: Observability'
-description: Hasura Cloud observability
-keywords:
- - hasura
- - docs
- - cloud
- - metrics
- - observability
----
-
-import Thumbnail from '@site/src/components/Thumbnail';
-import HeadingIcon from '@site/src/components/HeadingIcon';
-import Observability from '@site/static/icons/features/observability.svg';
-
-# Observability
-
-
- Available on: Cloud Standard, Cloud Professional, Cloud Enterprise
-
-
-## Overview
-
-Hasura Cloud projects include additional features for enhanced reliability and performance.
-
-
-
-## Features
-
-- [Overview](/observability/overview.mdx)
-- [Errors](/observability/errors.mdx)
-- [Usage](/observability/usage.mdx)
-- [Operations](/observability/operations.mdx)
-- [Websockets](/observability/websockets.mdx)
-- [Subscription-workers](/observability/subscription-workers.mdx)
-- [Integrations](/observability/integrations/index.mdx)
diff --git a/docs/docs/observability/integrations/_category_.json b/docs/docs/observability/integrations/_category_.json
index ca7cefba3c1..0f4278b5681 100644
--- a/docs/docs/observability/integrations/_category_.json
+++ b/docs/docs/observability/integrations/_category_.json
@@ -1,5 +1,5 @@
{
- "label": "Integrations",
- "position": 1,
+ "label": "Integrations ☁️",
+ "position": 2,
"className": "cloud-icon"
}
diff --git a/docs/docs/observability/overview.mdx b/docs/docs/observability/overview.mdx
index 4b7a8c1bab4..bcbe0e621fb 100644
--- a/docs/docs/observability/overview.mdx
+++ b/docs/docs/observability/overview.mdx
@@ -1,26 +1,72 @@
---
-sidebar_label: Stats Overview
-sidebar_position: 2
-description: Hasura Cloud stats overview
-title: 'Cloud: Stats Overview'
+description: Hasura Observability is a set of tools that help you monitor and debug your GraphQL API
+title: Overview
keywords:
- hasura
- docs
- - cloud
- - overview
+ - observability
+hide_table_of_contents: true
+sidebar_position: 1
---
import Thumbnail from '@site/src/components/Thumbnail';
-import HeadingIcon from '@site/src/components/HeadingIcon';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Observability from '@site/static/icons/features/observability.svg';
-# Stats Overview
+# Observability
-
+
Available on: Cloud Standard, Cloud Professional, Cloud Enterprise
-## Overview
+
+
+
+ Hasura Observability is a set of tools that help you monitor and debug your Hasura instance. With Observability,
+ you can check on the performance of your GraphQL API, debug errors, and get insights into your GraphQL API usage.
+ Observability is a part of Hasura Cloud and is available to all paid plans.
+
+
+ We offer integrations with popular monitoring tools like Datadog, Prometheus, and OpenTelemetry and you can
+ quickly get set up with these tools using one of our guides.
+
+
Quick Links
+
+
+ Connect an integration.
+
+
+ Learn how Observability works.
+
+
+
+
+
-The Overview displays aggregate stats over the last hour:
+## Using Observability
-
+
+
+
+
OpenTelemetry
+
Connect your Hasura GraphQL API to OpenTelemetry-compliant services.
+
+
+
+
+
Prometheus
+
Connect your Hasura GraphQL API to Prometheus.
+
+
+
+
+
Datadog
+
Connect your Hasura GraphQL API to Datadog.
+
+
+
diff --git a/docs/docs/policies/index.mdx b/docs/docs/policies/overview.mdx
similarity index 91%
rename from docs/docs/policies/index.mdx
rename to docs/docs/policies/overview.mdx
index 850d5999e9a..67829c7853d 100644
--- a/docs/docs/policies/index.mdx
+++ b/docs/docs/policies/overview.mdx
@@ -1,13 +1,12 @@
---
title: Hasura policies
description: Hasura policies
-sidebar_label: Hasura policies
+sidebar_label: Overview
sidebar_position: 0
keywords:
- hasura
- policies
- security
-slug: index
---
import Policies from '@site/static/icons/features/hasura_policies.svg';
diff --git a/docs/docs/policies/sla.mdx b/docs/docs/policies/sla.mdx
index cb6e9ca9f41..986ec685df9 100644
--- a/docs/docs/policies/sla.mdx
+++ b/docs/docs/policies/sla.mdx
@@ -1,7 +1,7 @@
---
title: 'Cloud Standard, Professional, & EE: Hasura Service Level Agreement'
description: Hasura Service Level Agreement for Hasura Cloud
-sidebar_label: Hasura SLA
+sidebar_label: Hasura SLA ☁️🏢
sidebar_position: 0
keywords:
- hasura
diff --git a/docs/docs/queries/bigquery/_category_.json b/docs/docs/queries/bigquery/_category_.json
index 49f5de48d76..b0926a21dfa 100644
--- a/docs/docs/queries/bigquery/_category_.json
+++ b/docs/docs/queries/bigquery/_category_.json
@@ -1,4 +1,4 @@
{
"label": "BigQuery",
- "position": 3
+ "position": 4
}
diff --git a/docs/docs/queries/index.mdx b/docs/docs/queries/index.mdx
deleted file mode 100644
index 695b04bc97b..00000000000
--- a/docs/docs/queries/index.mdx
+++ /dev/null
@@ -1,40 +0,0 @@
----
-description: Manage queries on your databases with Hasura
-title: Queries
-keywords:
- - hasura
- - docs
- - query
-slug: index
----
-
-import Queries from '@site/static/icons/features/queries.svg';
-
-# Queries
-
-## Introduction
-
-GraphQL queries are used to fetch data from the server.
-
-Hasura GraphQL Engine auto-generates queries as part of the GraphQL schema from your database's schema model. It
-generates a range of possible queries and operators that also work with relationships defined in your SQL schema.
-
-All tables of the database tracked by the GraphQL Engine can be queried over the GraphQL endpoint. If you have a tracked
-table in your database, its query field is added as a nested field under the `query_root` root level type.
-
-## Authentication
-
-For information about authenticating your queries see the [authentication section](/auth/authentication/index.mdx) here.
-
-## Explore queries
-
-- [Explore queries with Postgres / Citus / Hyperscale](/queries/postgres/index.mdx)
-- [Explore queries with MS SQL Server](/queries/ms-sql-server/index.mdx)
-- [Explore queries with BigQuery](/queries/bigquery/index.mdx)
-
-:::info Additional Resources
-
-- Learn how to use queries with front-end applications - [Learn Tutorials](https://hasura.io/learn/#front-end-tutorials)
-- Build a full-stack application with Next.js - [Learn Tutorials](https://hasura.io/learn/#front-end-tutorials)
-
-:::
diff --git a/docs/docs/queries/ms-sql-server/_category_.json b/docs/docs/queries/ms-sql-server/_category_.json
index 078d4af2cad..0629758d354 100644
--- a/docs/docs/queries/ms-sql-server/_category_.json
+++ b/docs/docs/queries/ms-sql-server/_category_.json
@@ -1,4 +1,4 @@
{
"label": "MS SQL Server",
- "position": 2
+ "position": 5
}
diff --git a/docs/docs/queries/overview.mdx b/docs/docs/queries/overview.mdx
new file mode 100644
index 00000000000..8354448a793
--- /dev/null
+++ b/docs/docs/queries/overview.mdx
@@ -0,0 +1,72 @@
+---
+description: Manage queries on your databases with Hasura
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - query
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Queries from '@site/static/icons/features/queries.svg';
+
+# Queries
+
+
+
+
+ With the Hasura GraphQL Engine, you get powerful, full-coverage queries right out of the box. As soon as you
+ connect your database, you'll be able to query all your related and deeply nested data easily with the power of
+ GraphQL. You'll also be able to aggregate, filter, sort, and paginate results.
+
+
+ All of this is auto-generated and is available over a single GraphQL endpoint - all you have to do is paste in
+ your database connection string and you're good to go!
+
+
Quick Links
+
+
+ Write your first query in 30 seconds.
+
+
+
+
+
+
+## Using Queries
+
+
+
+
+
Filter query results
+
+ Learn how to filter query results using where arguments.
+
+
+
+
+
+
Sort query results
+
+ Learn how to sort query results using order_by and limit arguments.
+
+
+
+
+
+
Aggregate query results
+
+ Learn how to use aggregation functions like count, sum, avg, and
+ max to aggregate query results.
+
+
+
+
diff --git a/docs/docs/queries/postgres/_category_.json b/docs/docs/queries/postgres/_category_.json
index cc7b39d0a33..c60ceebadb1 100644
--- a/docs/docs/queries/postgres/_category_.json
+++ b/docs/docs/queries/postgres/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Postgres",
- "position": 1
+ "position": 3
}
diff --git a/docs/docs/queries/quickstart.mdx b/docs/docs/queries/quickstart.mdx
new file mode 100644
index 00000000000..0e0bf0b5592
--- /dev/null
+++ b/docs/docs/queries/quickstart.mdx
@@ -0,0 +1,213 @@
+---
+description: Quickstart Queries
+title: Quickstart Queries
+keywords:
+ - hasura
+ - docs
+ - queries
+ - quickstart
+ - guide
+ - tutorial
+sidebar_label: Quickstart
+toc_max_heading_level: 2
+sidebar_position: 2
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
+import SampleAppBlock from '@site/src/components/SampleAppBlock';
+
+# Quickstart Queries
+
+This quickstart will help you write your first GraphQL query. Queries are the most common operation type in GraphQL.
+They are used to fetch data from your database.
+
+
+
+## Step 1: Open the API tab
+
+Open the `API` tab in the Hasura Console:
+
+
+
+## Step 2: Write and execute a simple query
+
+In the GraphiQL Explorer, paste the following `AllProducts` query. Your API should return the response on the right:
+
+
+
+## Step 3: Write and execute a query with variables
+
+In the GraphiQL Explorer, paste the `ProductByID` query in the query field, and the following variables in the variables
+field. This should return a single product from your database:
+
+
+
+## Step 4: Write and execute a query with a relationship
+
+In the GraphiQL Explorer, paste the `ManufacturersAndProducts` query in the query field. This should return all
+manufacturers and their products:
+
+
+
+## Recap
+
+What just happened? Well, you just wrote your first set of GraphQL queries! They increased in complexity as you went
+along, and you learned how to use variables and relationships in your queries. Let's break down each into a bit more
+detail.
+
+### Simple queries
+
+A simple query is a query that returns a single field without any filtering or special adjustments. In the `AllProducts`
+query, you queried the `products` field, which returns a list of products. As this is GraphQL, you have the option to
+query only the fields you need. In this case, you only queried the `id`, `name`, and `manufacturer` fields. This is a
+good practice to follow, as it reduces the amount of data you need to transfer over the network.
+
+### Queries with variables
+
+A query with variables is a query that uses variables to filter the results. In the `ProductByID` query, you used the
+`$id` variable to filter the results to a single product. This allows you to reuse the same query with different
+variables.
+
+### Queries with relationships
+
+A query with [relationships](/data-federation/data-federation-types.mdx) is a query that uses relationships to filter
+the results. In the `ManufacturersAndProducts` query, you used the `manufacturers` field to get a list of manufacturers.
+You then used the `products` field to get a list of products for each manufacturer. Because of this, you can fetch
+related data in a single query.
+
+:::tip Naming Operation Types
+
+It's helpful to name your operations so that you can easily identify them in the GraphiQL Explorer and in your
+application. Hasura offers a robust set of [observability tools](/observability/overview.mdx) that you can use to
+monitor your GraphQL API, namely by examining which queries are being executed, how often, and how long they take to
+execute.
+
+:::
diff --git a/docs/docs/queries/response-caching.mdx b/docs/docs/queries/response-caching.mdx
index 65f0f65b798..255d954c10c 100644
--- a/docs/docs/queries/response-caching.mdx
+++ b/docs/docs/queries/response-caching.mdx
@@ -1,6 +1,6 @@
---
description: Query response caching in Hasura Cloud
-sidebar_label: Response Caching
+sidebar_label: Response Caching ☁️🏢
title: 'Cloud: Query response caching'
keywords:
- hasura
@@ -8,7 +8,7 @@ keywords:
- cloud
- response
- caching
-sidebar_position: 3
+sidebar_position: 6
sidebar_class_name: cloud-and-enterprise-icon
---
diff --git a/docs/docs/remote-schemas/adding-schema.mdx b/docs/docs/remote-schemas/adding-schema.mdx
index 324cfe21423..96df19cb8df 100644
--- a/docs/docs/remote-schemas/adding-schema.mdx
+++ b/docs/docs/remote-schemas/adding-schema.mdx
@@ -5,7 +5,7 @@ keywords:
- docs
- remote schema
- add
-sidebar_position: 2
+sidebar_position: 3
---
import Thumbnail from '@site/src/components/Thumbnail';
diff --git a/docs/docs/remote-schemas/index.mdx b/docs/docs/remote-schemas/index.mdx
deleted file mode 100644
index f7cd2d385be..00000000000
--- a/docs/docs/remote-schemas/index.mdx
+++ /dev/null
@@ -1,69 +0,0 @@
----
-description: Manage Remote Schemas with Hasura
-keywords:
- - hasura
- - docs
- - remote schema
-slug: index
-title: Remote Schemas
-sidebar_position: 1
----
-
-import Thumbnail from '@site/src/components/Thumbnail';
-import Remote from '@site/static/icons/features/remote_schema.svg';
-
-# Remote Schemas
-
-## Introduction
-
-Hasura gives you CRUD + realtime GraphQL APIs with authorization & access control. However, in many cases, you will need
-to write APIs (queries, mutations) that contain custom logic. For example, implementing a payment API, or querying data
-that is not in your database.
-
-Hasura has the ability to merge remote GraphQL schemas and provide a unified GraphQL API. Think of it like automated
-schema stitching. All you need to do is build your own GraphQL service and then provide the HTTP endpoint to Hasura.
-Your GraphQL service can be written in any language or framework.
-
-This is what Hasura running with "Remote Schemas" looks like:
-
-
-
-## Use cases
-
-- Custom business logic, like a payment API
-- Querying data that is not available in your database
-
-You can handle these use cases by writing resolvers in a custom GraphQL server and making Hasura merge this "remote
-schema" with the existing auto-generated schema. You can also add multiple Remote Schemas. Think of the merged schema as
-a union of top-level nodes from each of the sub-schemas.
-
-:::info Health monitoring of Remote Schemas in Hasura Cloud
-
-Hasura Cloud offers built-in API metrics with integrated Health Checks and distributed tracing for your Remote Schemas.
-Read more at [Distributed Tracing in Hasura Cloud](/observability/tracing.mdx).
-
-:::
-
-:::info Remote Schema Subscriptions
-
-Note that subscriptions are currently not supported for Remote Schemas.
-
-:::
-
-## Learn more
-
-- [Adding a Remote Schema](/remote-schemas/adding-schema.mdx)
-- [Remote relationships](/remote-schemas/remote-relationships/index.mdx)
-- [Authorization in Remote Schemas](/remote-schemas/auth/index.mdx)
-
-:::info Additional Resources
-
-Data Federation with Hasura -
-[Watch Webinar](https://hasura.io/events/webinar/data-federation-hasura-graphql/?pg=docs&plcmt=body&cta=watch-webinar&tech=).
-
-:::
diff --git a/docs/docs/remote-schemas/overview.mdx b/docs/docs/remote-schemas/overview.mdx
new file mode 100644
index 00000000000..6988232d7b0
--- /dev/null
+++ b/docs/docs/remote-schemas/overview.mdx
@@ -0,0 +1,75 @@
+---
+description: Hasura Remote Schemas
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - remote schemas
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Remote from '@site/static/icons/features/remote_schema.svg';
+
+# Remote Schemas
+
+
+
+
+ Hasura has the abilty to merge your remote GraphQL schemas and provide you with a single, unified GraphQL API. Think of it
+ like automated schema stitching.
+
+
+ This enables you to write queries and mutations to disparate sources, all from your single Hasura endpoint. All you
+ need to provide is a GraphQL service - such as a CMS, payment provider, or custom GraphQL server - and
+ connect its HTTP endpoint to Hasura; we'll take care of the rest.
+
+
Quick Links
+
+
+ Get started with Remote Schemas in 60 seconds.
+
+
+ How to extend your API with remote joins.
+
+
+
+
+
+
+
+
+
+## Using Remote Schemas
+
+
+
+
+
Add Remote Schemas
+
Create a Remote Schema to extend your GraphQL API's functionality.
+
+
+
+
+
Forwarding Auth Context
+
Forward your Hasura Auth context to your Remote Schemas to enable granular access control.
+
+
+
+
+
Remote Schema Permissions
+
Control granular access to your Remote Schemas using Hasura Permissions.
+
+
+
diff --git a/docs/docs/remote-schemas/quickstart.mdx b/docs/docs/remote-schemas/quickstart.mdx
new file mode 100644
index 00000000000..fc67424c928
--- /dev/null
+++ b/docs/docs/remote-schemas/quickstart.mdx
@@ -0,0 +1,190 @@
+---
+description: Quickstart with Hasura Remote Schemas
+title: Quickstart
+keywords:
+ - hasura
+ - docs
+ - remote schemas
+ - quickstart
+sidebar_position: 2
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
+import SampleAppBlock from '@site/src/components/SampleAppBlock';
+
+# Quickstart
+
+## Overview
+
+This quickstart will help you connect your first Remote Schema.
+
+
+
+## Step 1: Click Add
+
+From the Console, navigate to the `Remote Schemas` page. At the top of the page, click `Add`:
+
+
+
+## Step 2: Enter the basics
+
+Name this remote schema `countries_api` and enter the following value in the `GraphQL Service URL` field:
+
+```
+https://countries.trevorblades.com/graphql
+```
+
+
+
+Scroll to the bottom of the page and click `Add Remote Schema`.
+
+After clicking this button, you'll see the details of your newly connected API:
+
+
+
+:::tip That's it?!
+
+Yep, that's it! You've just joined a remote GraphQL service with your Hasura GraphQL API 🔥
+
+You could head to the API tab and query data from this new API, but keep reading if you're using the docs sample app to
+see the power of a unified schema by creating a relationship with our existing data model.
+
+:::
+
+## Step 3: Add a relationship
+
+Click the `Data` tab at the top of the page, select the `Products` table from the left-hand side navigation, and click
+`Relationships`. Scroll to the bottom of this page to find the `Remote Schema Relationships` and then click
+`Add a remote schema relationship`:
+
+
+
+## Step 4: Configure the relationship
+
+Call the relationship `countryInfo` and select `countries_api` from the `Remote Schema` dropdown.
+
+Then, under `Configuration`, check `countries`. Nested within `countries`, check the `filter` option and select `code`,
+then `eq`. We'll use the `country_of_origin` column as the foreign key for this relationship. When you've completed
+these steps, scroll down and click `Save`.
+
+
+
+## Step 5: Test it out
+
+Head to the `API` tab and try this query; you should see a response similar to this:
+
+
+
+Since our `products` table has a `country_of_origin` field, each product has a country code as its value. We can use
+this to filter by this value and return the data we want - in this case, a flag emoji - for our front end.
+
+## Recap
+
+What did we just do? Well, you just connected a remote GraphQL API to your Hasura GraphQL API and created a
+[relationship between your existing data model and the new API](/data-federation/data-federation-types.mdx#database-to-remote-schema-relationships).
+This means you can query data from both APIs in a single query, and also use the data from the remote API to filter or
+augment your existing data model 🎉
+
+In our example, we used the data from the remote API to filter our existing data model by a country code, and then
+return the data we want for that country. Common use cases include filtering for an id or a name.
+
+All Hasura needs is a GraphQL endpoint to connect to, and it will automatically generate a GraphQL schema for you. This
+means you can connect to any GraphQL API - or even multiple APIs - and access all your data in a single query from your
+Hasura GraphQL API.
diff --git a/docs/docs/remote-schemas/remote-relationships/index.mdx b/docs/docs/remote-schemas/remote-relationships/index.mdx
index 7a94495e3bc..df1b2b9e70a 100644
--- a/docs/docs/remote-schemas/remote-relationships/index.mdx
+++ b/docs/docs/remote-schemas/remote-relationships/index.mdx
@@ -15,7 +15,7 @@ sidebar_label: Remote relationships
## Introduction
Remote relationships (aka "remote joins") allow you to join data across Remote Schemas and other remote data sources.
-The remote data source can either be another [Remote Schema](/remote-schemas/index.mdx) or a table from a database
+The remote data source can either be another [Remote Schema](/remote-schemas/overview.mdx) or a table from a database
source. Once you create relationships between types from your Remote Schema and types created from databases or other
Remote Schemas, you can then "join" them by running GraphQL queries.
diff --git a/docs/docs/remote-schemas/remote-relationships/remote-schema-db-relationships.mdx b/docs/docs/remote-schemas/remote-relationships/remote-schema-db-relationships.mdx
index 59e7c18a7a5..bdb487808b6 100644
--- a/docs/docs/remote-schemas/remote-relationships/remote-schema-db-relationships.mdx
+++ b/docs/docs/remote-schemas/remote-relationships/remote-schema-db-relationships.mdx
@@ -38,7 +38,7 @@ Relationships from Remote Schema to database are supported from versions `v2.6.0
### Step 0: Add a Remote Schema and a database
Add a Remote Schema and a database as described [here](/remote-schemas/adding-schema.mdx) and
-[here](/databases/connect-db/index.mdx), if not already added.
+[here](/databases/overview.mdx), if not already added.
### Step 1: Define and create the relationship
diff --git a/docs/docs/resources/index.mdx b/docs/docs/resources/overview.mdx
similarity index 96%
rename from docs/docs/resources/index.mdx
rename to docs/docs/resources/overview.mdx
index 9eef6dc2fbe..283ef8b181c 100644
--- a/docs/docs/resources/index.mdx
+++ b/docs/docs/resources/overview.mdx
@@ -1,13 +1,14 @@
---
description: Resources around using Hasura and GraphQL
title: Resources
+sidebar_label: Overview
keywords:
- hasura
- docs
- guide
- tutorial
- resource
-slug: index
+sidebar_position: 1
---
import Resources from '@site/static/icons/features/resources.svg';
diff --git a/docs/docs/resources/tutorials.mdx b/docs/docs/resources/tutorials.mdx
index 28eb03271d9..d903ecfc66b 100644
--- a/docs/docs/resources/tutorials.mdx
+++ b/docs/docs/resources/tutorials.mdx
@@ -7,7 +7,7 @@ keywords:
- tutorials
- graphql
- learn
-sidebar_position: 1
+sidebar_position: 2
# adding to avoid redirect as this was only index file under the directory
slug: tutorials/index
---
diff --git a/docs/docs/resources/upgrade-hasura-v2.mdx b/docs/docs/resources/upgrade-hasura-v2.mdx
index 876aef1829c..703dc6481fa 100644
--- a/docs/docs/resources/upgrade-hasura-v2.mdx
+++ b/docs/docs/resources/upgrade-hasura-v2.mdx
@@ -32,7 +32,7 @@ The following are the most significant conceptual changes introduced in Hasura v
unique "source name" that is used to identify it. Apart from Postgres, connecting to SQL server databases is also now
supported.
- Config for connecting a database used to be a startup configuration (i.e. set via env vars/flags) but since v2, it is
- a part of Hasura Metadata and can be managed dynamically. See [connecting databases](/databases/connect-db/index.mdx).
+ a part of Hasura Metadata and can be managed dynamically. See [connecting databases](/databases/overview.mdx).
- Hasura Metadata can now be stored in a separate dedicated Postgres DB.
:::info Note
@@ -201,7 +201,7 @@ instance**.
Post adding a database named `default`, the Hasura v2 instance should behave equivalently to the Hasura v1 instance and
all previous workflows will continue working as they were.
-Refer to [connecting databases](/databases/connect-db/index.mdx) to add a database to Hasura v2.
+Refer to [connecting databases](/databases/overview.mdx) to add a database to Hasura v2.
### Migrate Hasura v1 instance to Hasura v2
diff --git a/docs/docs/scheduled-triggers/clean-up.mdx b/docs/docs/scheduled-triggers/clean-up.mdx
index 6d9e1f7f448..70127948fe9 100644
--- a/docs/docs/scheduled-triggers/clean-up.mdx
+++ b/docs/docs/scheduled-triggers/clean-up.mdx
@@ -8,7 +8,7 @@ keywords:
- scheduled events
- clean up
- purge logs
-sidebar_position: 3
+sidebar_position: 5
sidebar_label: Clean Up Scheduled Triggers data
---
diff --git a/docs/docs/scheduled-triggers/create-cron-trigger.mdx b/docs/docs/scheduled-triggers/create-cron-trigger.mdx
index bc274abda8f..3bf54f1c712 100644
--- a/docs/docs/scheduled-triggers/create-cron-trigger.mdx
+++ b/docs/docs/scheduled-triggers/create-cron-trigger.mdx
@@ -6,7 +6,7 @@ keywords:
- cron trigger
- scheduled trigger
- create
-sidebar_position: 1
+sidebar_position: 3
---
import Thumbnail from '@site/src/components/Thumbnail';
diff --git a/docs/docs/scheduled-triggers/create-one-off-scheduled-event.mdx b/docs/docs/scheduled-triggers/create-one-off-scheduled-event.mdx
index 04c7a9bc4ab..a168e0030f7 100644
--- a/docs/docs/scheduled-triggers/create-one-off-scheduled-event.mdx
+++ b/docs/docs/scheduled-triggers/create-one-off-scheduled-event.mdx
@@ -6,7 +6,7 @@ keywords:
- one off scheduled event
- scheduled trigger
- create
-sidebar_position: 2
+sidebar_position: 4
sidebar_label: Create a one-off Scheduled Event
---
diff --git a/docs/docs/scheduled-triggers/how-it-works.mdx b/docs/docs/scheduled-triggers/how-it-works.mdx
new file mode 100644
index 00000000000..085f608cf1b
--- /dev/null
+++ b/docs/docs/scheduled-triggers/how-it-works.mdx
@@ -0,0 +1,38 @@
+---
+description: How to use Hasura's scheduled triggers to run cron jobs on your database
+title: 'How it Works: Scheduled Triggers'
+keywords:
+ - hasura
+ - docs
+ - scheduled triggers
+ - quickstart
+ - guide
+ - tutorial
+sidebar_label: How it works
+sidebar_position: 3
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
+
+# How It Works: Scheduled Triggers
+
+Hasura Scheduled Triggers is a powerful feature that allows you to schedule tasks or events in your application based on
+specific time intervals. It is a trigger-based system that executes tasks at predefined intervals, specified in a
+cron-like syntax.
+
+## How Hasura Scheduled Triggers Work
+
+Hasura Scheduled Triggers work by executing a webhook at a specified time interval. A webhook is an HTTP callback that
+is triggered by an event. When the webhook is triggered, it sends a request to the specified endpoint, which then
+executes the task or event defined.
+
+## Use Cases of Hasura Scheduled Triggers
+
+Hasura Scheduled Triggers can be used for a variety of use cases, including:
+
+- Sending reminders to users about upcoming events or appointments
+- Generating reports or analytics on a scheduled basis
+- Updating or cleaning up data on a regular basis, such as archiving old data or deleting expired records
+- Running maintenance tasks, such as backups or security checks
+- Scheduling automated emails or notifications to users
diff --git a/docs/docs/scheduled-triggers/index.mdx b/docs/docs/scheduled-triggers/index.mdx
deleted file mode 100644
index 887a03e5ea5..00000000000
--- a/docs/docs/scheduled-triggers/index.mdx
+++ /dev/null
@@ -1,39 +0,0 @@
----
-description: Create a Scheduled Trigger with Hasura
-title: Scheduled Triggers
-keywords:
- - hasura
- - docs
- - scheduled trigger
-slug: index
----
-
-import Thumbnail from '@site/src/components/Thumbnail';
-
-import ScheduledTriggers from '@site/static/icons/features/scheduled_triggers.svg';
-
-# Scheduled Triggers
-
-## Introduction
-
-Scheduled Triggers are used to execute custom business logic at specific points in time.
-
-
-
-:::tip Supported from
-
-Scheduled Triggers are supported from versions `v1.3.0` and above.
-
-:::
-
-## Types
-
-There are two types of timed events:
-
-- [Cron triggers](/scheduled-triggers/create-cron-trigger.mdx): based on a cron schedule.
-- [One-off scheduled events](/scheduled-triggers/create-one-off-scheduled-event.mdx): based on a fixed timestamp.
diff --git a/docs/docs/scheduled-triggers/overview.mdx b/docs/docs/scheduled-triggers/overview.mdx
new file mode 100644
index 00000000000..2bfc10f2632
--- /dev/null
+++ b/docs/docs/scheduled-triggers/overview.mdx
@@ -0,0 +1,78 @@
+---
+description: Hasura Scheduled Triggers
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - scheduled
+ - triggers
+ - cron
+ - business logic
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import ScheduledTriggers from '@site/static/icons/features/scheduled_triggers.svg';
+
+# Scheduled Triggers
+
+
+
+
+ Scheduled Triggers are a way to run custom business logic on a schedule. They are a powerful way to automate your
+ tasks and integrate with other services.
+
+
+ With Scheduled Triggers, you can create Cron Jobs that run at specified intervals, or run a one-off task at a
+ specified time, or even automate data clean to regularly keep your data and logs in order.
+
+
Quick Links
+
+
+
+ Get started with Scheduled Triggers 60 seconds.
+
+
+
+ Learn how Scheduled Triggers work.
+
+
+
+
+
+
+
+
+## Using Scheduled Triggers
+
+
+
+
+
Cron Triggers
+
Create a Cron Trigger to run custom business logic at a specified interval.
+
+
+
+
+
One-off Scheduled Events
+
Create a one-off scheduled event to run custom business logic at a specified time.
+
+
+
+
+
Clean up
+
Purge your data and keep your logs tidy.
+
+
+
diff --git a/docs/docs/scheduled-triggers/quickstart.mdx b/docs/docs/scheduled-triggers/quickstart.mdx
new file mode 100644
index 00000000000..5eddba8adbc
--- /dev/null
+++ b/docs/docs/scheduled-triggers/quickstart.mdx
@@ -0,0 +1,149 @@
+---
+description: Quickstart Scheduled Triggers
+title: Quickstart Scheduled Triggers
+keywords:
+ - hasura
+ - docs
+ - scheduled triggers
+ - quickstart
+ - guide
+ - tutorial
+sidebar_label: Quickstart
+sidebar_position: 2
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
+import SampleAppBlock from '@site/src/components/SampleAppBlock';
+
+# Quickstart Scheduled Triggers
+
+This quickstart will help you create your first Scheduled Trigger. We're going to simulate an automated process wherein
+a Hasura instance will hit an endpoint and email users who have abandoned carts older than 24 hours.
+
+
+
+## Step 1: Click create
+
+Head to the `Events` tab of the Hasura Console and choose `Cron Triggers` on the left-hand side:
+
+
+
+Then, click `Create`.
+
+## Step 2: Enter the basics
+
+Let's call this Scheduled Trigger `abandoned_carts_notification` by entering this value in the `Name` field.
+Additionally, we have an endpoint you can hit to simulate a real-world scenario. Enter this value in the `Webhook URL`
+field:
+
+```
+https://us-central1-websitecloud-352908.cloudfunctions.net/docs-scheduled-trigger-sample-app
+```
+
+
+
+## Step 3: Add the cron expression
+
+Next, we'll enter a cron expression to determine when this Scheduled Trigger should fire. We'll use the following
+expression to execute this Scheduled Trigger every minute:
+
+```
+* * * * *
+```
+
+## Step 4: Add the request payload
+
+Next, we'll add the request payload. This is the data that will be sent to the endpoint we specified in Step 2. We'll
+use the following values, replacing `` with your own project name`:
+
+```json
+{
+ "endpoint": "https://.hasura.app/v1/graphql",
+ "secret": ""
+}
+```
+
+:::warning Don't send your admin secret to in the request payload in a real-world scenario
+
+This _is_ a quickstart, so we're cutting some corners by providing you an endpoint to demonstrate the power of Scheduled
+Triggers. In a real-world scenario, you'd want to handle validating your project's admin secret on the server-side.
+
+:::
+
+Our webhook is expecting a `POST` request, so we'll change the `Request Method` to `POST` by clicking
+`Add Request Options Transform` and selecting `POST`:
+
+
+
+With the payload configured, click `Add Cron Trigger`.
+
+## Step 5: 🍿
+
+First, we'll check the `Pending events` tab. Here, you'll see a list of all the Scheduled Triggers that are pending. The
+schedule should match the cron expression we specified in Step 3:
+
+
+
+After a minute, we can head over to the `Processed events` tab. Here, you'll see a list of all the Scheduled Triggers
+that have been processed along with their status.
+
+
+
+For each invocation, we can expand the `request` and `response` sections to see more information about what Hasura sent
+to the webhook, and what was received. You'll see the `body` of your response contains a list of users, specific to your
+instance, who have abandoned carts older than 24 hours:
+
+```json
+{
+ "data": {
+ "body": "{\"endpoint\":\"https://.hasura.app/v1/graphql\",\"unfinished_carts\":3,\"emails\":[\"Hello, Rob! \\n\\nYou have items in your cart: Hasuras in The Cloud Tee, Get Ship Done Mug, Sticker Sheet. \\n\\nDon't you want to buy them?\",\"Hello, Marion! \\n\\nYou have items in your cart: Monogram Baseball Cap, The Original Tee, Sticker Sheet. \\n\\nDon't you want to buy them?\",\"Hello, Abby! \\n\\nYou have items in your cart: Monogram Baseball Cap, The Original Tee. \\n\\nDon't you want to buy them?\"]}",
+ // headers
+ "status": 200
+ },
+ "type": "webhook_response",
+ "version": "1"
+}
+```
+
+## Recap
+
+What just happened? Well, you just created your first Scheduled Trigger! You can now use triggers to automate processes
+like sending emails, notifying users, or even updating your database. As a
+[cron job](/scheduled-triggers/create-cron-trigger.mdx), this trigger will fire based on the schedule you specified.
+
+First, we provided Hasura a webhook as an endpoint. This webhook is simply our demo serverless function that's hosted on
+Google Cloud. It will parse the value you send from Hasura's Scheduled Trigger and query against your own GraphQL API.
+In a real application, you'd use your own webhook that's either a serverless function, a third-party service, or a
+custom endpoint to validate your admin secret and execute your custom logic.
+
+Next, we provided Hasura with a cron expression. This expression determines when the Scheduled Trigger should fire.
+We're using this value (`* * * * *`) as a simulation. In a real-world scenario, you'd probably want to use a value like
+`0 0 * * *` so that this Scheduled Trigger fires once a day at midnight. You can easily create your own cron expression
+using [this tool](https://crontab.guru/).
+
+Finally, we provided Hasura with a request payload before changing the request method to `POST`. This payload is the
+data that will be sent to the webhook. When the Scheduled Trigger fires, Hasura will send this payload to the webhook
+and the webhook will execute the logic you've written. For the scenario in our example, we returned the bodies of emails
+that our webhook would have sent to users so you can see that we're actually able to query data from this instance and
+use it in our application.
diff --git a/docs/docs/schema/_category_.json b/docs/docs/schema/_category_.json
index 8f86a5ea7f0..36e9b557252 100644
--- a/docs/docs/schema/_category_.json
+++ b/docs/docs/schema/_category_.json
@@ -1,4 +1,4 @@
{
- "label": "Schema",
+ "label": "GraphQL Schema",
"position": 30
}
diff --git a/docs/docs/schema/bigquery/_category_.json b/docs/docs/schema/bigquery/_category_.json
index 49f5de48d76..b0926a21dfa 100644
--- a/docs/docs/schema/bigquery/_category_.json
+++ b/docs/docs/schema/bigquery/_category_.json
@@ -1,4 +1,4 @@
{
"label": "BigQuery",
- "position": 3
+ "position": 4
}
diff --git a/docs/docs/schema/bigquery/remote-relationships/index.mdx b/docs/docs/schema/bigquery/remote-relationships/index.mdx
index c7f6ab67de4..ecf91a7daf7 100644
--- a/docs/docs/schema/bigquery/remote-relationships/index.mdx
+++ b/docs/docs/schema/bigquery/remote-relationships/index.mdx
@@ -15,9 +15,9 @@ keywords:
## Introduction
Remote relationships (aka "remote joins") allow you to join data across tables and remote data sources. The remote data
-source can either be a [Remote Schema](/remote-schemas/index.mdx), a table from a second database source, or the type
-returned from an [action](/actions/index.mdx). Once you create relationships between types from your database tables and
-types created from Remote Schemas or actions, you can then "join" them by running GraphQL queries.
+source can either be a [Remote Schema](/remote-schemas/overview.mdx), a table from a second database source, or the type
+returned from an [action](/actions/overview.mdx). Once you create relationships between types from your database tables
+and types created from Remote Schemas or actions, you can then "join" them by running GraphQL queries.
See the following guides on how to create different types of remote relationships related to BigQuery:
diff --git a/docs/docs/schema/bigquery/remote-relationships/remote-schema-relationships.mdx b/docs/docs/schema/bigquery/remote-relationships/remote-schema-relationships.mdx
index 98b38af04a4..ab97cd4fcd1 100644
--- a/docs/docs/schema/bigquery/remote-relationships/remote-schema-relationships.mdx
+++ b/docs/docs/schema/bigquery/remote-relationships/remote-schema-relationships.mdx
@@ -48,7 +48,7 @@ Remote Schema relationships from BigQuery are supported from versions `v1.3.0` a
### Step 0: Add a Remote Schema and a database
Add a Remote Schema and a database as described [here](/remote-schemas/adding-schema.mdx) and
-[here](/databases/connect-db/index.mdx), if not already added.
+[here](/databases/overview.mdx), if not already added.
### Step 1: Define and create the relationship
diff --git a/docs/docs/schema/bigquery/remote-relationships/remote-source-relationships.mdx b/docs/docs/schema/bigquery/remote-relationships/remote-source-relationships.mdx
index e97fd54900f..ee5ea0dd2ae 100644
--- a/docs/docs/schema/bigquery/remote-relationships/remote-source-relationships.mdx
+++ b/docs/docs/schema/bigquery/remote-relationships/remote-source-relationships.mdx
@@ -40,7 +40,7 @@ Remote database relationships for BigQuery are supported from versions `v2.1.0`
### Step 0: Add two database sources
-Add a source database as described [here](/databases/connect-db/index.mdx) and track the required tables. Then, repeat
+Add a source database as described [here](/databases/overview.mdx) and track the required tables. Then, repeat
the process to add your target database.
### Step 1: Define and create the relationship
diff --git a/docs/docs/schema/common-patterns/_category_.json b/docs/docs/schema/common-patterns/_category_.json
index 10fa4afcf62..bc453fdfd64 100644
--- a/docs/docs/schema/common-patterns/_category_.json
+++ b/docs/docs/schema/common-patterns/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Common Patterns",
- "position": 4
+ "position": 5
}
diff --git a/docs/docs/schema/index.mdx b/docs/docs/schema/index.mdx
deleted file mode 100644
index 65ea99f4d13..00000000000
--- a/docs/docs/schema/index.mdx
+++ /dev/null
@@ -1,56 +0,0 @@
----
-description: Manage schema on your database with Hasura
-title: Schema
-keywords:
- - hasura
- - docs
- - schema
-slug: index
----
-
-import Schema from '@site/static/icons/features/schema.svg';
-
-# Schema
-
-## Introduction
-
-The Hasura GraphQL Engine automatically generates your GraphQL schema and resolvers based on your tables/views in your
-database. **You don't need to write a GraphQL schema or resolvers.** See
-[How Hasura GraphQL Engine works](/getting-started/how-it-works/index.mdx) for more details.
-
-The Hasura Console gives you UI tools that speed up your data-modeling process, or working with your existing database.
-The Console also automatically generates Migrations or Metadata files that you can edit directly and check into your
-version control.
-
-The Hasura GraphQL Engine lets you do anything you would usually do with your database by giving you GraphQL over native
-constructs.
-
-:::info Note
-
-Hasura supports many types out of the box. For strings, Hasura can recognize and return UTF-8 encoded string types from your database.
-
-If string-type columns in your database have an encoding other than UTF-8, unexpected values may be returned for queries made on those columns.
-
-:::
-
-## Explore schema
-
-- [Explore schema with Postgres / Citus / Hyperscale](/schema/postgres/index.mdx)
-- [Explore schema with MS SQL Server](/schema/ms-sql-server/index.mdx)
-- [Explore schema with BigQuery](/schema/bigquery/index.mdx)
-
-
diff --git a/docs/docs/schema/ms-sql-server/_category_.json b/docs/docs/schema/ms-sql-server/_category_.json
index 078d4af2cad..eecdf9c6941 100644
--- a/docs/docs/schema/ms-sql-server/_category_.json
+++ b/docs/docs/schema/ms-sql-server/_category_.json
@@ -1,4 +1,4 @@
{
"label": "MS SQL Server",
- "position": 2
+ "position": 4
}
diff --git a/docs/docs/schema/ms-sql-server/mssql-guides/mssql-read-replicas-docker-setup.mdx b/docs/docs/schema/ms-sql-server/mssql-guides/mssql-read-replicas-docker-setup.mdx
index 1c3da1b10ac..628b7928552 100644
--- a/docs/docs/schema/ms-sql-server/mssql-guides/mssql-read-replicas-docker-setup.mdx
+++ b/docs/docs/schema/ms-sql-server/mssql-guides/mssql-read-replicas-docker-setup.mdx
@@ -427,4 +427,4 @@ sqlcmd -S 172.16.238.21,1434 -U SA -d agtestdb -P "Password1" -K ReadOnly
## Next Steps
With your read replicas set up, consider learning more about Hasura's
-[Migrations, Metadata, and Seeds](/migrations-metadata-seeds/index.mdx).
+[Migrations, Metadata, and Seeds](/migrations-metadata-seeds/overview.mdx).
diff --git a/docs/docs/schema/ms-sql-server/remote-relationships/index.mdx b/docs/docs/schema/ms-sql-server/remote-relationships/index.mdx
index a01b8f06dc7..282183f3eec 100644
--- a/docs/docs/schema/ms-sql-server/remote-relationships/index.mdx
+++ b/docs/docs/schema/ms-sql-server/remote-relationships/index.mdx
@@ -15,7 +15,7 @@ keywords:
## Introduction
Remote relationships (aka "remote joins") allow you to join data across tables and remote data sources. The remote data
-source can either be a [Remote Schema](/remote-schemas/index.mdx) or a table from a second database source. Once you
+source can either be a [Remote Schema](/remote-schemas/overview.mdx) or a table from a second database source. Once you
create relationships between types from your database tables and types created from Remote Schemas, you can then "join"
them by running GraphQL queries.
diff --git a/docs/docs/schema/ms-sql-server/remote-relationships/remote-schema-relationships.mdx b/docs/docs/schema/ms-sql-server/remote-relationships/remote-schema-relationships.mdx
index 8037e226fe4..6e7348f8d5e 100644
--- a/docs/docs/schema/ms-sql-server/remote-relationships/remote-schema-relationships.mdx
+++ b/docs/docs/schema/ms-sql-server/remote-relationships/remote-schema-relationships.mdx
@@ -47,7 +47,7 @@ Remote Schema relationships from MS SQL Server are supported from versions `v2.6
### Step 0: Add a Remote Schema and a database
Add a Remote Schema and a database as described [here](/remote-schemas/adding-schema.mdx) and
-[here](/databases/connect-db/index.mdx), if not already added.
+[here](/databases/overview.mdx), if not already added.
### Step 1: Define and create the relationship
diff --git a/docs/docs/schema/ms-sql-server/remote-relationships/remote-source-relationships.mdx b/docs/docs/schema/ms-sql-server/remote-relationships/remote-source-relationships.mdx
index a50f22449c8..e66f0347ba5 100644
--- a/docs/docs/schema/ms-sql-server/remote-relationships/remote-source-relationships.mdx
+++ b/docs/docs/schema/ms-sql-server/remote-relationships/remote-source-relationships.mdx
@@ -39,7 +39,7 @@ Remote database relationships for MS SQL Server are supported from versions `v2.
### Step 0: Add two database sources
-Add a source database as described [here](/databases/connect-db/index.mdx) and track the required tables. Then, repeat
+Add a source database as described [here](/databases/overview.mdx) and track the required tables. Then, repeat
the process to add your target database.
### Step 1: Define and create the relationship
diff --git a/docs/docs/schema/overview.mdx b/docs/docs/schema/overview.mdx
new file mode 100644
index 00000000000..182d66faae5
--- /dev/null
+++ b/docs/docs/schema/overview.mdx
@@ -0,0 +1,81 @@
+---
+description: Manage schema on your database with Hasura
+keywords:
+ - hasura
+ - docs
+ - schema
+title: Overview
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Schema from '@site/static/icons/features/schema.svg';
+
+# GraphQL Schema
+
+
+
+
+ Hasura's GraphQL Engine can be used to build a flexible and scalable GraphQL API on top of your existing Postgres,
+ MySQL, Microsoft SQL Server, Athena, Snowflake, BigQuery, or Oracle database.
+
+
+ The Hasura GraphQL Engine automatically generates a GraphQL schema based on the tables and views in your database.{' '}
+ You no longer need to write a GraphQL schema, endpoints, or resolvers.
+
+
+ The Hasura GraphQL Engine lets you do anything you would usually do with your database by giving you GraphQL over
+ native constructs.
+
+
Quick Links
+
+
+
+ Create tables on a connected data source in less than 30 seconds.
+
+
+
+ Learn more about how Hasura works.
+
+
+
+
+
+
+## Understanding the GraphQL Schema
+
+
+
+
+
Import data from a CSV
+
+ Learn how to quickly and easily import data from a CSV file into a table in your Postgres database using psql.
+
+
+
+
+
+
Extend your GraphQL schema with SQL functions
+
+ Learn how to extend your GraphQL schema with SQL functions. This is useful when you want to add custom business
+ logic to your GraphQL API.
+
+
+
+
+
+
Extend your GraphQL schema with Postgres views
+
+ Learn how to extend your GraphQL schema with Postgres views. This is allows you to view the results of a custom
+ query as a virtual table.
+
+
+
+
diff --git a/docs/docs/schema/postgres/_category_.json b/docs/docs/schema/postgres/_category_.json
index cc7b39d0a33..c60ceebadb1 100644
--- a/docs/docs/schema/postgres/_category_.json
+++ b/docs/docs/schema/postgres/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Postgres",
- "position": 1
+ "position": 3
}
diff --git a/docs/docs/schema/postgres/data-validations.mdx b/docs/docs/schema/postgres/data-validations.mdx
index 25decd779cb..f471dc60855 100644
--- a/docs/docs/schema/postgres/data-validations.mdx
+++ b/docs/docs/schema/postgres/data-validations.mdx
@@ -466,7 +466,7 @@ A few features on the roadmap should simplify this experience in the future.
## Using Hasura Actions
If the validation requires complex custom business logic and/or needs information from external sources, you can use
-[Actions](/actions/index.mdx) to perform your validation.
+[Actions](/actions/overview.mdx) to perform your validation.
**Example:** Check with an external service that an author's name is not deny-listed before inserting them.
diff --git a/docs/docs/schema/postgres/postgres-guides/triggers.mdx b/docs/docs/schema/postgres/postgres-guides/triggers.mdx
index 3b0d925ebaf..7a24ca81260 100644
--- a/docs/docs/schema/postgres/postgres-guides/triggers.mdx
+++ b/docs/docs/schema/postgres/postgres-guides/triggers.mdx
@@ -89,7 +89,7 @@ Postgres triggers can be used to perform business logic such as data validation
:::info Note
-Hasura also has [Event Triggers](/event-triggers/index.mdx) that can be used to invoke external HTTP APIs for executing
+Hasura also has [Event Triggers](/event-triggers/overview.mdx) that can be used to invoke external HTTP APIs for executing
custom business logic on database events.
:::
diff --git a/docs/docs/schema/postgres/remote-relationships/action-relationships.mdx b/docs/docs/schema/postgres/remote-relationships/action-relationships.mdx
index 9ccb81307aa..18cf916c0ec 100644
--- a/docs/docs/schema/postgres/remote-relationships/action-relationships.mdx
+++ b/docs/docs/schema/postgres/remote-relationships/action-relationships.mdx
@@ -21,7 +21,7 @@ import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
Action relationships allow you to join data across tables and actions. Once you create relationships between types from
your database and types created from actions, you can then "join" them by running GraphQL queries.
-[Actions](/actions/index.mdx) are a way to extend Hasura’s schema with custom business logic using custom queries and
+[Actions](/actions/overview.mdx) are a way to extend Hasura’s schema with custom business logic using custom queries and
mutations. The resolvers for these custom fields are written in REST endpoints. They are especially useful for setting
up serverless functions as resolvers.
diff --git a/docs/docs/schema/postgres/remote-relationships/index.mdx b/docs/docs/schema/postgres/remote-relationships/index.mdx
index 9c53c56ce66..ace937a5354 100644
--- a/docs/docs/schema/postgres/remote-relationships/index.mdx
+++ b/docs/docs/schema/postgres/remote-relationships/index.mdx
@@ -15,9 +15,9 @@ keywords:
## Introduction
Remote relationships (aka "remote joins") allow you to join data across tables and remote data sources. The remote data
-source can either be a [Remote Schema](/remote-schemas/index.mdx), a table from a second database source, or the type
-returned from an [action](/actions/index.mdx). Once you create relationships between types from your database tables and
-types created from Remote Schemas or actions, you can then "join" them by running GraphQL queries.
+source can either be a [Remote Schema](/remote-schemas/overview.mdx), a table from a second database source, or the type
+returned from an [action](/actions/overview.mdx). Once you create relationships between types from your database tables
+and types created from Remote Schemas or actions, you can then "join" them by running GraphQL queries.
See the following guides on how to create different types of remote relationships related to Postgres:
diff --git a/docs/docs/schema/postgres/remote-relationships/remote-schema-relationships.mdx b/docs/docs/schema/postgres/remote-relationships/remote-schema-relationships.mdx
index 97fbe26e0d5..542ebdcec10 100644
--- a/docs/docs/schema/postgres/remote-relationships/remote-schema-relationships.mdx
+++ b/docs/docs/schema/postgres/remote-relationships/remote-schema-relationships.mdx
@@ -47,7 +47,7 @@ Remote Schema relationships from Postgres are supported from versions `v1.3.0` a
### Step 0: Add a Remote Schema and a database
Add a Remote Schema and a database as described [here](/remote-schemas/adding-schema.mdx) and
-[here](/databases/connect-db/index.mdx), if not already added.
+[here](/databases/quickstart.mdx), if not already added.
### Step 1: Define and create the relationship
diff --git a/docs/docs/schema/postgres/remote-relationships/remote-source-relationships.mdx b/docs/docs/schema/postgres/remote-relationships/remote-source-relationships.mdx
index 301871c8e30..31aecbab823 100644
--- a/docs/docs/schema/postgres/remote-relationships/remote-source-relationships.mdx
+++ b/docs/docs/schema/postgres/remote-relationships/remote-source-relationships.mdx
@@ -39,7 +39,7 @@ Remote database relationships for Postgres are supported from versions `v2.1.0`
### Step 0: Add two database sources
-Add a source database as described [here](/databases/connect-db/index.mdx) and track the required tables. Then, repeat
+Add a source database as described [here](/databases/overview.mdx) and track the required tables. Then, repeat
the process to add your target database.
### Step 1: Define and create the relationship
diff --git a/docs/docs/schema/quickstart.mdx b/docs/docs/schema/quickstart.mdx
new file mode 100644
index 00000000000..9945f08a0f6
--- /dev/null
+++ b/docs/docs/schema/quickstart.mdx
@@ -0,0 +1,80 @@
+---
+description: Quickstart Schema
+title: Quickstart Schema
+keywords:
+ - hasura
+ - docs
+ - schema
+ - quickstart
+ - guide
+ - tutorial
+sidebar_label: Quickstart
+sidebar_position: 2
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
+import SampleAppBlock from '@site/src/components/SampleAppBlock';
+import Timestamp from '@site/src/components/Timestamp';
+
+# Quickstart Schema
+
+This quickstart will help you work with the GraphQL Schema. We'll create a table called `coupons` and add some sample
+data to it. Then, we'll query for the data using the Hasura Console GUI and the API Explorer.
+
+
+
+## Step 1: Navigate to the Data tab
+
+Once here, click the `Create Table` button at the top of the page:
+
+
+
+## Step 2: Enter the details
+
+On this page, we'll begin by naming the table: in the `Table Name` field, enter `coupons`. From there, we'll add all the
+necessary columns:
+
+In the `Columns` section, we'll start with the `Column Name` field, enter `id`, with a data type of
+`integer (auto-increment)` and check the box for `unique`. Leave `nullable` unchecked as this is a required column and
+can't be `null`.
+
+Then, we'll repeat the steps for the following columns:
+
+- `amount` (data type: `integer`)
+- `code` (data type: `text`)
+- `description` (data type: `text`)
+- `start_date` (data type: `timestamp`), defaulting to `now()`
+- `end_date` (data type: `timestamp`)
+
+
+
+## Step 3: Add a primary key
+
+In the `Primary Key` section, open the dropdown and select `id` from the list of columns. Then click, `Add table`.
+
+## Step 4: Test it out
+
+We should have received confirmation that our table was created successfully. Now, let's test it out by adding a new
+coupon on the `Insert Row` tab:
+
+
+
+We can leave the `id` field blank, since it's auto-incrementing. Then, we'll add the following values:
+
+- `amount`: `50`
+- `code`: `HALFOFF`
+- `description`: `50% off your next purchase`
+- `start_date`: check the `Default` radio button
+- `end_date`:
+
+Upon clicking `Save`, we should receive confirmation of our new coupon. We can check its details by clicking the
+`Browse Rows` tab or by running a query in our API Explorer.
+
+## Recap
+
+What just happened? Well, you just modified your GraphQL API's schema! You can now query for coupons using the `coupons`
+table. You can also add new coupons using the `insert_coupons` mutation.
+
+You can continue to customize this table and create relationships between it and other tables, such as `products` or
+`orders` to create a coupon system for your e-commerce store.
diff --git a/docs/docs/security/_category_.json b/docs/docs/security/_category_.json
index cbdedbc1eb7..982e6d306b7 100644
--- a/docs/docs/security/_category_.json
+++ b/docs/docs/security/_category_.json
@@ -1,4 +1,4 @@
{
- "label": "Security",
+ "label": "Security Tools",
"position": 160
}
diff --git a/docs/docs/security/api-limits.mdx b/docs/docs/security/api-limits.mdx
index cffe82bca14..0f125dc4d22 100644
--- a/docs/docs/security/api-limits.mdx
+++ b/docs/docs/security/api-limits.mdx
@@ -8,7 +8,7 @@ keywords:
- security
- limits
sidebar_position: 2
-sidebar_label: API limits
+sidebar_label: API limits ☁️🏢
sidebar_class_name: cloud-and-enterprise-icon
title: 'Cloud & EE: API Limits'
---
diff --git a/docs/docs/security/container-images.mdx b/docs/docs/security/container-images.mdx
index 97bbac71f42..14cb3252ddc 100644
--- a/docs/docs/security/container-images.mdx
+++ b/docs/docs/security/container-images.mdx
@@ -9,7 +9,7 @@ keywords:
- images
- security
- cloud
-sidebar_label: Proactive vulnerability scanning
+sidebar_label: Proactive vulnerability scanning ☁️🏢
sidebar_class_name: cloud-and-enterprise-icon
---
diff --git a/docs/docs/security/disable-graphql-introspection.mdx b/docs/docs/security/disable-graphql-introspection.mdx
index a80cff6b7b3..a742efbb260 100644
--- a/docs/docs/security/disable-graphql-introspection.mdx
+++ b/docs/docs/security/disable-graphql-introspection.mdx
@@ -11,7 +11,7 @@ keywords:
- disable
- GraphQL
sidebar_position: 3
-sidebar_label: Disable GraphQL introspection
+sidebar_label: Disable GraphQL introspection ☁️🏢
sidebar_class_name: cloud-and-enterprise-icon
---
diff --git a/docs/docs/security/index.mdx b/docs/docs/security/index.mdx
deleted file mode 100644
index 7855bb9c4a0..00000000000
--- a/docs/docs/security/index.mdx
+++ /dev/null
@@ -1,45 +0,0 @@
----
-description: Hasura Cloud Standard and Hasura Enterprise API Security
-title: 'Cloud & EE: API Security'
-keywords:
- - hasura
- - docs
- - cloud
- - enterprise
- - security
- - API security
- - secure
-slug: index
-sidebar_label: API security
----
-
-import Thumbnail from '@site/src/components/Thumbnail';
-import HeadingIcon from '@site/src/components/HeadingIcon';
-import Security from '@site/static/icons/features/security.svg';
-
-# API Security
-
-
- Available on: Cloud Free, Cloud Standard, Cloud Professional, Cloud Enterprise, Self-hosted Enterprise
-
-
-## Introduction
-
-All API security-related features can be found under the `Security` tab in the API Explorer page of Hasura Console.
-
-:::info Note
-
-You can find information regarding securing the GraphQL endpoint in the Deployment section
-[here](/deployment/securing-graphql-endpoint.mdx).
-
-:::
-
-
-
-## Features
-
-- [Allow List](/security/allow-list.mdx)
-- [API Limits](/security/api-limits.mdx)
-- [Disable GraphQL Introspection](/security/disable-graphql-introspection.mdx)
-- [Multiple Admin Secrets](/security/multiple-admin-secrets.mdx)
-- [Multiple JWT Secrets](/security/multiple-jwt-secrets.mdx)
diff --git a/docs/docs/security/multiple-admin-secrets.mdx b/docs/docs/security/multiple-admin-secrets.mdx
index ffa97869148..0ee359c796f 100644
--- a/docs/docs/security/multiple-admin-secrets.mdx
+++ b/docs/docs/security/multiple-admin-secrets.mdx
@@ -13,7 +13,7 @@ keywords:
- admin
- secrets
sidebar_position: 4
-sidebar_label: Multiple Admin Secrets
+sidebar_label: Multiple Admin Secrets ☁️🏢
sidebar_class_name: cloud-and-enterprise-icon
---
diff --git a/docs/docs/security/multiple-jwt-secrets.mdx b/docs/docs/security/multiple-jwt-secrets.mdx
index ef00826a4b7..3f41f6428e0 100644
--- a/docs/docs/security/multiple-jwt-secrets.mdx
+++ b/docs/docs/security/multiple-jwt-secrets.mdx
@@ -12,7 +12,7 @@ keywords:
- JWT
- secrets
sidebar_position: 5
-sidebar_label: Multiple JWT Secrets
+sidebar_label: Multiple JWT Secrets ☁️🏢
sidebar_class_name: cloud-and-enterprise-icon
---
diff --git a/docs/docs/security/overview.mdx b/docs/docs/security/overview.mdx
new file mode 100644
index 00000000000..84dbf3f79a6
--- /dev/null
+++ b/docs/docs/security/overview.mdx
@@ -0,0 +1,67 @@
+---
+description: Hasura Cloud Standard and Hasura Enterprise API Security
+title: 'Cloud & EE: API Security'
+keywords:
+ - hasura
+ - docs
+ - cloud
+ - enterprise
+ - security
+ - API security
+ - secure
+hide_table_of_contents: true
+sidebar_position: 1
+sidebar_label: Overview
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Security from '@site/static/icons/features/security.svg';
+
+# Security Tools
+
+
+
+
+ Hasura offers a comprehensive set of tools to secure your APIs beyond authentication and authorization. These
+ tools include an Allow List, Multiple JWT Secrets, API Limits, and more.
+
+
Quick Links
+
+
+
+ Get started with Security best practices.
+
+
+
+
+
+
+
+## Using Security Tools
+
+
+
+
+
Allow Lists
+
Use the Allow List of operations to restrict the operations that can be performed by a role.
+
+
+
+
+
Multiple JWT Secrets
+
Use multiple JWT secrets to support multiple JWT issuers.
+
+
+
+
+
API Limits
+
Use API limits to restrict the number of requests that can be made to a particular GraphQL type by a role.
+
+
+
diff --git a/docs/docs/subscriptions/index.mdx b/docs/docs/subscriptions/index.mdx
deleted file mode 100644
index 96e2b803e31..00000000000
--- a/docs/docs/subscriptions/index.mdx
+++ /dev/null
@@ -1,44 +0,0 @@
----
-description: Manage subscriptions on your database with Hasura
-title: Subscriptions
-keywords:
- - hasura
- - docs
- - subscription
-slug: index
----
-
-import Subscriptions from '@site/static/icons/features/subscriptions.svg';
-
-# Subscriptions
-
-## Introduction
-
-A GraphQL subscription is essentially a query where the client receives an update whenever the value of any field
-changes upstream.
-
-Subscriptions are supported for all kinds of queries. All the concepts of [queries](/queries/index.mdx) hold true for
-subscriptions as well.
-
-:::info One root field in a subscription
-
-Hasura follows the [GraphQL spec](https://graphql.github.io/graphql-spec/June2018/#sec-Single-root-field) which allows
-for only one root field in a subscription.
-
-:::
-
-Subscriptions are not currently supported for [remote schemas](/remote-schemas/index.mdx).
-
-
-## Explore subscriptions
-
-- [Explore subscriptions with Postgres / Citus / Hyperscale](/subscriptions/postgres/index.mdx)
-- [Explore subscriptions with MS SQL Server](/subscriptions/ms-sql-server/index.mdx)
-
-:::info Additional Resources
-
-- Learn how to use subscriptions with front-end applications -
- [Learn Tutorials](https://hasura.io/learn/#front-end-tutorials)
-- Build a full-stack application with Next.js - [Learn Tutorials](https://hasura.io/learn/#front-end-tutorials)
-
-:::
diff --git a/docs/docs/subscriptions/ms-sql-server/_category_.json b/docs/docs/subscriptions/ms-sql-server/_category_.json
index 078d4af2cad..eecdf9c6941 100644
--- a/docs/docs/subscriptions/ms-sql-server/_category_.json
+++ b/docs/docs/subscriptions/ms-sql-server/_category_.json
@@ -1,4 +1,4 @@
{
"label": "MS SQL Server",
- "position": 2
+ "position": 4
}
diff --git a/docs/docs/subscriptions/overview.mdx b/docs/docs/subscriptions/overview.mdx
new file mode 100644
index 00000000000..4864b0d513c
--- /dev/null
+++ b/docs/docs/subscriptions/overview.mdx
@@ -0,0 +1,66 @@
+---
+description: Manage subscriptions on your database with Hasura
+title: Overview
+keywords:
+ - hasura
+ - docs
+ - subscription
+hide_table_of_contents: true
+sidebar_position: 1
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import VersionedLink from '@site/src/components/VersionedLink';
+import Subscriptions from '@site/static/icons/features/subscriptions.svg';
+
+# Subscriptions
+
+
+
+
+ Subscriptions enable you to push data from your database to your clients in real-time, making them a powerful tool
+ for building reactive applications without the need for continuous server polling.
+
+
+ Just like queries and mutations, you have subscriptions on your data out of the box with the Hasura GraphQL Engine.
+
+
Quick Links
+
+
+ Write your first subscription in 30 seconds.
+
+
+
+
+
+
+## Using Subscriptions
+
+
+
+
+
Streaming subscriptions with Postgres
+
See only the newest data in realtime as it is inserted into your Postgres database.
+
+
+
+
+
Live queries with Postgres
+
+ Hasura live queries allow you to receive real-time updates as soon as data changes, enabling you to build
+ responsive and dynamic applications that can react instantly to user interactions.
+
+
+
+
+
+
Integrations with GraphQL clients
+
Learn how to integrate Hasura subscriptions with your favorite GraphQL client.
+
+
+
diff --git a/docs/docs/subscriptions/postgres/_category_.json b/docs/docs/subscriptions/postgres/_category_.json
index cc7b39d0a33..c60ceebadb1 100644
--- a/docs/docs/subscriptions/postgres/_category_.json
+++ b/docs/docs/subscriptions/postgres/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Postgres",
- "position": 1
+ "position": 3
}
diff --git a/docs/docs/subscriptions/quickstart.mdx b/docs/docs/subscriptions/quickstart.mdx
new file mode 100644
index 00000000000..0e0bad8f0a6
--- /dev/null
+++ b/docs/docs/subscriptions/quickstart.mdx
@@ -0,0 +1,84 @@
+---
+description: Quickstart Subscriptions
+title: Quickstart Subscriptions
+keywords:
+ - hasura
+ - docs
+ - subscriptions
+ - quickstart
+ - guide
+ - tutorial
+sidebar_label: Quickstart
+sidebar_position: 2
+---
+
+import Thumbnail from '@site/src/components/Thumbnail';
+import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
+import SampleAppBlock from '@site/src/components/SampleAppBlock';
+
+# Quickstart Subscriptions
+
+This quickstart will help you create your first subscription. We're going to subscribe to live updates for a message
+thread.
+
+
+
+## Step 1: Create a Subscription
+
+Head to the `API` tab of the Hasura Console and paste in this value:
+
+```graphql
+subscription MessageThreadSubscription($thread_id: uuid = "75e0f7b0-b5fc-11ed-ad85-1a122c2a1c44") {
+ messages(where: { thread_id: { _eq: $thread_id } }) {
+ created_at
+ id
+ body
+ is_read
+ }
+}
+```
+
+Once hitting run, you should see the following output:
+
+
+
+:::tip That's it?
+
+Yep! Remember, you get subscriptions out of the box with Hasura 🔥 You won't see any messages in your results yet
+because there aren't any in the database, but the subscription is live and running. To test it, and mimic a client
+application, let's ping the server with curl in the next step.
+
+:::
+
+## Step 2: Insert a message
+
+To avoid the need for a client application, we'll use curl to insert a message into the database. You can enter the curl
+command below into a terminal window, and replace the `` and `` values
+with your own:
+
+```shell
+curl -X POST -H "Content-Type: application/json" -H "X-Hasura-Admin-Secret: " -d '{"query": "mutation { insert_messages(objects: {body: \"This is a live-updating subscription\", user_id: \"82001336-65b7-11ed-b905-7fa26a16d198\", thread_id: \"75e0f7b0-b5fc-11ed-ad85-1a122c2a1c44\" }) { affected_rows } } "}'
+```
+
+After entering the above command hitting `enter`, you should see the following output on your Console's API tab:
+
+
+
+## Recap
+
+What just happened? Well, you just wrote your first subscription! You can now subscribe to live updates for a message
+thread. Think of the possibilities in a real-world application: you can subscribe to live updates for a chat thread, a
+shopping cart, or a live leaderboard.
+
+At the start, you created a subscription using the Hasura Console's API tab. This subscription returns the `created_at`,
+`id`, `body`, and `is_read` fields for all messages with a `thread_id` equal to the provided value. This allows us to
+receive new data, live from the server, rather than just a single response. So, as new messages are inserted into the
+database - like we did with the curl command - the subscription will return them.
diff --git a/docs/docs/troubleshooting.mdx b/docs/docs/troubleshooting.mdx
index 17d6ce45a50..475758c3a67 100644
--- a/docs/docs/troubleshooting.mdx
+++ b/docs/docs/troubleshooting.mdx
@@ -18,58 +18,49 @@ import Troubleshooting from '@site/static/icons/features/troubleshooting.svg';
## Introduction
-This section provides references that can help in troubleshooting errors
-when developing with Hasura.
+This section provides references that can help in troubleshooting errors when developing with Hasura.
## Logs
-In order to find out about the origins of an error, it can be helpful to
-check the logs.
+In order to find out about the origins of an error, it can be helpful to check the logs.
:::info Metrics and distributed tracing in Hasura Cloud
-Hasura Cloud includes metrics and distributed tracing which makes
-troubleshooting faster. For more information, see [Metrics](/observability/index.mdx)
-and [Tracing](/observability/tracing.mdx) in Hasura Cloud.
+Hasura Cloud includes metrics and distributed tracing which makes troubleshooting faster. For more information, see
+[Metrics](/observability/overview.mdx) and [Tracing](/observability/tracing.mdx) in Hasura Cloud.
:::
### Server logs
-For errors that come from the Hasura server, server logs will give you
-more insights. For details on how you can access these logs, as well as
-different log types, visit [this page](/deployment/logging.mdx).
+For errors that come from the Hasura server, server logs will give you more insights. For details on how you can access
+these logs, as well as different log types, visit [this page](/deployment/logging.mdx).
### Console logs
-Should there be any error coming from the Hasura Console UI, they will
-show up in the Browser dev tools.
+Should there be any error coming from the Hasura Console UI, they will show up in the Browser dev tools.
### Remote service logs
-Errors can come from a remote service, such as
-[Remote Schemas](/remote-schemas/index.mdx), [Events](/event-triggers/index.mdx) or
-[Actions](/actions/index.mdx). In this case, check the errors of the respective
-remote service. For Actions, check out this [debugging page](/actions/debugging.mdx).
+Errors can come from a remote service, such as [Remote Schemas](/remote-schemas/overview.mdx),
+[Events](/event-triggers/overview.mdx) or [Actions](/actions/overview.mdx). In this case, check the errors of the
+respective remote service. For Actions, check out this [debugging page](/actions/debugging.mdx).
## GitHub issues
-It's possible that someone with the same problem has created a GitHub
-issue on the [Hasura repo](https://github.com/hasura/graphql-engine/issues). If you don't
-come across an issue with solution in your search, feel free to create a
-[new issue](https://github.com/hasura/graphql-engine/issues/new).
+It's possible that someone with the same problem has created a GitHub issue on the
+[Hasura repo](https://github.com/hasura/graphql-engine/issues). If you don't come across an issue with solution in your
+search, feel free to create a [new issue](https://github.com/hasura/graphql-engine/issues/new).
## Hasura blog
-The [Hasura blog](https://hasura.io/blog/) contains a lot of useful
-resources including tutorials. You can use the search functionality to
-find what you're looking for.
+The [Hasura blog](https://hasura.io/blog/) contains a lot of useful resources including tutorials. You can use the
+search functionality to find what you're looking for.
:::info YouTube
If you prefer to watch tutorials in the form of videos, check out the
-[Hasura Youtube
-channel](https://www.youtube.com/channel/UCZo1ciR8pZvdD3Wxp9aSNhQ).
+[Hasura Youtube channel](https://www.youtube.com/channel/UCZo1ciR8pZvdD3Wxp9aSNhQ).
:::
@@ -83,7 +74,8 @@ If you come across a database error, it will be helpful to check their logs:
### SSL certificate errors
-SSL certificate errors occur when a web browser can't verify the SSL certificate installed on a site. For SSL errors such as:
+SSL certificate errors occur when a web browser can't verify the SSL certificate installed on a site. For SSL errors
+such as:
```
ERROR:
@@ -103,8 +95,6 @@ Follow the steps below to try and resolve the issue:
## Discord
-If you didn't find a solution in any of the above mentioned sections or
-if you prefer to troubleshoot with the community, feel free to join our
-[Discord server](https://hasura.io/discord). Other users might have come
-across the same issues, and the Hasura community on Discord is very
-active and helpful.
+If you didn't find a solution in any of the above mentioned sections or if you prefer to troubleshoot with the
+community, feel free to join our [Discord server](https://hasura.io/discord). Other users might have come across the
+same issues, and the Hasura community on Discord is very active and helpful.
diff --git a/docs/src/components/CustomDocItem/index.tsx b/docs/src/components/CustomDocItem/index.tsx
index f8e7bcc1d46..4ba9267c8c1 100644
--- a/docs/src/components/CustomDocItem/index.tsx
+++ b/docs/src/components/CustomDocItem/index.tsx
@@ -43,7 +43,7 @@ const CustomDocItem = props => {
}
>
{/**/}
-
+ {props.location.pathname === `/docs/latest/index/` ? null : }
diff --git a/docs/src/components/SampleAppBlock/index.jsx b/docs/src/components/SampleAppBlock/index.jsx
new file mode 100644
index 00000000000..31ffc87440a
--- /dev/null
+++ b/docs/src/components/SampleAppBlock/index.jsx
@@ -0,0 +1,27 @@
+import React from 'react';
+import styles from './styles.module.scss';
+import Beaker from '@site/static/icons/beaker.svg';
+
+const isDependent = `This quickstart is dependent upon the docs e-commerce sample app. If you haven't already deployed the sample app, you can do so with one click below. If you've already deployed the sample app, simply use your existing project.`;
+const isStandalone = `You can use this quickstart with any project, but it pairs well with our docs e-commerce sample app, which you can deploy to Hasura Cloud with one click below. If you've already deployed the sample app, access your existing project.`;
+
+function createMarkup(dependent) {
+ return { __html: dependent ? isDependent : isStandalone };
+}
+
+const SampleAppBlock = ({ dependent }) => (
+
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
+ 
+