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

docs: add rules for tabs and include groupId prop

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7183
Co-authored-by: Sean Park-Ross <94021366+seanparkross@users.noreply.github.com>
GitOrigin-RevId: 8647d3fcfd57c3419ef2be7864172d63861779c1
This commit is contained in:
Rob Dominguez 2022-12-15 10:08:33 -06:00 committed by hasura-bot
parent ae33e34e2d
commit 4d64644ae1
73 changed files with 468 additions and 467 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/actions/action-handlers.mdx
View File

@ -177,7 +177,7 @@ In your Hasura server, add the action secret as an environment variable, say `AC
For your action, add a header that will act as an action secret.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Actions -> [action-name]` tab in the console and scroll down to `Headers`. You can now configure an action

2
docs/docs/actions/action-permissions.mdx
View File

@ -21,7 +21,7 @@ As with the other fields in the GraphQL schema, users need to be given access to
## Set action permissions
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Actions -> [action-name] -> Permissions` tab in the console.

2
docs/docs/actions/action-relationships.mdx
View File

@ -79,7 +79,7 @@ See more details at [custom object type relationships](/actions/types.mdx)
You can create relationships for custom output types by:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Actions -> [action-name] -> Relationships` tab in the console for the action returning the output type.

2
docs/docs/actions/codegen/index.mdx
View File

@ -28,7 +28,7 @@ contributions from the community.
## Generating handler code for your action {#actions-codegen-execute}
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Actions -> [action-name] -> Codegen` tab in the console

25
docs/docs/actions/create.mdx
View File

@ -32,8 +32,8 @@ Let's look at **examples** for mutation and query type actions.
## Setup
<Tabs className="api-tabs">
<TabItem value="console" label="Console">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console" className='empty-tab'>
There is no setup required for defining actions via the console.
@ -88,7 +88,7 @@ Let's start with a mutation that accepts a username and password, and returns an
Start with defining the mutation and the required types. These types will reflect in the GraphQL schema.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Go to the `Actions` tab on the console and click on `Create`. This will take you to a page like this:
@ -237,7 +237,7 @@ You can deploy this code somewhere and get the URI. For getting started quickly,
Now, set the handler for the action:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Set the value of the `handler` field to the above endpoint.
@ -283,7 +283,7 @@ If you are running Hasura using Docker, ensure that the Hasura Docker container
Finally, to save the action:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Hit `Create`.
@ -333,7 +333,7 @@ Let's start with a basic query that accepts a list of numbers and returns their
Start with defining the query and the required types. These types will reflect in the GraphQL schema.
<Tabs className="api_tabs">
<Tabs groupId="user-preference" className="api_tabs">
<TabItem value="console" label="Console">
Go to the `Actions` tab on the console and click on `Create`. This will take you to a page like this:
@ -450,13 +450,10 @@ The above definition means:
You can also use Type Generator feature to generate the types for your action:
<Thumbnail
src="/img/actions/type-generator.png"
alt="Console action create"
width="800px"
/>
<Thumbnail src='/img/actions/type-generator.png' alt='Console action create' width='800px' />
Insert JSON samples for the request and the response, click "Insert Types" and Hasura generates the GraphQL types for you.
Insert JSON samples for the request and the response, click "Insert Types" and Hasura generates the GraphQL types for
you.
### Step 2: Create the action handler
@ -491,7 +488,7 @@ You can deploy this code somewhere and get the URI. For getting started quickly,
Now, set the handler for the action:
<Tabs className="api_tabs">
<Tabs groupId="user-preference" className="api_tabs">
<TabItem value="console" label="Console">
Set the value of the `handler` field to the above endpoint.
@ -529,7 +526,7 @@ e.g. `https://my-handler-endpoint/addNumbers` can be templated to `{{ACTION_BASE
Finally, to save the action:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Hit `Create`.

4
docs/docs/actions/derive.mdx
View File

@ -54,7 +54,7 @@ mutation insertAuthor($name: String) {
Now that we have a mutation with arguments being accepted as variables, we can derive our action:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `API` tab of the console and paste / generate your query in the GraphiQL window.
@ -121,7 +121,7 @@ The action name will be picked up from the argument of the command and not the m
For a derived action, Hasura can generate the relevant handler code to delegate the action back to the original
operation.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Actions -> [action-name] -> Codegen` tab in the console

27
docs/docs/actions/rest-connectors.mdx
View File

@ -43,7 +43,7 @@ REST Connectors are supported in Hasura GraphQL Engine versions `v2.1.0` and abo
REST Connectors can be configured either when creating a new action or editing an existing one. See the transform
options [here](#action-transform-types):
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Go to the `Actions` tab on the console and create or modify an action. Scroll down to `Configure REST Connectors`
@ -188,7 +188,7 @@ You can transform your:
You can change the request method to adapt to your API's expected format.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the `Configure REST Connectors` section, click on `Add Request Options Transform`:
@ -287,7 +287,7 @@ You can also provide query params to add to the URL.
You can use the [Kriti templating language](/api-reference/kriti-templating.mdx) to construct any string values here.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the `Configure REST Connectors` section, click on `Add Request Options Transform`:
@ -412,7 +412,7 @@ request body to `x_www_form_urlencoded` formats.
If you are using a `GET` request, you might want to not send any request body, and additionally not send a
`content-type` header to the webhook. You can do that using the disable body feature.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the `Configure REST Connectors` section, click on `Add Request Options Transform`, and convert the `Request Method`
@ -515,7 +515,7 @@ X-Hasura-Role: admin
You can transform Request Body to `application/json` format using the following steps:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the `Configure REST Connectors` section, click on `Add Payload Transform`. By default console sends the body as
@ -615,7 +615,7 @@ While doing `x_www_form_urlencoded` transformation, please note that as all chan
when calling the API, so you will need to remove the default `application/json` header and add a
`application/x-www-form-urlencoded` header.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the `Configure REST Connectors` section, click on `Add Payload Transform`. Change the dropdown next to
@ -730,8 +730,8 @@ X-Hasura-Role: admin
### Response Body
You can transform the default body of your HTTP API response by configuring a response transform template. This can
be used to match the output types defined in your Action with your HTTP API.
You can transform the default body of your HTTP API response by configuring a response transform template. This can be
used to match the output types defined in your Action with your HTTP API.
:::info Note
@ -739,16 +739,12 @@ Response transforms are applicable only for JSON responses.
:::
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the `Configure REST Connectors` section, click on `Add Response Transform`:
<Thumbnail
src="/img/actions/transform-response_actions_2.13.png"
alt="response transform method"
width="800px"
/>
<Thumbnail src='/img/actions/transform-response_actions_2.13.png' alt='response transform method' width='800px' />
Hit `Create Action` to apply your changes.
@ -817,6 +813,7 @@ X-Hasura-Role: admin
}
}
```
</TabItem>
</Tabs>
@ -824,7 +821,7 @@ X-Hasura-Role: admin
Let's integrate Auth0's management API to update the profile of a user:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Go to the `Actions` tab on the console and create or modify an action. Scroll down to `Configure REST Connectors`

114
docs/docs/api-reference/kriti-templating.mdx
View File

@ -9,9 +9,9 @@ sidebar_label: Kriti Templating
sidebar_position: 13
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Thumbnail from "@site/src/components/Thumbnail";
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
# Kriti Templating in Hasura
@ -19,14 +19,17 @@ import Thumbnail from "@site/src/components/Thumbnail";
Kriti allows transformation of JSON via templating during the Hasura GraphQL Engine lifecycle.
Kriti has a JSON-like syntax that allows for the creation of JSON values via direct-construction, reference and branching structures.
Kriti has a JSON-like syntax that allows for the creation of JSON values via direct-construction, reference and
branching structures.
There are two main ways that Kriti templates are used:
* String interpolation for fields
* Payload transformation
- String interpolation for fields
- Payload transformation
String interpolation can also be used inside Kriti payload transformations, so only payload examples will be used here. But note that when a field provides Kriti interpolation capabilities you can't use the full capabilities of Kriti templates, just the interpolation capabilities.
String interpolation can also be used inside Kriti payload transformations, so only payload examples will be used here.
But note that when a field provides Kriti interpolation capabilities you can't use the full capabilities of Kriti
templates, just the interpolation capabilities.
:::info Note
@ -38,15 +41,15 @@ See [Kriti's README.md on GitHub](https://github.com/hasura/kriti-lang#kriti-lan
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)
- [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)
### Example
The following is an example of using Kriti templates for an Action REST Connector:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Open the Hasura Console, head to the `Actions` tab, and click the `Create` button to open the page.
@ -54,8 +57,8 @@ Open the Hasura Console, head to the `Actions` tab, and click the `Create` butto
Add a REST connector payload and configure and test the associated template.
<Thumbnail
src="/img/graphql/core/templates/create-action-configure-rest-connectors.png"
alt="Create an event trigger"
src='/img/graphql/core/templates/create-action-configure-rest-connectors.png'
alt='Create an event trigger'
/>
</TabItem>
@ -102,8 +105,8 @@ X-Hasura-Role: admin
}
```
The template field is a string that represents a template in the language reflected in the template_engine field.
In this case:
The template field is a string that represents a template in the language reflected in the template_engine field. In
this case:
```json
{
@ -113,21 +116,21 @@ In this case:
}
}
```
</TabItem>
</Tabs>
## Capabilities and behavior
The functionality of Kriti templates can be broken down into the following categories:
* JSON Value Construction
* Control Flow
* Value Interpolation
* String Interpolation
* Path Accessors
* Optional Chaining
* Functions
- JSON Value Construction
- Control Flow
- Value Interpolation
- String Interpolation
- Path Accessors
- Optional Chaining
- Functions
Most Kriti-specific functionality is introduced through the use of a `{{ ... }}` syntax.
@ -139,13 +142,15 @@ For example, the following is a valid Kriti template and JSON document:
```json
{
"a": [1,2,3],
"a": [1, 2, 3],
"b": "hello world"
}
```
### Value interpolation
Values can be interpolated in place of a normal JSON value. For example, the "b" field uses interpolation rather than a literal value here:
Values can be interpolated in place of a normal JSON value. For example, the "b" field uses interpolation rather than a
literal value here:
```json
{
@ -175,7 +180,8 @@ Conditional logic and loops are supported:
### Path references
As part of interpolation and control-flow you may reference data via paths, of which a variable is a special case. The scope from which a path is looked up is either top-level, or expanded via control flow.
As part of interpolation and control-flow you may reference data via paths, of which a variable is a special case. The
scope from which a path is looked up is either top-level, or expanded via control flow.
For example, if the variable `foo` contained the value `1`, you could reference it like so:
@ -197,7 +203,8 @@ or:
### Optional chaining
You may also use optional chaining to traverse into fields that may not be present. The value is `Null` if the field is not present:
You may also use optional chaining to traverse into fields that may not be present. The value is `Null` if the field is
not present:
```json
{ "a": {{ bar?.x }} }
@ -227,8 +234,9 @@ These use the `foo(...)` syntax:
}
```
The [Function Reference](#kriti-function-reference) section details the functions available by default. Note that there can be additional functions and values in the scope depending on the template context. These will be documented in the relevant documentation section.
The [Function Reference](#kriti-function-reference) section details the functions available by default. Note that there
can be additional functions and values in the scope depending on the template context. These will be documented in the
relevant documentation section.
## Function reference {#kriti-function-reference}
@ -263,9 +271,10 @@ Output:
### size
Returns:
- the length of an array or string
- the number of keys of an object
- the value of a number
- the value of a number
- `1` for `true` and `0` for `false`
- `0` for `null`
@ -279,8 +288,8 @@ Input:
}
```
Output:
Output:
```json
{
"array": 1,
@ -310,11 +319,7 @@ Output:
```json
{
"array": [
3,
2,
1
],
"array": [3, 2, 1],
"number": 0.25,
"string": "fdsa"
}
@ -363,13 +368,9 @@ Output:
```json
{
"array": [
2,
3
],
"array": [2, 3],
"string": "sdf"
}
```
### toCaseFold
@ -414,7 +415,6 @@ Output:
{
"string": "abcd"
}
```
### toUpper
@ -437,7 +437,6 @@ Output:
{
"string": "ABCD"
}
```
### toTitle
@ -502,14 +501,8 @@ Output:
```json
{
"object": [
[
"a",
1
],
[
"b",
2
]
["a", 1],
["b", 2]
]
}
```
@ -530,11 +523,7 @@ Output:
```json
{
"array": [
1,
3,
5
]
"array": [1, 3, 5]
}
```
@ -558,12 +547,7 @@ Output:
```json
{
"arrays": [
1,
2,
3,
4
],
"arrays": [1, 2, 3, 4],
"objects": {
"a": 1,
"b": 3,
@ -575,7 +559,7 @@ Output:
:::info Note
All of the above functions are also listed on the [Kriti GitHub README.md](https://github.com/hasura/kriti-lang/blob/main/README.md#basic-functions-collection).
All of the above functions are also listed on the
[Kriti GitHub README.md](https://github.com/hasura/kriti-lang/blob/main/README.md#basic-functions-collection).
:::

2
docs/docs/auth/authorization/basics.mdx
View File

@ -83,7 +83,7 @@ permissions.
Now let's define an access control rule for the `authors` table for a role `user`.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the **Permissions** section of the table (`Data -> [table] -> Permissions` tab) and define permissions as shown

2
docs/docs/auth/authorization/inherited-roles.mdx
View File

@ -44,7 +44,7 @@ For versions `v2.1.0-beta.1` and above, inherited roles are enabled by default.
## Creating inherited roles
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Go to the `Settings` tab (⚙) on the console and click on `Inherited Roles`.

139
docs/docs/auth/authorization/permission-rules.mdx
View File

@ -84,11 +84,7 @@ be read. In the case of `insert`, the boolean expression determines whether or n
Row-level permissions are defined using operators, static values, values in columns (_including those in related tables
or nested objects_) and session variables.
<TOCInline
toc={toc}
maxHeadingLevel={4}
filterTOC={'row-level-permissions'}
/>
<TOCInline toc={toc} maxHeadingLevel={4} filterTOC={'row-level-permissions'} />
#### Using column operators to build rules
@ -109,7 +105,7 @@ See the [API reference](/api-reference/syntax-defs.mdx#metadataoperator) for a l
The following is an example of a simple boolean expression to restrict access for `select` to rows where the value in
the `id` column is greater than 10:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can define permissions using boolean expressions on the Hasura Console as follows:
@ -119,9 +115,8 @@ You can define permissions using boolean expressions on the Hasura Console as fo
</TabItem>
<TabItem value="cli" label="CLI">
You can define permissions using boolean expressions in the `metadata > databases > [database-name] > tables >
[table-name].yaml` file, eg:
You can define permissions using boolean expressions in the
`metadata > databases > [database-name] > tables > [table-name].yaml` file, eg:
```yaml {8-10}
- table:
@ -183,7 +178,7 @@ You can construct more complex boolean expressions using the `_and`, `_or` and `
**For example**, using the `_and` operator, you can construct a rule to restrict access for `select` to rows where the
value in the `id` column is greater than 10 **and** the value in the `name` column starts with "a" or "A":
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can define permissions using the `_and` operator on the Hasura Console as follows:
@ -197,8 +192,8 @@ You can define permissions using the `_and` operator on the Hasura Console as fo
</TabItem>
<TabItem value="cli" label="CLI">
You can define permissions using the `_and` operator in the `metadata > databases > [database-name] > tables >
[table-name].yaml` file eg:
You can define permissions using the `_and` operator in the
`metadata > databases > [database-name] > tables > [table-name].yaml` file eg:
```yaml {8-11}
- table:
@ -270,7 +265,7 @@ using the JWT configuration are available for constructing row-level permissions
to construct a rule to restrict access for `select` to rows in the `articles` table where the value in the `id` column
is equal to the value in the session variable (_assuming this variable is being used to indicate the author's ID_):
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can define session variables in permissions on the Hasura Console:
@ -284,8 +279,8 @@ You can define session variables in permissions on the Hasura Console:
</TabItem>
<TabItem value="cli" label="CLI">
You can define session variables in permissions in the `metadata > databases > [database-name] > tables >
[table-name].yaml` file, eg:
You can define session variables in permissions in the
`metadata > databases > [database-name] > tables > [table-name].yaml` file, eg:
```yaml {10-12}
- table:
@ -359,7 +354,7 @@ called `agent` (_an author can have an agent_) and we want to allow users with t
the authors who they manage in `authors` table. We can define the following permission rule that uses the aforementioned
object relationship:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can use a nested object to build rules on the Hasura Console:
@ -373,8 +368,8 @@ You can use a nested object to build rules on the Hasura Console:
</TabItem>
<TabItem value="cli" label="CLI">
You add permissions using relationships or nested objects in the `metadata > databases > [database-name] > tables >
[table-name].yaml` eg:
You add permissions using relationships or nested objects in the
`metadata > databases > [database-name] > tables > [table-name].yaml` eg:
```yaml {8-11}
- table:
@ -451,7 +446,7 @@ You can use the `_exists` operator to set a permission rule based on tables/view
column in the `users` table is set to `true`. Let's assume the user's id is passed in the `X-Hasura-User-ID` session
variable.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can set permissions using unrelated tables on the Hasura Console as follows:
@ -461,8 +456,8 @@ You can set permissions using unrelated tables on the Hasura Console as follows:
</TabItem>
<TabItem value="cli" label="CLI">
You can set permissions using unrelated tables in the `metadata > databases > [database-name] > tables >
[table-name].yaml`, eg:
You can set permissions using unrelated tables in the
`metadata > databases > [database-name] > tables > [table-name].yaml`, eg:
```yaml {7-15}
- table:
@ -541,7 +536,7 @@ user's_ `id` _and has the_ `allow_article_create` _column set to true, allow acc
Column-level permissions determine access to columns in the rows that are accessible based on row-level permissions.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Column-level permissions are simple selections on the Hasura Console:
@ -551,8 +546,8 @@ Column-level permissions are simple selections on the Hasura Console:
</TabItem>
<TabItem value="cli" label="CLI">
You can set column-level permissions in the `metadata > databases > [database-name] > tables >
[table-name].yaml` file, eg:
You can set column-level permissions in the `metadata > databases > [database-name] > tables > [table-name].yaml` file,
eg:
```yaml {7-11}
- table:
@ -619,7 +614,7 @@ In this example, the role `author` has only partial access to columns of the acc
In the case of `select` operations, the number of rows to be returned in the response can be limited using this
configuration:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can set a row fetch limit on the Hasura Console as follows:
@ -629,8 +624,8 @@ You can set a row fetch limit on the Hasura Console as follows:
</TabItem>
<TabItem value="cli" label="CLI">
You can set a row fetch limit for a table in the `metadata > databases > [database-name] > tables >
[table-name].yaml` file, eg:
You can set a row fetch limit for a table in the `metadata > databases > [database-name] > tables > [table-name].yaml`
file, eg:
```yaml {13}
- table:
@ -695,7 +690,7 @@ In the above example, this configuration restricts the number of accessible rows
In the case of `select` operations, access to [aggregation queries](/queries/postgres/aggregation-queries.mdx) can be
enabled for a given role using this configuration.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can enable aggregation queries permissions on the Hasura Console as follows:
@ -705,8 +700,8 @@ You can enable aggregation queries permissions on the Hasura Console as follows:
</TabItem>
<TabItem value="cli" label="CLI">
You can allow aggregation query permissions in the `metadata > databases > [database-name] > tables >
[table-name].yaml` file, eg:
You can allow aggregation query permissions in the `metadata > databases > [database-name] > tables > [table-name].yaml`
file, eg:
```yaml {13}
- table:
@ -773,7 +768,7 @@ While this is strictly not a permission configuration, defining
access to it. This preset can be defined for `insert` and `update` operations. This configuration is also very useful to
avoid sending sensitive user-information in the request and leverage session variables or static data instead.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can define column presets for either `insert` or `update` operations in the Hasura Console as follows:
@ -783,8 +778,8 @@ You can define column presets for either `insert` or `update` operations in the
</TabItem>
<TabItem value="cli" label="CLI">
You can define column presets for table columns in the `metadata > databases > [database-name] >
tables > [table-name].yaml`, eg: `public_users.yaml`:
You can define column presets for table columns in the
`metadata > databases > [database-name] > tables > [table-name].yaml`, eg: `public_users.yaml`:
```yaml {8-9}
table:
@ -798,7 +793,6 @@ insert_permissions:
id: x-hasura-User-Id
columns:
- id
```
Apply the metadata by running:
@ -811,8 +805,8 @@ hasura metadata apply
<TabItem value="api" label="API">
You can define column presets with either the [insert](/api-reference/syntax-defs.mdx#insertpermission) or
[update](/api-reference/syntax-defs.mdx#updatepermission) [permissions metadata API](/api-reference/metadata-api/permission.mdx).
Example using a Postgres db:
[update](/api-reference/syntax-defs.mdx#updatepermission)
[permissions metadata API](/api-reference/metadata-api/permission.mdx). Example using a Postgres db:
```http {15-20}
POST /v1/metadata HTTP/1.1
@ -855,19 +849,22 @@ This might be useful if you would like to hide a mutation from the public facing
Setting `backend-only` is currently available for insert, update and delete mutations.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can set a mutate permission for a role as backend only in the Hasura Console as follows:
<Thumbnail src='/img/auth/allow-backends-only_console_2.10.1.png' alt='Allow backends only in Hasura console'
width='600px' />
<Thumbnail
src='/img/auth/allow-backends-only_console_2.10.1.png'
alt='Allow backends only in Hasura console'
width='600px'
/>
</TabItem>
<TabItem value="cli" label="CLI">
You can set a mutate permission for a role as backend only in the `metadata >
databases > [database-name] > tables > [table-name].yaml` file, eg: `public_users.yaml`:
You can set a mutate permission for a role as backend only in the
`metadata > databases > [database-name] > tables > [table-name].yaml` file, eg: `public_users.yaml`:
```yaml {10,14}
table:
@ -878,7 +875,7 @@ insert_permissions:
permission:
check: {}
columns:
- id
- id
backend_only: true
delete_permissions:
- role: user
@ -891,8 +888,8 @@ delete_permissions:
<TabItem value="api" label="API">
You can set a mutate permission for a role as backend only with the Metadata API and the
[insert](/api-reference/syntax-defs.mdx#insertpermission), [update](/api-reference/syntax-defs.mdx#updatepermission)
or [delete](/api-reference/syntax-defs.mdx#deletepermission) permissions.
[insert](/api-reference/syntax-defs.mdx#insertpermission), [update](/api-reference/syntax-defs.mdx#updatepermission) or
[delete](/api-reference/syntax-defs.mdx#deletepermission) permissions.
```http {19}
POST /v1/metadata HTTP/1.1
@ -930,7 +927,6 @@ and above.
:::
### Disabling Root Fields {#disabling-root-fields}
When you track a table in Hasura, by default it exposes all the root fields available to the role. However, sometimes
@ -949,22 +945,23 @@ Disabling root fields is supported in version `v2.8.0` and above.
:::
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can disable specific root fields for query and subscription by unchecking them in the Select permission for the
table and role in Console as follows:
<Thumbnail src='/img/auth/disable-root-fields_console_2.11.1.png' alt='Disable root fields in Hasura console'
width='600px' />
<Thumbnail
src='/img/auth/disable-root-fields_console_2.11.1.png'
alt='Disable root fields in Hasura console'
width='600px'
/>
</TabItem>
<TabItem value="cli" label="CLI">
You can disable root fields for queries and subscriptions specifying which are available for the
`select_permissions` by updating the specific `metadata > databases > [database-name] > tables > [table-name].yaml` file
eg:
You can disable root fields for queries and subscriptions specifying which are available for the `select_permissions` by
updating the specific `metadata > databases > [database-name] > tables > [table-name].yaml` file eg:
```yaml {10-15}
table:
@ -991,8 +988,8 @@ delete_permissions:
:::info Note
Setting the value of `query_root_fields` or `subscription_root_fields` to `null` or not defining it at
all implies that all fields are allowed and an empty array means no fields are allowed.
Setting the value of `query_root_fields` or `subscription_root_fields` to `null` or not defining it at all implies that
all fields are allowed and an empty array means no fields are allowed.
:::
@ -1000,8 +997,8 @@ all implies that all fields are allowed and an empty array means no fields are a
<TabItem value="api" label="API">
You can disable root fields for Select permissions with the
[permissions metadata API](/api-reference/metadata-api/permission.mdx) by specifying which should be available in
the `query_root_fields` and `subscription_root_fields` arrays, eg:
[permissions metadata API](/api-reference/metadata-api/permission.mdx) by specifying which should be available in the
`query_root_fields` and `subscription_root_fields` arrays, eg:
```http {16,17}
POST /v1/metadata HTTP/1.1
@ -1028,16 +1025,14 @@ X-Hasura-Role: admin
:::info Note
Setting the value of `query_root_fields` or `subscription_root_fields` to `null` or not defining it at
all implies that all fields are allowed and an empty array means no fields are allowed.
Setting the value of `query_root_fields` or `subscription_root_fields` to `null` or not defining it at all implies that
all fields are allowed and an empty array means no fields are allowed.
:::
</TabItem>
</Tabs>
#### Use cases
##### 1. Allow a table to be accessible only through a relationship
@ -1054,12 +1049,14 @@ We would like to configure permissions of the `guest` role such that they are on
Modifying the select permission of the `articles` table:
<Thumbnail
src='/img/auth/disable-all-root-fields_console_2.11.1.png'
alt='Disable root fields in Hasura console'
width='600px'
/>
<Thumbnail src='/img/auth/disable-all-root-fields_console_2.11.1.png' alt='Disable root fields in Hasura console' width='600px' />
Note that `query_root_fields` and `subscription_root_fields` are set to `[]`, which means that the `guest` role
won't be able to access the `articles` table directly, but will be able to access it through the `articles`
relationship.
Note that `query_root_fields` and `subscription_root_fields` are set to `[]`, which means that the `guest` role won't be
able to access the `articles` table directly, but will be able to access it through the `articles` relationship.
:::caution
@ -1078,7 +1075,11 @@ In this case, regardless of the permission on the table, only `<table>_by_pk` sh
This can be done in the following way:
<Thumbnail src='/img/auth/disable-select-root-fields_console_2.11.1.png' alt='Disable select root fields in Hasura console' width='600px' />
<Thumbnail
src='/img/auth/disable-select-root-fields_console_2.11.1.png'
alt='Disable select root fields in Hasura console'
width='600px'
/>
##### 3. Disable subscription fields
@ -1086,7 +1087,11 @@ You can allow a role to only be able to make query and not subscription requests
This can be done in the following way:
<Thumbnail src='/img/auth/disable-subscription-root-fields_console_2.11.1.png' alt='Disable subscription root fields inHasura console' width='600px' />
<Thumbnail
src='/img/auth/disable-subscription-root-fields_console_2.11.1.png'
alt='Disable subscription root fields inHasura console'
width='600px'
/>
:::info Additional Resources

24
docs/docs/data-federation/apollo-federation.mdx
View File

@ -10,6 +10,7 @@ keywords:
- subgraph
- data federation
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
@ -19,14 +20,14 @@ import Thumbnail from '@site/src/components/Thumbnail';
## Introduction
Hasura GraphQL engine supports the Apollo Federation v1 spec, so you can add Hasura as a subgraph in your Apollo
federated gateway. You can also use Hasura generated table types in your other subgraphs by enabling tables for
Apollo Federation explicitly.
federated gateway. You can also use Hasura generated table types in your other subgraphs by enabling tables for Apollo
Federation explicitly.
:::caution Experimental
Apollo Federation is an experimental feature and can be enabled by adding `apollo_federation` to the
`HASURA_GRAPHQL_EXPERIMENTAL_FEATURES` [environment variable array](/deployment/graphql-engine-flags/reference.mdx)
or with the server flag `--experimental-feature`.
`HASURA_GRAPHQL_EXPERIMENTAL_FEATURES` [environment variable array](/deployment/graphql-engine-flags/reference.mdx) or
with the server flag `--experimental-feature`.
:::
@ -61,23 +62,20 @@ Other types such as action types, remote schema types, etc. cannot be extended t
:::
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Data -> [table-name] -> Modify` tab in the console and toggle the switch in the `Enable Apollo Federation`
section:
<Thumbnail
src="/img/graphql/core/data-federation/apollo-federation-enable.png"
alt="Set table as enum"
/>
<Thumbnail src='/img/graphql/core/data-federation/apollo-federation-enable.png' alt='Set table as enum' />
</TabItem>
<TabItem value="cli" label="CLI">
To enable Apollo Federation using the Hasura CLI head to the particular
`/metadata/databases/<schema_name>/tables/<schema_name>_<table_name>.yaml` file and add the database configuration
as below:
`/metadata/databases/<schema_name>/tables/<schema_name>_<table_name>.yaml` file and add the database configuration as
below:
```yaml {6-7}
table:
@ -96,8 +94,8 @@ hasura metadata apply
</TabItem>
<TabItem value="api" label="API">
To extend the types using the [Hasura Metadata API](/api-reference/metadata-api/table-view.mdx), you can to enable
it with the particular `*_set_apollo_federation_config` call:
To extend the types using the [Hasura Metadata API](/api-reference/metadata-api/table-view.mdx), you can to enable it
with the particular `*_set_apollo_federation_config` call:
```http {16-18}
POST /v1/metadata HTTP/1.1

44
docs/docs/databases/connect-db/cloud-connection-pooling.mdx
View File

@ -16,14 +16,14 @@ sidebar_class_name: cloud-icon
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from "@site/src/components/Thumbnail";
import Thumbnail from '@site/src/components/Thumbnail';
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
## Introduction
In Hasura, you get automatic connection pools for your database connections. Apart from the general performance benefits of
using pooled connections, this also ensures that your database remains reliable even during periods of massive load.
In Hasura, you get automatic connection pools for your database connections. Apart from the general performance benefits
of using pooled connections, this also ensures that your database remains reliable even during periods of massive load.
:::info Note
@ -32,10 +32,9 @@ Connection pooling is only available for [PostgreSQL](/api-reference/syntax-defs
:::
In Hasura Cloud, the connection pool is elastic i.e. shrinks and grows based on usage and also respects a configured max limit.
There are many other tunable parameters for the pool settings which can help you change the behaviour of the pool as required.
Read more about these in the [How connection pooling works](#how-connection-pooling-works) section below.
In Hasura Cloud, the connection pool is elastic i.e. shrinks and grows based on usage and also respects a configured max
limit. There are many other tunable parameters for the pool settings which can help you change the behaviour of the pool
as required. Read more about these in the [How connection pooling works](#how-connection-pooling-works) section below.
### Getting started
@ -51,12 +50,12 @@ project can be calculated as `number of server instances * max_connections`
:::
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
While adding a new database, under `Connection Settings`, set the desired `Total Max Connections` for primary and read
replica pools. To set or update `total_max_connections` for existing sources, head to the `Data > Databases > Manage >
[database-name] > Edit` page and scroll down to the `Connection Settings` section.
replica pools. To set or update `total_max_connections` for existing sources, head to the
`Data > Databases > Manage > [database-name] > Edit` page and scroll down to the `Connection Settings` section.
<Thumbnail src='/img/databases/total-max-connections.png' alt='Total max connections' max-width='543px' />
@ -156,17 +155,16 @@ X-Hasura-Role: admin
</TabItem>
</Tabs>
## How connection pooling works
A connection pool starts off empty and as new requests arrive, a connection to the database is established. This connection
stays warm in the pool to be reused by any other waiting request. This ensures that subsequent requests do not have to
reestablish a database connection hence saving time and resources.
A connection pool starts off empty and as new requests arrive, a connection to the database is established. This
connection stays warm in the pool to be reused by any other waiting request. This ensures that subsequent requests do
not have to reestablish a database connection hence saving time and resources.
After a certain period of connection idleness (specified by `idle_timeout`) or connection lifetime (specified by
`connection_lifetime`), the connection is released from the pool. This ensures that Hasura is not holding
connections which are not required.
`connection_lifetime`), the connection is released from the pool. This ensures that Hasura is not holding connections
which are not required.
If the connection pool is saturated, then any new request waits for the pool to provide a connection. This ensures that
your database is not bombarded with more connections than it can handle. You can also specify a `pool_timeout` to
timeout any requests that are blocked on the connection pool.
@ -175,16 +173,16 @@ timeout any requests that are blocked on the connection pool.
During heavy load, the number of connections may slightly exceed the `total_max_connections` limit for a brief period of
time during which Hasura Cloud is trying to adjust pools in existing Hasura Server instances. Always set the
`total_max_connections` value slightly lower than the database true total maximum limit in order to avoid exceeding
your resource limits.
`total_max_connections` value slightly lower than the database true total maximum limit in order to avoid exceeding your
resource limits.
:::
:::info `total_max_connections` and `max_connections`
If both `total_max_connections` and `max_connections` are set, then `total_max_connections` will take precedence over
the `max_connections`. If neither is set, `total_max_connections` assumes a default value. If only `max_connections`
is set, then Hasura Cloud will not be able to maintain a fixed size of a pool and hence the total number of connections
on the database can be random.
the `max_connections`. If neither is set, `total_max_connections` assumes a default value. If only `max_connections` is
set, then Hasura Cloud will not be able to maintain a fixed size of a pool and hence the total number of connections on
the database can be random.
:::

2
docs/docs/databases/connect-db/index.mdx
View File

@ -26,7 +26,7 @@ based on the database schemas.
In versions `v2.0.0` and above, databases can be connected and removed dynamically without having to restart the GraphQL
engine instance via the console / metadata APIs / CLI:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to `Data -> Manage -> Connect database`

4
docs/docs/databases/connect-db/read-replicas.mdx
View File

@ -32,7 +32,7 @@ mutations and metadata API calls to the primary.
### Postgres
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to `Data -> Manage -> <db-name> -> Edit`
@ -140,7 +140,7 @@ supported for v2.0 and above projects.**
### MS SQL Server
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to `Data -> Manage -> <db-name> -> Edit`

2
docs/docs/deployment/deployment-guides/azure-container-instances-postgres.mdx
View File

@ -27,7 +27,7 @@ This guide walks you through deploying the Hasura GraphQL engine on [Azure](http
You can deploy all the resources mentioned in this guide with the one-click button below.
<Tabs className="rst-class">
<Tabs groupId="user-preference" className="rst-class">
<TabItem value="with-new-pg-server" label="With a new Postgres Server">
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3a%2f%2fraw.githubusercontent.com%2fhasura%2fgraphql-engine%2fstable%2finstall-manifests%2fazure-container-with-pg%2fazuredeploy.json)

2
docs/docs/deployment/deployment-guides/docker.mdx
View File

@ -170,7 +170,7 @@ network config is different. This section shows how to connect in each of these
### Network config
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="linux" label="Linux">
<table>

14
docs/docs/deployment/health-checks/source-health-check.mdx
View File

@ -27,15 +27,15 @@ Hasura enables users to check the health of connected data sources via the healt
## Configuring source health check
A health check configuration contains information that Hasura uses to determine the health state of a source. You
can set the time interval for when Hasura will re-perform the check on the source.
A health check configuration contains information that Hasura uses to determine the health state of a source. You can
set the time interval for when Hasura will re-perform the check on the source.
Currently, Hasura supports enabling health checks on Postgres and MS SQL Server databases. Support for other data
sources will be added soon.
Health check configurations for Postgres and SQL Server sources are identical and are as follows.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Console support will be added soon.
@ -114,10 +114,10 @@ X-Hasura-Role: admin
### API
Health check reports of sources can be obtained through a `GET` request from the
`/healthz/sources` API, on demand. Learn more about the API [here](/api-reference/source-health.mdx).
Health check reports of sources can be obtained through a `GET` request from the `/healthz/sources` API, on demand.
Learn more about the API [here](/api-reference/source-health.mdx).
### Logging
Hasura logs the health check status and other information via `health-check-log` type when enabled.
Learn more about the health checks logs [here](/deployment/logging.mdx#health-check-log-structure).
Hasura logs the health check status and other information via `health-check-log` type when enabled. Learn more about the
health checks logs [here](/deployment/logging.mdx#health-check-log-structure).

45
docs/docs/event-triggers/clean-up/auto-cleanup.mdx
View File

@ -16,7 +16,7 @@ sidebar_class_name: cloud-and-enterprise-icon
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from "@site/src/components/Thumbnail";
import Thumbnail from '@site/src/components/Thumbnail';
# Auto cleanup of event trigger logs
@ -32,26 +32,26 @@ Auto cleanup for event triggers is available from Hasura version `v2.13` and abo
Hasura provides a way to automate the cleanup of the event trigger logs based on the following parameters:
| Name of the parameter | Description | Default | Example |
|-----------------------|-----------------------------------------------------------------------------------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------|
| clear_older_than | Minimum age (in hours) of the event logs that need to be cleared from when the cleanup action is invoked. | - | `clear_older_than: 168` means logs older than 168 hours (7 days) will be deleted. |
| schedule | Cron expression at which the cleanup should be invoked. | - | A `0 0 * * *` schedule means that the cleanup will be invoked every day at 00:00 (UTC time). |
| clean_invocation_logs | Option to indicate whether the corresponding invocation logs are also to be cleaned. | false | `clean_invocation_logs: false` means that invocation logs will not be cleaned. |
| batch_size | Maximum number of logs to delete in a single statement during the cleanup action. If there are more events to be cleaned than the `batch_size` then the cleanup action will execute multiple statements sequentially until all old event logs are cleared. | 10000 | Suppose there are 10000 events pending deletion and a `batch_size` of 1000 then the cleanup will be performed in 10 batches sequentially. |
| timeout | Maximum time (in seconds) that a batch can take during the cleanup process. If a batch times out, the cleanup process is halted. | 60 | A timeout of 60 means a batch of cleanup should not take more than 60 seconds. If a batch takes more than the `timeout`, then all the subsequent batches for the cleanup action will be cancelled. |
| paused | Indicates if the auto-cleanup process is paused. | false | `paused: true` means cleanup is paused, hence no logs will be deleted. |
| Name of the parameter | Description | Default | Example |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| clear_older_than | Minimum age (in hours) of the event logs that need to be cleared from when the cleanup action is invoked. | - | `clear_older_than: 168` means logs older than 168 hours (7 days) will be deleted. |
| schedule | Cron expression at which the cleanup should be invoked. | - | A `0 0 * * *` schedule means that the cleanup will be invoked every day at 00:00 (UTC time). |
| clean_invocation_logs | Option to indicate whether the corresponding invocation logs are also to be cleaned. | false | `clean_invocation_logs: false` means that invocation logs will not be cleaned. |
| batch_size | Maximum number of logs to delete in a single statement during the cleanup action. If there are more events to be cleaned than the `batch_size` then the cleanup action will execute multiple statements sequentially until all old event logs are cleared. | 10000 | Suppose there are 10000 events pending deletion and a `batch_size` of 1000 then the cleanup will be performed in 10 batches sequentially. |
| timeout | Maximum time (in seconds) that a batch can take during the cleanup process. If a batch times out, the cleanup process is halted. | 60 | A timeout of 60 means a batch of cleanup should not take more than 60 seconds. If a batch takes more than the `timeout`, then all the subsequent batches for the cleanup action will be cancelled. |
| paused | Indicates if the auto-cleanup process is paused. | false | `paused: true` means cleanup is paused, hence no logs will be deleted. |
## Auto cleanup
For automatic cleanup, you can provide a cleanup config while [adding the event
trigger](/event-triggers/create-trigger.mdx) and Hasura will clean up the logs according to the provided config.
For automatic cleanup, you can provide a cleanup config while
[adding the event trigger](/event-triggers/create-trigger.mdx) and Hasura will clean up the logs according to the
provided config.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
For an existing event trigger, head to the `Modify` tab of the event trigger and scroll down to the `Auto-cleanup Event
Logs` section.
For an existing event trigger, head to the `Modify` tab of the event trigger and scroll down to the
`Auto-cleanup Event Logs` section.
<Thumbnail src='/img/event-triggers/auto-cleanup.png' alt='Auto cleanup' max-width='543px' />
@ -126,11 +126,10 @@ X-Hasura-Role: admin
</TabItem>
</Tabs>
:::caution Warning
If you initially choose not to delete `invocation_logs`, but later they need to be deleted, you will need to delete
the retained logs manually.
If you initially choose not to delete `invocation_logs`, but later they need to be deleted, you will need to delete the
retained logs manually.
:::
@ -139,7 +138,6 @@ If you initially choose not to delete `invocation_logs`, but later they need to
For cleaning up the event trigger logs using an API, Hasura provides the
[cleanup_event_trigger_logs](/api-reference/metadata-api/event-triggers.mdx#metadata-cleanup-event-trigger-logs) API.
## Managing automatic cleaners
For the ease of managing automated cleanups, Hasura provides few metadata APIs such as:
@ -158,6 +156,7 @@ While applying migrations, you may pause all the installed cleaners for better p
### API usage examples
- Activate the cleaners on all the triggers defined on all the event-trigger-supported sources
```json
POST /v1/metadata HTTP/1.1
Content-Type: application/json
@ -173,8 +172,8 @@ X-Hasura-Role: admin
}
```
- Activate the cleaners on all the triggers defined on the sources: `source_1`,
`source_2`
- Activate the cleaners on all the triggers defined on the sources: `source_1`, `source_2`
```json
POST /v1/metadata HTTP/1.1
Content-Type: application/json
@ -190,8 +189,8 @@ X-Hasura-Role: admin
}
```
- Activate the cleaners on triggers: `sample_trigger_1`, `sample_trigger_2`
defined on source `default`
- Activate the cleaners on triggers: `sample_trigger_1`, `sample_trigger_2` defined on source `default`
```json
POST /v1/metadata HTTP/1.1
Content-Type: application/json

8
docs/docs/event-triggers/create-trigger.mdx
View File

@ -22,7 +22,7 @@ triggers exists for Postgres and MSSQL databases.
## Creating triggers
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Open the Hasura Console, head to the `Events` tab and click on the `Create` button to open the page below:
@ -138,7 +138,7 @@ Choose the columns here which you want the update operation to listen to.
If a column is not selected here, then an update to that column will not trigger the webhook.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Expand the `Advanced Settings` section on the Hasura Console to define advanced settings for an event trigger:
@ -240,7 +240,7 @@ Retry configuration is available in the "Advanced settings" when you create a tr
2. `interval_sec`: Number of seconds after which a failed invocation is retried. Default value is **10**.
3. `timeout_sec`: Number of seconds before which client closes the connection to the webhook. Default value is **60**.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Expand the `Advanced Settings` section on the Hasura Console to define advanced settings for an event trigger:
@ -362,7 +362,7 @@ Each header has 3 parameters:
variable in the GraphQL engine which will be resolved before sending the header.
3. `Value`: The value of the header. Either a static value or the name of an environment variable.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Expand the `Advanced Settings` section on the Hasura Console to define advanced settings for an event trigger:

2
docs/docs/event-triggers/invoke-trigger-manually.mdx
View File

@ -16,7 +16,7 @@ import Thumbnail from '@site/src/components/Thumbnail';
# Invoke event trigger manually
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
You can select the `Via console` trigger operation while [creating an event trigger](/event-triggers/create-trigger.mdx)

25
docs/docs/event-triggers/payload.mdx
View File

@ -8,8 +8,9 @@ keywords:
- event trigger
- payload
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Event trigger payload
@ -60,8 +61,7 @@ Content-Type: application/json
| schema-name | String | Name of the schema for the table |
| table-name | String | Name of the table |
<Tabs className="json-payloads">
<Tabs groupId="user-preference" className="json-payloads">
<TabItem value="postgres" label="Postgres">
**In case of**:
@ -77,8 +77,7 @@ Content-Type: application/json
- `event.data.new` will be `null`
- MANUAL
- `event.data.old` will be `null`
- `event.data.new` will contain the current row
- `event.data.new` will contain the current row
:::info Note
@ -141,17 +140,15 @@ Content-Type: application/json
- `event.data.new` will be `null`
- MANUAL
- `event.data.old` will be `null`
- `event.data.new` will contain the current row
- `event.data.new` will contain the current row
:::info Note
- In case of `UPDATE`, the events are delivered only if new data is
distinct from old data. We use the primary keys to join the temporary tables `inserted`
and `deleted` tables to correlate the old and new data.
- In case of `UPDATE`, the events are delivered only if new data is distinct from old data. We use the primary keys to
join the temporary tables `inserted` and `deleted` tables to correlate the old and new data.
- `UPDATE` event triggers will only work on tables which have primary keys.
- Since we use the primary key to co-relate DELETED and INSERTED table, if the
primary key is updated then it is not possible to correlate the `old` and `new` data. Hence, only `new` data is sent in this case.
- Since we use the primary key to co-relate DELETED and INSERTED table, if the primary key is updated then it is not
possible to correlate the `old` and `new` data. Hence, only `new` data is sent in this case.
:::
@ -189,8 +186,6 @@ Content-Type: application/json
</TabItem>
</Tabs>
## Syntax definitions
### Object

12
docs/docs/event-triggers/rest-connectors.mdx
View File

@ -43,7 +43,7 @@ REST Connectors are supported in Hasura GraphQL Engine versions `v2.1.0` and abo
REST Connectors can be configured either when creating a new event trigger or editing an existing one. See the transform
options [here](#event-trigger-transform-types):
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Go to the `Events` tab on the console and create or modify an event trigger. Scroll down to `Configure REST Connectors`
@ -199,7 +199,7 @@ You can transform your:
You can change the request method to adapt to your API's expected format.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Events > [event_trigger_name]` page. Under `Configure REST Connectors` click on
@ -305,7 +305,7 @@ You can also provide query params to add to the URL.
You can use the [Kriti templating language](/api-reference/kriti-templating.mdx) to construct any string values here.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Events > [event_trigger_name]` page. Under `Configure REST Connectors` click on
@ -442,7 +442,7 @@ request body to `x_www_form_urlencoded` formats.
If you are using a `GET` request, you might want to not send any request body, and additionally not send a
`content-type` header to the webhook. You can do that using the disable body feature.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the `Configure REST Connectors` section, click on `Add Request Options Transform`, and convert the `Request Method`
@ -550,7 +550,7 @@ X-Hasura-Role: admin
You can transform Request Body to `application/json` format using the following steps:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the `Configure REST Connectors` section, click on `Add Payload Transform`. By default console sends the body as
@ -659,7 +659,7 @@ While doing `x_www_form_urlencoded` transformation, please note that as all chan
when calling the API, so you will need to remove the default `application/json` header and add a
`application/x-www-form-urlencoded` header.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the `Configure REST Connectors` section, click on `Add Payload Transform`. Change the dropdown next to

2
docs/docs/hasura-cli/install-hasura-cli.mdx
View File

@ -24,7 +24,7 @@ import Link from '@docusaurus/Link';
The recommended installation method of the Hasura CLI is to install it as a global binary. You can download it by
following the instructions for your operating system:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="linux" label="Linux">
In your Linux shell, run the following command:

17
docs/docs/migrations-metadata-seeds/legacy-configs/config-v2/manage-metadata.mdx
View File

@ -19,14 +19,15 @@ import Thumbnail from '@site/src/components/Thumbnail';
If your Postgres schema is already managed with a tool like knex, TypeORM, Django/Rails migrations, you will still need
a way to export the actions you performed on the Hasura console to apply it later on another Hasura instance.
All the actions performed on the console, like tracking tables/views/custom functions, creating relationships, configuring
permissions, creating event triggers and remote schemas, etc. can be exported as a JSON/yaml metadata file which can be
version controlled. The metadata file can be later imported to another Hasura instance to get the same configuration.
You can also manually edit the metadata file to add more objects to it and then use it to update the instance.
All the actions performed on the console, like tracking tables/views/custom functions, creating relationships,
configuring permissions, creating event triggers and remote schemas, etc. can be exported as a JSON/yaml metadata file
which can be version controlled. The metadata file can be later imported to another Hasura instance to get the same
configuration. You can also manually edit the metadata file to add more objects to it and then use it to update the
instance.
## Exporting Hasura metadata
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="cli" label="CLI">
Metadata can be exported with the [hasura metadata export](/hasura-cli/commands/hasura_metadata_export.mdx) command.
@ -83,7 +84,7 @@ modified version of an instance's metadata onto itself.
Importing completely replaces the metadata on that instance, i.e. you lose any metadata that was already present before.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="cli" label="CLI">
Metadata can be applied with the [hasura metadata apply](/hasura-cli/commands/hasura_metadata_apply.mdx) command.
@ -134,7 +135,7 @@ importing the metadata.
In some cases, the metadata can be out of sync with the Postgres schema. For example, when a new column has been added
to a table via an external tool such as `psql`.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="cli" label="CLI">
@ -183,7 +184,7 @@ Resetting GraphQL engine's metadata is an irreversible process. It is recommende
it can be reapplied if needed or else that information will be lost and Hasura will have to be configured again from
scratch (e.g. tracking tables, relationships, creating triggers, actions, etc.).
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="cli" label="CLI">

53
docs/docs/migrations-metadata-seeds/manage-metadata.mdx
View File

@ -78,7 +78,7 @@ same.
To export your Metadata means to save your internal Hasura Metadata configuration to a file or group of files in order
to track it with version control or use it in a CI/CD pipeline.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="cli" label="CLI">
To export your entire Metadata using the Hasura CLI execute the following command in your terminal:
@ -125,11 +125,18 @@ This will export the Metadata as YAML files in the `/metadata` directory eg:
1. Click on the settings ⚙ icon at the top right corner of the console screen.
<Thumbnail alt='Settings navigation button' src='/img/migrations-metadata-seeds/settings-navigation_console_2-7-0.png' />
<Thumbnail
alt='Settings navigation button'
src='/img/migrations-metadata-seeds/settings-navigation_console_2-7-0.png'
/>
2. In the Hasura Metadata actions page that opens, click on the `Export Metadata` button.
<Thumbnail src='/img/migrations-metadata-seeds/metadata-export_console_2-7-0.png' alt='Export metadata' width='750px' />
<Thumbnail
src='/img/migrations-metadata-seeds/metadata-export_console_2-7-0.png'
alt='Export metadata'
width='750px'
/>
3. This will prompt a file download for `hasura_metadata_[timestamp].json`. Save the JSON blob file.
@ -162,7 +169,7 @@ instance's Metadata onto itself to replace the existing Metadata.
Applying or importing completely replaces the Metadata on that instance, i.e. you lose any Metadata that existed before
applying.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="cli" label="CLI">
Metadata can be applied with the [hasura metadata apply](/hasura-cli/commands/hasura_metadata_apply.mdx) command.
@ -183,11 +190,18 @@ INFO Metadata applied
1. Click on the settings ⚙ icon at the top right corner of the console screen.
<Thumbnail alt='Settings navigation button' src='/img/migrations-metadata-seeds/settings-navigation_console_2-7-0.png' />
<Thumbnail
alt='Settings navigation button'
src='/img/migrations-metadata-seeds/settings-navigation_console_2-7-0.png'
/>
2. Click on `Import Metadata` button.
<Thumbnail src='/img/migrations-metadata-seeds/metadata-import_console_2-7-0.png' alt='Import metadata' width='750px' />
<Thumbnail
src='/img/migrations-metadata-seeds/metadata-import_console_2-7-0.png'
alt='Import metadata'
width='750px'
/>
3. Choose a `hasura_metadata.json` file that was exported earlier.
@ -233,7 +247,7 @@ version control.
In some cases, the Metadata can be out of sync with the database schema. For example, when a new column has been added
to a table via an external tool such as `psql`.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="cli" label="CLI">
@ -256,11 +270,18 @@ INFO Metadata is consistent
1. Click on the settings ⚙ icon at the top right corner of the console screen.
<Thumbnail alt='Settings navigation button' src='/img/migrations-metadata-seeds/settings-navigation_console_2-7-0.png' />
<Thumbnail
alt='Settings navigation button'
src='/img/migrations-metadata-seeds/settings-navigation_console_2-7-0.png'
/>
2. Click on `Reload` button.
<Thumbnail alt='reload metadata' src='/img/migrations-metadata-seeds/metadata-reload_console_2-7-0.png' width='750px' />
<Thumbnail
alt='reload metadata'
src='/img/migrations-metadata-seeds/metadata-reload_console_2-7-0.png'
width='750px'
/>
3. A notification should appear indicating success.
@ -298,7 +319,7 @@ Clearing the Hasura Metadata is an irreversible process. It is highly recommende
reapplied if necessary or else that information will be lost and Hasura will have to be configured again from scratch
(e.g. tables tracking, relationships, triggers, actions, etc.).
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="cli" label="CLI">
@ -320,7 +341,10 @@ INFO Metadata cleared
1. Click on the settings ⚙ icon at the top right corner of the console screen.
<Thumbnail alt='Settings navigation button' src='/img/migrations-metadata-seeds/settings-navigation_console_2-7-0.png' />
<Thumbnail
alt='Settings navigation button'
src='/img/migrations-metadata-seeds/settings-navigation_console_2-7-0.png'
/>
2. Click on `Reset` button.
@ -354,7 +378,7 @@ If an admin secret is set, add `-H 'X-Hasura-Admin-Secret: [your-admin-secret]'`
Metadata should always be consistent against the underlying database schemas. When it's not, Hasura will mark the
Metadata objects as `inconsistent`.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="cli" label="CLI">
@ -403,7 +427,10 @@ INFO all inconsistent objects removed from metadata
1. Click on the settings ⚙ icon at the top right corner of the console screen.
<Thumbnail alt='Settings navigation button' src='/img/migrations-metadata-seeds/settings-navigation_console_2-7-0.png' />
<Thumbnail
alt='Settings navigation button'
src='/img/migrations-metadata-seeds/settings-navigation_console_2-7-0.png'
/>
2. Click on `Reset` button.

2
docs/docs/queries/ms-sql-server/performance.mdx
View File

@ -83,7 +83,7 @@ The following statement sets an index on `name` in the `authors` table.
CREATE INDEX ON authors (name);
```
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
An index can be added in the `Data -> SQL` tab in the Hasura console.

2
docs/docs/queries/postgres/performance.mdx
View File

@ -82,7 +82,7 @@ The following statement sets an index on `name` in the `authors` table.
CREATE INDEX ON authors (name);
```
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
An index can be added in the `Data -> SQL` tab in the Hasura console.

6
docs/docs/remote-schemas/adding-schema.mdx
View File

@ -49,7 +49,7 @@ The following details need to be specified for merging a remote schema:
value. This environment variable needs to be present when you start the GraphQL engine. When Hasura sends requests
to your remote server, it will pick up the value from this environment variable.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Remote Schemas` tab of the console and click on the `Add` button on the left sidebar.
@ -124,7 +124,7 @@ should be started with these environment variables.
## Step 2: Make queries to the remote server from Hasura
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Via console">
Now you can head to the `API` tab and make queries to your remote server from Hasura.
@ -149,7 +149,7 @@ You can query your remote server by making requests to the Hasura GraphQL endpoi
A remote server's GraphQL schema is cached and refreshed only when user explicitly reloads the remote schema.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to `Remote Schemas -> [remote_schema_name] -> Details` and click the `Reload` button.

2
docs/docs/remote-schemas/auth/remote-schema-permissions.mdx
View File

@ -282,7 +282,7 @@ Add a remote schema as described [here](/remote-schemas/adding-schema.mdx), if t
### Step 1: Set permissions
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to the `Remote Schemas -> [remote-schema-name] -> Permissions` tab.

2
docs/docs/remote-schemas/remote-relationships/remote-schema-db-relationships.mdx
View File

@ -59,7 +59,7 @@ the remote schema and the `user` table of the source database.
3. We select `pg1` as the reference database, `public` as the reference schema and `user` as the reference table.
4. We select `user_id` as the source field and `id` as the reference column.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to the `Remote schema -> [remote-schema-name] -> Relationships` tab.

2
docs/docs/remote-schemas/remote-relationships/remote-schema-relationships.mdx
View File

@ -62,7 +62,7 @@ the `user` field of the second remote schema.
3. We select `user-remote-schema` as the reference remote schema.
4. We select `id` as the source field and `user_id` as the from field.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to the `Remote schema -> [remote-schema-name] -> Relationships` tab.

4
docs/docs/scheduled-triggers/create-cron-trigger.mdx
View File

@ -37,7 +37,7 @@ For example, we can create a cron trigger called `eod_reports`, to trigger the w
the cron schedule `0 22 * * 1-5`, which means "At 22:00 on every day-of-week from Monday through Friday" (you can check
this [here](https://crontab.guru/#0_22_*_*_1-5)).
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Navigate to `Events > Cron Triggers > Create` in your Hasura console.
@ -106,7 +106,7 @@ If you like, you can also define the following values:
with it.
- **Comment**: Custom description of the cron trigger.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Expand the `Advanced` section.

4
docs/docs/scheduled-triggers/create-one-off-scheduled-event.mdx
View File

@ -30,7 +30,7 @@ The following fields for required to define a scheduled event:
- **Time**: The time to trigger the event.
- **Payload**: The JSON payload which will be sent to the webhook.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Navigate to `Events > One-off Scheduled Events > Schedule an event` in your Hasura console.
@ -82,7 +82,7 @@ If you like, you can also define advanced values:
- **Retry configuration**: In case the call to the webhook fails.
- **Comment**: Custom description of the scheduled trigger.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Expand the `Advanced` section.

2
docs/docs/schema/bigquery/computed-fields.mdx
View File

@ -84,7 +84,7 @@ statement.
## Adding computed fields to a table {#bigquery-adding-computed-field}
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">

4
docs/docs/schema/bigquery/custom-field-names.mdx
View File

@ -30,7 +30,7 @@ This feature is supported in versions `v2.0.8` and later.
## Expose columns with a different name in the GraphQL API
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Console support coming soon
@ -102,7 +102,7 @@ A custom field name can be set for a column via the following 2 methods:
## Expose table root fields with a different name in the GraphQL API
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Console support coming soon

8
docs/docs/schema/bigquery/data-validations.mdx
View File

@ -45,7 +45,7 @@ articles (id int, title text, author_id int, body text)
Now, we can create a role `editor` and add a select validation rule as follows:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
<Thumbnail src='/img/schema/bq-validation-not-empty.png' />
@ -142,8 +142,8 @@ authors (id int, name text)
articles (id int, title text, author_id int, body text)
```
Also, suppose there is an [object relationship](schema/bigquery/table-relationships/index.mdx) `articles.author`
defined as:
Also, suppose there is an [object relationship](schema/bigquery/table-relationships/index.mdx) `articles.author` defined
as:
```sql
articles.author_id -> authors.id
@ -151,7 +151,7 @@ articles.author_id -> authors.id
Now, we can create a role `author` and add an select validation rule as follows:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
<Thumbnail src='/img/schema/bq-author-own-articles.png' />

2
docs/docs/schema/bigquery/remote-relationships/remote-schema-relationships.mdx
View File

@ -68,7 +68,7 @@ schema `author-remote-schema`.
3. We set up the config to join the `id` input argument of our remote schema field to the `author_id` column of this
table (in this case, the `articles` table).
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to the `Data -> [table-name] -> Relationships` tab.

2
docs/docs/schema/bigquery/remote-relationships/remote-source-relationships.mdx
View File

@ -63,7 +63,7 @@ For example, say we have a table `articles(id int, author_id int)` in the source
We can create an object remote database relationship `author` joining the `articles` table to the `author` table using
the `articles.author_id` and `author.id` fields.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Console support will be added soon.

4
docs/docs/schema/bigquery/table-relationships/create.mdx
View File

@ -36,7 +36,7 @@ Let us now connect these tables to enable nested queries using manual relationsh
Each article has one author. This is an `object relationship`.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the console, select the `articles` table and navigate to the `Relationships` tab, then click `Configure` under
@ -153,7 +153,7 @@ For each author, there are many possible related articles. If we wanted to estab
would return an array. We model this in the Hasura console using an array relationship (we can also think of this as
being a one-to-many relationship between authors and articles).
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the console, select the `authors` table and navigate to the `Relationships` tab, then click `Configure` under

2
docs/docs/schema/bigquery/table-relationships/rename.mdx
View File

@ -18,7 +18,7 @@ import TabItem from '@theme/TabItem';
An existing relationship can be renamed as follows:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to `Data -> [table-name] -> Relationships` in the console

5
docs/docs/schema/bigquery/tables.mdx
View File

@ -43,7 +43,7 @@ articles (
```
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Open the Hasura console and head to the `Data` tab and click on the button on the left side bar to open up an interface
@ -118,7 +118,7 @@ X-Hasura-Role: admin
Tables can be present in the underlying BigQuery database without being exposed over the GraphQL API. In order to expose
a table over the GraphQL API, it needs to be **tracked**.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
When a table is created via the Hasura console, it gets tracked by default.
@ -238,6 +238,7 @@ tab in the console. _(You may want to add some sample data into the tables first
- Query all rows in the `articles` table:
{' '}
<GraphiQLIDE
query={`query {
bigquery_articles {

4
docs/docs/schema/ms-sql-server/custom-field-names.mdx
View File

@ -30,7 +30,7 @@ This feature is supported in versions `v1.0.0-beta.8` and later.
## Expose columns with a different name in the GraphQL API
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Console support coming soon
@ -104,7 +104,7 @@ A custom field name can be set for a column via the following 2 methods:
## Expose table root fields with a different name in the GraphQL API
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Console support coming soon

2
docs/docs/schema/ms-sql-server/default-values/mssql-column-presets.mdx
View File

@ -37,7 +37,7 @@ of the user's session variable whenever a new row is added to the `article` tabl
## Step 1: Configure a column preset
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Support will be added soon.

2
docs/docs/schema/ms-sql-server/default-values/mssql-defaults.mdx
View File

@ -37,7 +37,7 @@ whenever a new row is added to the table:
Edit the `created_at` field and set its default value as the SQL function `GETDATE()`.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Open the console and head to `Data -> [article] -> Modify`.

2
docs/docs/schema/ms-sql-server/remote-relationships/remote-schema-relationships.mdx
View File

@ -67,7 +67,7 @@ For example, let's assume that our database has a table `order(id int, user_id i
3. We set up the config to join the `id` input argument of our remote schema field to the `user_id` column of this
table (in this case, the `order` table).
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to the `Data -> [table-name] -> Relationships` tab.

2
docs/docs/schema/ms-sql-server/remote-relationships/remote-source-relationships.mdx
View File

@ -62,7 +62,7 @@ For example, say we have a table `order(id int, user_id int)` in the source data
We can create an object remote database relationship `user` joining the `order` table to the `user` table using the
`order.user_id` and `user.id` fields.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Data > [database] > [orders] > Relationships` tab. Under the `Remote Database Relationships` section,

10
docs/docs/schema/ms-sql-server/table-relationships/create.mdx
View File

@ -37,7 +37,7 @@ Let us now connect these tables to enable nested queries using a foreign-key:
Let's add a foreign-key constraint to the `author_id` column in the `articles` table.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the console, navigate to the `Modify` tab of the `articles` table. Click the `Add` button in the Foreign Keys section
@ -97,7 +97,7 @@ X-Hasura-Role: admin
Each article has one author. This is an `object relationship`.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
The console infers potential relationships using the foreign-key created above and recommends these in the
@ -212,7 +212,7 @@ An author can write multiple articles. This is an `array relationship`.
You can add an `array relationship` in the same fashion as an `object relationship` as shown above.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
On the console, add an `array relationship` named `articles` for the `authors` table as shown here:
@ -359,7 +359,7 @@ Let's say you have a table `authors (id, name)` and a [view](/schema/ms-sql-serv
Let us now create an `object relationship` called `avg_rating` from the `authors` table to the `author_avg_rating` view
using a manual relationship:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
**Step 1: Open the manual relationship section**
@ -498,7 +498,7 @@ Fetch a list of authors with the average rating of their articles:
As mentioned in the Introduction section above, relationships can be inferred via foreign-keys that exist in your
database:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
The console infers potential relationships using existing foreign-keys and recommends these on the `Data -> Schema` page

16
docs/docs/schema/ms-sql-server/table-relationships/rename.mdx
View File

@ -11,14 +11,14 @@ keywords:
- rename
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# MS SQL Server: Renaming Relationships
An existing relationship can be renamed as follows:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to `Data -> [table-name] -> Relationships` in the console
@ -28,8 +28,8 @@ An existing relationship can be renamed as follows:
</TabItem>
<TabItem value="cli" label="CLI">
You can rename a relationship by changing the relationship name in the
`tables.yaml` file inside the `metadata` directory:
You can rename a relationship by changing the relationship name in the `tables.yaml` file inside the `metadata`
directory:
```yaml {5}
- table:
@ -77,10 +77,8 @@ X-Hasura-Role: admin
:::info Note
You might not be allowed to drop a relationship if it has been
referenced elsewhere (e.g. in a permissions rule).
You might not be allowed to drop a relationship if it has been referenced elsewhere (e.g. in a permissions rule).
In this case you will have to delete the references first, rename the
relationship, and then re-add the references.
In this case you will have to delete the references first, rename the relationship, and then re-add the references.
:::

4
docs/docs/schema/ms-sql-server/tables.mdx
View File

@ -40,7 +40,7 @@ articles (
)
```
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Open the Hasura console and head to the `Data` tab and click on the button on the left side bar to open up an interface
@ -101,7 +101,7 @@ X-Hasura-Role: admin
Tables can be present in the underlying MS SQL Server database without being exposed over the GraphQL API. In order to
expose a table over the GraphQL API, it needs to be **tracked**.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
When a table is created via the Hasura console, it gets tracked by default.

8
docs/docs/schema/ms-sql-server/using-existing-database.mdx
View File

@ -28,7 +28,7 @@ Tracking a table or a view means telling Hasura GraphQL engine that you want to
### To track a table or a view
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
1. Head to the `Data -> Schema` section of the console.
@ -78,7 +78,7 @@ X-Hasura-Role: admin
### To track all tables and views present in the database
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
1. Head to the `Data -> Schema` section of the console.
@ -153,7 +153,7 @@ tables involved in the foreign-key.
### To track a foreign-key between two tables in the database
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
1. Head to the `Data -> Schema` section of the console.
@ -262,7 +262,7 @@ X-Hasura-Role: admin
### To track all the foreign-keys of all tables in the database
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
1. Head to the `Data -> Schema` section of the console.

4
docs/docs/schema/ms-sql-server/views.mdx
View File

@ -26,7 +26,7 @@ Hasura GraphQL engine lets you expose views over the GraphQL API to allow queryi
## Creating views {#ms-sql-server-create-views}
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Views can be created using SQL which can be run in the Hasura console:
@ -77,7 +77,7 @@ X-Hasura-Role: admin
Views can be present in the underlying MS SQL Server database without being exposed over the GraphQL API. In order to
expose a view over the GraphQL API, it needs to be **tracked**.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
While creating views from the `Data -> SQL` page, selecting the `Track this` checkbox will expose the new view over the

2
docs/docs/schema/postgres/computed-fields.mdx
View File

@ -177,7 +177,7 @@ Query data from the `authors` table:
## Adding a computed field to a table/view {#pg-adding-computed-field}
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Modify` tab of the table/view and click on the `Add` button in the `Computed fields` section:

4
docs/docs/schema/postgres/custom-field-names.mdx
View File

@ -31,7 +31,7 @@ This feature is supported in versions `v1.0.0-beta.8` and later.
## Expose columns with a different name in the GraphQL API
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Data -> [table-name] -> Modify`. On the relevant field, click `Edit` and change the GraphQL field name to a
@ -118,7 +118,7 @@ A custom field name can be set for a column via the following 2 methods:
## Expose table root fields with a different name in the GraphQL API
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Data -> [table-name] -> Modify`. Click the `Edit` button in the `Custom GraphQL Root Fields` section and

4
docs/docs/schema/postgres/custom-functions.mdx
View File

@ -47,7 +47,7 @@ Currently, only functions which satisfy the following constraints can be exposed
SQL functions can be created using SQL statements which can be executed as follows:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to the `Data -> SQL` section of the Hasura console
@ -96,7 +96,7 @@ X-Hasura-Role: admin
Functions can be present in the underlying Postgres database without being exposed over the GraphQL API. In order to
expose a function over the GraphQL API, it needs to be **tracked**.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
While creating functions from the `Data -> SQL` page, selecting the `Track this` checkbox will expose the new function

8
docs/docs/schema/postgres/data-validations.mdx
View File

@ -48,7 +48,7 @@ author (id uuid, name text, rating integer)
We can now add a check constraint to limit the `rating` values as follows:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Modify` tab in the table page and add a check constraint in the `Check Constraints` section:
@ -146,7 +146,7 @@ an article's content exceeds a certain number of words, and then add a
[Postgres trigger](https://www.postgresql.org/docs/current/sql-createtrigger.html) that will call this function every
time before an article is inserted or updated.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to the `Data -> SQL` section of the Hasura console
@ -265,7 +265,7 @@ article (id uuid, title text, content text, author_id uuid)
Now, we can create a role `user` and add an insert validation rule as follows:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
<Thumbnail src='/img/schema/validation-not-empty.png' alt='validation using permission: title cannot be empty' />
@ -369,7 +369,7 @@ article.author_id -> author.id
Now, we can create a role `user` and add an insert validation rule as follows:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
<Thumbnail

2
docs/docs/schema/postgres/default-values/column-presets.mdx
View File

@ -37,7 +37,7 @@ of the user's session variable whenever a new row is added to the `article` tabl
## Step 1: Configure a column preset
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
The column preset option is available under the `Permissions` tab of a table. Open the console and head to

4
docs/docs/schema/postgres/default-values/created-updated-timestamps.mdx
View File

@ -24,7 +24,7 @@ created or last updated. This page explains how to add these.
## Add a created_at timestamp
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
On the Hasura console, click on the `Modify` tab of a table. When clicking on the `+Frequently used columns` button,
@ -83,7 +83,7 @@ X-Hasura-Role: admin
## Add an updated_at timestamp
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
On the Hasura console, click on the `Modify` tab of a table. When clicking on the `+Frequently used columns` button,

2
docs/docs/schema/postgres/default-values/postgres-defaults.mdx
View File

@ -37,7 +37,7 @@ whenever a new row is added to the table:
Edit the `created_at` field and set its default value as the SQL function `now()`.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Open the console and head to `Data -> [article] -> Modify`.

4
docs/docs/schema/postgres/default-values/sql-functions.mdx
View File

@ -48,7 +48,7 @@ value of the `output` column as the uppercased value of the string received in t
Modify the table `sql_function_table` and make its `output` column nullable.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Open the console and head to `Data -> [sql_function_table] -> Modify`:
@ -117,7 +117,7 @@ CREATE FUNCTION test_func() RETURNS trigger AS $emp_stamp$
FOR EACH ROW EXECUTE PROCEDURE test_func();
```
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to `Data -> SQL` and run the above SQL:

2
docs/docs/schema/postgres/enums.mdx
View File

@ -130,7 +130,7 @@ Next, we need to tell Hasura that this table represents an enum.
Once we have a table which satisfies the conditions for an enum table as described [above](#pg-create-enum-table), we
need to tell Hasura that this table represents an enum.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Data -> [table-name] -> Modify` tab in the console and toggle the switch in the `Set table as enum`

13
docs/docs/schema/postgres/naming-convention.mdx
View File

@ -153,8 +153,9 @@ For the above schema, a sample GraphQL query will look like the following with t
:::tip Behaviour of custom table name
For the `graphql-default` naming convention and a [custom table name](/api-reference/syntax-defs.mdx#table-config) for a given
table/view, the following rules are followed:
For the `graphql-default` naming convention and a [custom table name](/api-reference/syntax-defs.mdx#table-config) for a
given table/view, the following rules are followed:
- The custom table name will not be modified (change of case) if it is the first entity for a given name.
- The custom table name may be modified if the name is being prefixed by something.
@ -175,13 +176,13 @@ This means any database source will follow this naming convention unless explici
## Set naming convention for a particular source {#pg-source-naming-convention}
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Currently setting the database naming convention is only allowed at the time of connecting your database.
Currently setting the database naming convention is only allowed at the time of connecting your database.
Head to the `Data -> Manage -> Connect Database` page. Under the `GraphQL Field Customization` section after, enabling the naming
conventions, you can choose the naming convention of your choice.
Head to the `Data -> Manage -> Connect Database` page. Under the `GraphQL Field Customization` section after, enabling
the naming conventions, you can choose the naming convention of your choice.
<Thumbnail src='/img/schema/naming-convention.png' alt='Naming Convention' />

2
docs/docs/schema/postgres/remote-relationships/action-relationships.mdx
View File

@ -47,7 +47,7 @@ The following values can be defined for an action relationship:
In this example, we're creating a relationship for the `createUser` action. We're creating a relationship called `user`,
from the `id` field returned in the action response, to the `id` column of the `users` table.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to the `Actions -> [action-name] -> Relationships` tab.

2
docs/docs/schema/postgres/remote-relationships/remote-schema-relationships.mdx
View File

@ -67,7 +67,7 @@ For example, let's assume that our database has a table `order(id int, user_id i
3. We set up the config to join the `id` input argument of our remote schema field to the `user_id` column of this
table (in this case, the `order` table).
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to the `Data -> [table-name] -> Relationships` tab.

2
docs/docs/schema/postgres/remote-relationships/remote-source-relationships.mdx
View File

@ -62,7 +62,7 @@ For example, say we have a table `order(id int, user_id int)` in the source data
We can create an object remote database relationship `user` joining the `order` table to the `user` table using the
`order.user_id` and `user.id` fields.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `Data > [database] > [orders] > Relationships` tab. Under the `Remote Database Relationships` section,

10
docs/docs/schema/postgres/table-relationships/create.mdx
View File

@ -37,7 +37,7 @@ Let us now connect these tables to enable nested queries using a foreign-key:
Let's add a foreign-key constraint to the `author_id` column in the `articles` table.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
In the console, navigate to the `Modify` tab of the `articles` table. Click the `Add` button in the Foreign Keys section
@ -97,7 +97,7 @@ X-Hasura-Role: admin
Each article has one author. This is an `object relationship`.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
The console infers potential relationships using the foreign-key created above and recommends these in the
@ -212,7 +212,7 @@ An author can write multiple articles. This is an `array relationship`.
You can add an `array relationship` in the same fashion as an `object relationship` as shown above.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
On the console, add an `array relationship` named `articles` for the `authors` table as shown here:
@ -359,7 +359,7 @@ which has the average rating of articles for each author.
Let us now create an `object relationship` called `avg_rating` from the `authors` table to the `author_avg_rating` view
using a manual relationship:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
**Step 1: Open the manual relationship section**
@ -498,7 +498,7 @@ Fetch a list of authors with the average rating of their articles:
As mentioned in the Introduction section above, relationships can be inferred via foreign-keys that exist in your
database:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
The console infers potential relationships using existing foreign-keys and recommends these on the `Data -> Schema` page

24
docs/docs/schema/postgres/table-relationships/rename.mdx
View File

@ -18,27 +18,27 @@ import TabItem from '@theme/TabItem';
An existing relationship can be renamed as follows:
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
- Head to `Data -> [table-name] -> Relationships` in the console
- Drop the existing relationship
- Recreate the relationship with the new name
- Head to `Data -> [table-name] -> Relationships` in the console
- Drop the existing relationship
- Recreate the relationship with the new name
</TabItem>
<TabItem value="cli" label="CLI">
You can rename a relationship by changing the relationship name in the
`tables.yaml` file inside the `metadata` directory:
You can rename a relationship by changing the relationship name in the `tables.yaml` file inside the `metadata`
directory:
```yaml {5}
- table:
schema: public
name: articles
object_relationships:
- name: author
using:
foreign_key_constraint_on: author_id
- name: author
using:
foreign_key_constraint_on: author_id
- table:
schema: public
name: authors
@ -77,10 +77,8 @@ X-Hasura-Role: admin
:::info Note
You might not be allowed to drop a relationship if it has been
referenced elsewhere (e.g. in a permissions rule).
You might not be allowed to drop a relationship if it has been referenced elsewhere (e.g. in a permissions rule).
In this case you will have to delete the references first, rename the
relationship, and then re-add the references.
In this case you will have to delete the references first, rename the relationship, and then re-add the references.
:::

67
docs/docs/schema/postgres/tables.mdx
View File

@ -40,7 +40,7 @@ articles (
)
```
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Open the Hasura console and head to the `Data` tab and click on the button on the left side bar to open up an interface
@ -101,7 +101,7 @@ X-Hasura-Role: admin
Tables can be present in the underlying Postgres database without being exposed over the GraphQL API. In order to expose
a table over the GraphQL API, it needs to be **tracked**.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
When a table is created via the Hasura console, it gets tracked by default.
@ -228,42 +228,43 @@ tab in the console. _(You may want to add some sample data into the tables first
<GraphiQLIDE
query={`query {
articles {
id
title
author_id
}
}`}
articles {
id
title
author_id
}
}`}
response={`{
"data": {
"articles": [
{
"id": 1,
"title": "sit amet",
"author_id": 4
},
{
"id": 2,
"title": "a nibh",
"author_id": 2
},
{
"id": 3,
"title": "amet justo morbi",
"author_id": 4
},
{
"id": 4,
"title": "vestibulum ac est",
"author_id": 5
}
]
}
}`}
"data": {
"articles": [
{
"id": 1,
"title": "sit amet",
"author_id": 4
},
{
"id": 2,
"title": "a nibh",
"author_id": 2
},
{
"id": 3,
"title": "amet justo morbi",
"author_id": 4
},
{
"id": 4,
"title": "vestibulum ac est",
"author_id": 5
}
]
}
}`}
/>
- Insert data in the `author` table:
{' '}
<GraphiQLIDE
query={`mutation add_author {
insert_author(

8
docs/docs/schema/postgres/using-existing-database.mdx
View File

@ -28,7 +28,7 @@ Tracking a table or a view means telling Hasura GraphQL engine that you want to
### To track a table or a view
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
1. Head to the `Data -> Schema` section of the console.
@ -78,7 +78,7 @@ X-Hasura-Role: admin
### To track all tables and views present in the database
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
1. Head to the `Data -> Schema` section of the console.
@ -153,7 +153,7 @@ tables involved in the foreign-key.
### To track a foreign-key between two tables in the database
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
1. Head to the `Data -> Schema` section of the console.
@ -262,7 +262,7 @@ X-Hasura-Role: admin
### To track all the foreign-keys of all tables in the database
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
1. Head to the `Data -> Schema` section of the console.

4
docs/docs/schema/postgres/views.mdx
View File

@ -26,7 +26,7 @@ Hasura GraphQL engine lets you expose views over the GraphQL API to allow queryi
## Creating views {#pg-create-views}
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Views can be created using SQL which can be run in the Hasura console:
@ -75,7 +75,7 @@ X-Hasura-Role: admin
Views can be present in the underlying Postgres database without being exposed over the GraphQL API. In order to expose
a view over the GraphQL API, it needs to be **tracked**.
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
While creating views from the `Data -> SQL` page, selecting the `Track this` checkbox will expose the new view over the

40
docs/docs/security/allow-list.mdx
View File

@ -9,10 +9,10 @@ keywords:
sidebar_position: 8
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
# Allow List of operations
@ -38,14 +38,11 @@ Allow-list validation will not be enforced for the `admin` role.
Head to the `API` tab and find the `Allow List` section in the console.
<Thumbnail
src="/img/api-explorer/allowlist-manager.png"
alt="AllowList manager"
/>
<Thumbnail src='/img/api-explorer/allowlist-manager.png' alt='AllowList manager' />
## Adding or removing an operation in Allow List
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `API` tab and find the `Allow List` section in the console.
@ -67,16 +64,13 @@ query ($id: Int!) {
After writing your query or selecting a query from quick add dropdown menu, click `Add Operation`.
<Thumbnail src="/img/api-explorer/write-operation.png" alt="Add operation" />
<Thumbnail src='/img/api-explorer/write-operation.png' alt='Add operation' />
- **Upload File**: Alternatively, you can upload files, like this
[sample file](https://gist.github.com/dsandip/8b1b4aa87708289d4c9f8fd9621eb025), to add multiple operations to the
Allow List. Each operation in the file will need a unique name. Once you've selected your file, click `Add Operation`.
<Thumbnail
src="/img/api-explorer/upload-operation.png"
alt="Upload operation"
/>
<Thumbnail src='/img/api-explorer/upload-operation.png' alt='Upload operation' />
</TabItem>
<TabItem value="cli" label="CLI">
@ -159,25 +153,22 @@ A role-based Allow List is useful when you would like a query collection(s) to b
:::info Note
Server support for Role-based Allow Lists in Cloud/Enterprise products is available from version `v2.3` and console support is available from version `v2.13`. In OSS, role-based entries are
ignored.
Server support for Role-based Allow Lists in Cloud/Enterprise products is available from version `v2.3` and console
support is available from version `v2.13`. In OSS, role-based entries are ignored.
On older versions (which do not support role-based Allow Lists), any role-based Allow List Metadata entry will be
treated as global. Hence, caution is advised when using role-based Allow List Metadata with older versions.
:::
<Tabs className="api-tabs">
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
Head to the `API` tab and find the `Allow List` section on the Console. On the left side bar, you can see a list of
query collections. After selecting a query collection, you can enable the roles which should have access to any query
collection via the `Permissions` tab.
<Thumbnail
src="/img/api-explorer/role-based-allow-list.png"
alt="Role based allow list"
/>
<Thumbnail src='/img/api-explorer/role-based-allow-list.png' alt='Role based allow list' />
</TabItem>
<TabItem value="cli" label="CLI">
@ -229,17 +220,14 @@ Metadata API.
## Quick-create allowed operations
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
### Hasura Cloud
This feature lets you add to the Allow List with one click from the record of past operations. (With Hasura GraphQL
Engine CE, Allow Lists must be managed manually).
<Thumbnail
src="/img/security/allowlist-add-new-op.png"
alt="Hasura Cloud Console create new allowed operation"
/>
<Thumbnail src='/img/security/allowlist-add-new-op.png' alt='Hasura Cloud Console create new allowed operation' />
## Recommended usage

22
docs/src/css/custom.scss
View File

@ -3,16 +3,16 @@
* bundles Infima by default. Infima is a CSS framework designed to
* work well for content-centric websites.
*/
@use "default-fonts-and-colors";
@use "cloud-and-enterprise-menu-icons";
@use "header";
@use "sidebar";
@use "table-of-contents";
@use "doc";
@use "footer";
@use "introduction-page";
@use "cloud-db-icon-gallery";
@use "admonitions";
@use 'default-fonts-and-colors';
@use 'cloud-and-enterprise-menu-icons';
@use 'header';
@use 'sidebar';
@use 'table-of-contents';
@use 'doc';
@use 'footer';
@use 'introduction-page';
@use 'cloud-db-icon-gallery';
@use 'admonitions';
/* Custom Styles */
.no-shadow {
@ -24,7 +24,6 @@
opacity: 0.75;
}
.sub-heading {
grid-column: 1 / -1;
@ -55,7 +54,6 @@ tbody {
/* Dark Mode Styles */
html[data-theme='dark'] {
.no-shadow {
background-color: var(--color-gray-0);
}

25
docs/src/css/doc.scss
View File

@ -37,7 +37,6 @@ pre code {
background-color: var(--ifm-code-background);
}
.prism-code code {
background-color: var(--color-gray-4);
.theme-code-block-highlighted-line {
@ -60,7 +59,6 @@ html[data-theme='dark'] {
}
}
.theme-edit-this-page {
display: flex;
align-items: center;
@ -181,8 +179,9 @@ html[data-theme='dark'] {
}
}
&:first-child .pagination-nav__label::before, &--next .pagination-nav__label::after {
background: url("/icons/arrow_right-light.svg") no-repeat;
&:first-child .pagination-nav__label::before,
&--next .pagination-nav__label::after {
background: url('/icons/arrow_right-light.svg') no-repeat;
}
.pagination-nav__label {
@ -192,7 +191,8 @@ html[data-theme='dark'] {
}
.theme-edit-this-page {
&::before, &::after {
&::before,
&::after {
filter: invert(1);
}
@ -202,4 +202,19 @@ html[data-theme='dark'] {
color: var(--ifm-color-gray-0);
}
}
.tabs-container {
background: var(--color-gray-82);
code {
background: var(--color-gray-74);
}
}
}
// Tabs styling
.tabs-container {
padding: 0 1rem;
padding-bottom: 1rem;
border-radius: 0.5rem;
box-shadow: var(--ifm-global-shadow-lw);
}