docs: clarify console operations

[DOCS-1242]: https://hasurahq.atlassian.net/browse/DOCS-1242?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10446
GitOrigin-RevId: 48478e27a9bd944ea5f2acfa0f0ba191d8867b88
This commit is contained in:
Rob Dominguez 2023-11-07 05:28:00 -06:00 committed by hasura-bot
parent 7ff77fdcfd
commit a451215f7c
11 changed files with 189 additions and 20 deletions

View File

@ -55,6 +55,22 @@ Currently, Hasura supports read-only queries, relationships, and permissions on
::: :::
## Managing data with the Hasura Console
The Hasura Console is a web UI that allows you to manage your data and metadata. It is available at
`http://localhost:8080/console` when you run Hasura locally, or from your project's Console endpoint when you use
[Hasura Cloud](https://cloud.hasura.io).
The data-management features (such as creating tables) are available in the `Data` tab. You can access your GraphQL API
in the `API` tab and interact with it using the GraphiQL interface.
:::info Console support
We recommend using your preferred Amazon Athena client instead. The Hasura Console is designed to be a tool for managing
your GraphQL API, and not a full-fledged database management tool.
:::
## Keep up to date ## Keep up to date
If you'd like to stay informed about the status of Amazon Athena support, subscribe to our newsletter and join our If you'd like to stay informed about the status of Amazon Athena support, subscribe to our newsletter and join our

View File

@ -39,14 +39,35 @@ Here is how you can get started with Hasura and BigQuery:
--> -->
## Managing data with the Hasura Console
The Hasura Console is a web UI that allows you to manage your data and metadata. It is available at
`http://localhost:8080/console` when you run Hasura locally, or from your project's Console endpoint when you use
[Hasura Cloud](https://cloud.hasura.io).
The data-management features (such as creating tables) are available in the `Data` tab. You can access your GraphQL API
in the `API` tab and interact with it using the GraphiQL interface.
:::info Console support
We recommend using your preferred BigQuery client instead. The Hasura Console is designed to be a tool for managing your
GraphQL API, and not a full-fledged database management tool.
:::
## Minimum required IAM permissions ## Minimum required IAM permissions
* BigQuery queries through Hasura require the `bigquery.jobs.create` and `bigquery.jobs.get` permissions to send a job to the BigQuery servers. - BigQuery queries through Hasura require the `bigquery.jobs.create` and `bigquery.jobs.get` permissions to send a job
* The `bigquery.tables.getData` permission allows Hasura to query your BigQuery data source. Note that mutations are not currently supported for BigQuery, and so no corresponding `updateData` permission is required. to the BigQuery servers.
* To use the Hasura Console to edit your data source, several different permissions may be required depending on your actions: - The `bigquery.tables.getData` permission allows Hasura to query your BigQuery data source. Note that mutations are not
* `bigquery.datasets.create` and `bigquery.datasets.delete` for creating and deleting datasets. currently supported for BigQuery, and so no corresponding `updateData` permission is required.
* `bigquery.routines.create`, `bigquery.routines.update`, and `bigquery.routines.delete` for managing user-defined functions and stored procedures. - To use the Hasura Console to edit your data source, several different permissions may be required depending on your
* `bigquery.table.create`, `bigquery.tables.list`, `bigquery.tables.get`, `bigquery.tables.delete`, and `bigquery.tables.update` to manage the dataset definition. actions:
- `bigquery.datasets.create` and `bigquery.datasets.delete` for creating and deleting datasets.
- `bigquery.routines.create`, `bigquery.routines.update`, and `bigquery.routines.delete` for managing user-defined
functions and stored procedures.
- `bigquery.table.create`, `bigquery.tables.list`, `bigquery.tables.get`, `bigquery.tables.delete`, and
`bigquery.tables.update` to manage the dataset definition.
## Supported features ## Supported features

View File

@ -34,6 +34,22 @@ Here are 2 ways you can get started with Hasura and ClickHouse:
2. [Docker](/databases/clickhouse/getting-started/docker.mdx): Run Hasura with Docker and then connect your ClickHouse 2. [Docker](/databases/clickhouse/getting-started/docker.mdx): Run Hasura with Docker and then connect your ClickHouse
instance to Hasura. instance to Hasura.
## Managing data with the Hasura Console
The Hasura Console is a web UI that allows you to manage your data and metadata. It is available at
`http://localhost:8080/console` when you run Hasura locally, or from your project's Console endpoint when you use
[Hasura Cloud](https://cloud.hasura.io).
The data-management features (such as creating tables) are available in the `Data` tab. You can access your GraphQL API
in the `API` tab and interact with it using the GraphiQL interface.
:::info Console support
We recommend using your preferred ClickHouse client instead. The Hasura Console is designed to be a tool for managing
your GraphQL API, and not a full-fledged database management tool.
:::
## Keep up to date ## Keep up to date
:::info Note :::info Note

View File

@ -205,6 +205,22 @@ schema.
- [Subscriptions](/subscriptions/overview.mdx) - [Subscriptions](/subscriptions/overview.mdx)
- [Event triggers](/event-triggers/overview.mdx) - [Event triggers](/event-triggers/overview.mdx)
## Managing data with the Hasura Console
The Hasura Console is a web UI that allows you to manage your data and metadata. It is available at
`http://localhost:8080/console` when you run Hasura locally, or from your project's Console endpoint when you use
[Hasura Cloud](https://cloud.hasura.io).
The data-management features (such as creating tables) are available in the `Data` tab. You can access your GraphQL API
in the `API` tab and interact with it using the GraphiQL interface.
:::info Console support
We recommend using your preferred MariaDB client instead. The Hasura Console is designed to be a tool for managing
your GraphQL API, and not a full-fledged database management tool.
:::
## Resources ## Resources
- Check out the [Getting Started with Docker](/databases/mariadb/docker.mdx) guide. - Check out the [Getting Started with Docker](/databases/mariadb/docker.mdx) guide.

View File

@ -43,6 +43,22 @@ To get started with MongoDB:
- In Hasura Cloud, check out our [Getting Started with MongoDB in Hasura Cloud](/databases/mongodb/cloud.mdx) guide - In Hasura Cloud, check out our [Getting Started with MongoDB in Hasura Cloud](/databases/mongodb/cloud.mdx) guide
- In a Docker environment, check out our [Getting Started with Docker](/databases/mongodb/docker.mdx) guide - In a Docker environment, check out our [Getting Started with Docker](/databases/mongodb/docker.mdx) guide
## Managing data with the Hasura Console
The Hasura Console is a web UI that allows you to manage your data and metadata. It is available at
`http://localhost:8080/console` when you run Hasura locally, or from your project's Console endpoint when you use
[Hasura Cloud](https://cloud.hasura.io).
The data-management features (such as creating tables) are available in the `Data` tab. You can access your GraphQL API
in the `API` tab and interact with it using the GraphiQL interface.
:::info Console support
We recommend using your preferred MongoDB client instead. The Hasura Console is designed to be a tool for managing
your GraphQL API, and not a full-fledged database management tool.
:::
## Keep up to date ## Keep up to date
If you'd like to stay informed about the status of MongoDB support, subscribe to our newsletter and join our Discord! If you'd like to stay informed about the status of MongoDB support, subscribe to our newsletter and join our Discord!

View File

@ -38,13 +38,31 @@ Here are 2 ways you can get started with Hasura and SQL Server:
Hasura currently supports queries, subscriptions, mutations, relationships, permissions, and Event Triggers on MS SQL Hasura currently supports queries, subscriptions, mutations, relationships, permissions, and Event Triggers on MS SQL
Server. Server.
## Managing data with the Hasura Console
The Hasura Console is a web UI that allows you to manage your data and metadata. It is available at
`http://localhost:8080/console` when you run Hasura locally, or from your project's Console endpoint when you use
[Hasura Cloud](https://cloud.hasura.io).
The data-management features (such as creating tables) are available in the `Data` tab. You can access your GraphQL API
in the `API` tab and interact with it using the GraphiQL interface.
:::info Console support
We recommend using your preferred MS SQL Server client instead. The Hasura Console is designed to be a tool for managing
your GraphQL API, and not a full-fledged database management tool.
:::
## Required permissions ## Required permissions
Assuming a `CONNECT` permission already exists, the following permissions are required for Hasura to function completely. Note that missing permissions may cause the corresponding features to work incorrectly: Assuming a `CONNECT` permission already exists, the following permissions are required for Hasura to function
completely. Note that missing permissions may cause the corresponding features to work incorrectly:
* To use the Hasura Console to alter your schema, you will need appropriate schema permissions, such as `CREATE TABLE`, `CREATE VIEW`, `CREATE FUNCTION`, and `CREATE PROCEDURE`, depending on what you want to do. - To use the Hasura Console to alter your schema, you will need appropriate schema permissions, such as `CREATE TABLE`,
* To perform queries and mutations, Hasura will need permission to `DELETE`, `INSERT`, `SELECT`, and `UPDATE`. `CREATE VIEW`, `CREATE FUNCTION`, and `CREATE PROCEDURE`, depending on what you want to do.
* To call MSSQL stored procedures via Hasura, the `EXECUTE` permission is also required. - To perform queries and mutations, Hasura will need permission to `DELETE`, `INSERT`, `SELECT`, and `UPDATE`.
- To call MSSQL stored procedures via Hasura, the `EXECUTE` permission is also required.
## Keep up to date ## Keep up to date

View File

@ -208,6 +208,22 @@ schema.
- [Subscriptions](/subscriptions/overview.mdx) - [Subscriptions](/subscriptions/overview.mdx)
- [Event triggers](/event-triggers/overview.mdx) - [Event triggers](/event-triggers/overview.mdx)
## Managing data with the Hasura Console
The Hasura Console is a web UI that allows you to manage your data and metadata. It is available at
`http://localhost:8080/console` when you run Hasura locally, or from your project's Console endpoint when you use
[Hasura Cloud](https://cloud.hasura.io).
The data-management features (such as creating tables) are available in the `Data` tab. You can access your GraphQL API
in the `API` tab and interact with it using the GraphiQL interface.
:::info Console support
We recommend using your preferred MySQL client instead. The Hasura Console is designed to be a tool for managing
your GraphQL API, and not a full-fledged database management tool.
:::
## Resources ## Resources
- Check out the [Getting Started with Docker](/databases/mysql/docker.mdx) guide. - Check out the [Getting Started with Docker](/databases/mysql/docker.mdx) guide.

View File

@ -204,3 +204,19 @@ schema.
- [Subscriptions](/subscriptions/overview.mdx) - [Subscriptions](/subscriptions/overview.mdx)
- [Event triggers](/event-triggers/overview.mdx) - [Event triggers](/event-triggers/overview.mdx)
## Managing data with the Hasura Console
The Hasura Console is a web UI that allows you to manage your data and metadata. It is available at
`http://localhost:8080/console` when you run Hasura locally, or from your project's Console endpoint when you use
[Hasura Cloud](https://cloud.hasura.io).
The data-management features (such as creating tables) are available in the `Data` tab. You can access your GraphQL API
in the `API` tab and interact with it using the GraphiQL interface.
:::info Console support
We recommend using your preferred Oracle client instead. The Hasura Console is designed to be a tool for managing
your GraphQL API, and not a full-fledged database management tool.
:::

View File

@ -127,7 +127,7 @@ import Clickhouse from '@site/static/img/databases/logos/clickhouse.png';
<div className="card"> <div className="card">
<img src={MongoDB} style={{ width: '172px' }} title="MongoDB" alt="Connect MongoDB to Hasura" /> <img src={MongoDB} style={{ width: '172px' }} title="MongoDB" alt="Connect MongoDB to Hasura" />
</div> </div>
<h5>MongoDB (Beta)</h5> <h5>MongoDB</h5>
</div> </div>
</VersionedLink> </VersionedLink>
<VersionedLink to="/databases/clickhouse/index/"> <VersionedLink to="/databases/clickhouse/index/">

View File

@ -204,18 +204,36 @@ Curious about any other Postgres flavors? Any other questions? Ask us on
::: :::
## Managing data with the Hasura Console
The Hasura Console is a web UI that allows you to manage your data and metadata. It is available at
`http://localhost:8080/console` when you run Hasura locally, or from your project's Console endpoint when you use
[Hasura Cloud](https://cloud.hasura.io).
The data-management features (such as creating tables) are available in the `Data` tab. You can access your GraphQL API
in the `API` tab and interact with it using the GraphiQL interface.
:::info Console support
You can use these tools to manage your PostgreSQL database, but we recommend using your preferred
[PostgreSQL client instead](https://wiki.postgresql.org/wiki/PostgreSQL_Clients). The Hasura Console is designed to be a
tool for managing your GraphQL API, and not a full-fledged database management tool.
:::
## Required user role permissions ## Required user role permissions
Below are the role permissions required for Hasura to perform all its functionality. Note that, with the exception of `CONNECT` and `GRANT USAGE`, the other features are opt-in, and not enabling them will simply mean that only the corresponding Hasura features will not work. Below are the role permissions required for Hasura to perform all its functionality. Note that, with the exception of
`CONNECT` and `GRANT USAGE`, the other features are opt-in, and not enabling them will simply mean that only the
* `CONNECT` is required in order for Hasura to connect to your Postgres data source. corresponding Hasura features will not work.
* You must `GRANT USAGE` to the Hasura user role for any schema you want to access via Hasura.
* To allow queries and subscriptions via the GraphQL API, `SELECT` permissions are required.
* Similarly, `INSERT`, `UPDATE`, and `DELETE` permissions are required for mutations.
* The Hasura Console requires permissions such as `REFERENCES` and `CREATE` to make changes to your schema.
* `TRIGGER` is required to use [Event Triggers](/event-triggers/overview.mdx)
* If you want to use computed fields or user-defined Postgres functions, the `EXECUTE` permission is required.
- `CONNECT` is required in order for Hasura to connect to your Postgres data source.
- You must `GRANT USAGE` to the Hasura user role for any schema you want to access via Hasura.
- To allow queries and subscriptions via the GraphQL API, `SELECT` permissions are required.
- Similarly, `INSERT`, `UPDATE`, and `DELETE` permissions are required for mutations.
- The Hasura Console requires permissions such as `REFERENCES` and `CREATE` to make changes to your schema.
- `TRIGGER` is required to use [Event Triggers](/event-triggers/overview.mdx)
- If you want to use computed fields or user-defined Postgres functions, the `EXECUTE` permission is required.
## Know more ## Know more

View File

@ -198,6 +198,22 @@ Here are 2 ways you can get started with Hasura and Snowflake:
</div> </div>
## Managing data with the Hasura Console
The Hasura Console is a web UI that allows you to manage your data and metadata. It is available at
`http://localhost:8080/console` when you run Hasura locally, or from your project's Console endpoint when you use
[Hasura Cloud](https://cloud.hasura.io).
The data-management features (such as creating tables) are available in the `Data` tab. You can access your GraphQL API
in the `API` tab and interact with it using the GraphiQL interface.
:::info Console support
We recommend using your preferred Snowflake client instead. The Hasura Console is designed to be a tool for managing
your GraphQL API, and not a full-fledged database management tool.
:::
## Keep up to date ## Keep up to date
:::info Note :::info Note