mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-14 17:02:49 +03:00
docs: misc fixes
https://github.com/hasura/graphql-engine-mono/pull/1969 GitOrigin-RevId: 755b0954cffc6d14fa04bca590318b8756037b4f
This commit is contained in:
parent
e48ccd7fab
commit
b713d9b13f
2
docs/_static/scripts/hdocs.js
vendored
2
docs/_static/scripts/hdocs.js
vendored
@ -10,7 +10,7 @@ window.hdocs = (function () {
|
||||
document.getElementById('nav_tree_icon').addEventListener('click', hdocs.handleNavClick);
|
||||
document.getElementById('sidebar-close').addEventListener('click', hdocs.handleNavClick);
|
||||
|
||||
document.getElementById('close-banner').addEventListener('click', hdocs.closeBanner);
|
||||
// document.getElementById('close-banner').addEventListener('click', hdocs.closeBanner);
|
||||
|
||||
// document.getElementById('thumb_up_button').addEventListener('click', function () { hdocs.sendFeedback('positive', 'Great to hear that! If you have any other feedback, please share here:') });
|
||||
// document.getElementById('thumb_down_button').addEventListener('click', function () { hdocs.sendFeedback('negative', 'Sorry to hear that. Please tell us what you were looking for:') });
|
||||
|
@ -15,7 +15,8 @@ Creating projects
|
||||
Introduction
|
||||
------------
|
||||
|
||||
You can create a new Hasura Cloud project with either a new Postgres database, or an existing Postgres database with a publicly available IP address.
|
||||
You can create a new Hasura Cloud project with either a new Postgres database, or an existing
|
||||
Postgres database with a publicly available IP address.
|
||||
|
||||
Step 1: Project setup
|
||||
---------------------
|
||||
@ -50,9 +51,12 @@ On the Hasura console, navigate to ``Data -> Manage -> Connect Database``:
|
||||
New database
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Hasura Cloud does not host databases, but does provide integrations with which you can create databases on managed cloud providers like Heroku. Integrations for AWS, GCP, and Azure are coming soon.
|
||||
Hasura Cloud does not host databases, but does provide integrations with which you can create databases on
|
||||
managed cloud providers like Heroku. Integrations for AWS, GCP, and Azure are coming soon.
|
||||
|
||||
To get started, choose ``Create Heroku Database -> Create Database``, and follow the prompts to authenticate with Heroku. Hasura Cloud will integrate with your Heroku account and manage the initial setup of a dev-tier Postgres instance. You can always upgrade the instance and manage options later through your Heroku account.
|
||||
To get started, choose ``Create Heroku Database -> Create Database``, and follow the prompts to authenticate
|
||||
with Heroku. Hasura Cloud will integrate with your Heroku account and manage the initial setup of a dev-tier
|
||||
Postgres instance. You can always upgrade the instance and manage options later through your Heroku account.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/project-new-database-setup.png
|
||||
:alt: database setup with new database
|
||||
@ -60,7 +64,8 @@ To get started, choose ``Create Heroku Database -> Create Database``, and follow
|
||||
|
||||
Existing database
|
||||
^^^^^^^^^^^^^^^^^
|
||||
To use an existing database, choose ``Connect existing database`` and enter your database connection URL and enter your database connection string (looks like ``postgres://username:password@hostname:port/dbname``).
|
||||
To use an existing database, choose ``Connect existing database`` and enter your database connection URL and
|
||||
enter your database connection string (looks like ``postgres://username:password@hostname:port/dbname``).
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/getting-started/connect-db.png
|
||||
:alt: database setup with existing database
|
||||
@ -77,7 +82,9 @@ To use an existing database, choose ``Connect existing database`` and enter your
|
||||
Allowing connections from Hasura Cloud IP
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
For some cloud services, like GCP, you'll need to adjust your Postgres connection settings to allow connections from the Hasura Cloud IP address. You can copy the IP address from the copy icon in the ``Hasura Cloud IP`` field on the project's details view. You may also need to disable SSL. Adding custom cert information to a Hasura Cloud instance is not yet available.
|
||||
For some cloud services, like GCP, you'll need to adjust your Postgres connection settings to allow connections from
|
||||
the Hasura Cloud IP address. You can copy the IP address from the copy icon in the ``Hasura Cloud IP`` field on the
|
||||
project's details view.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/hasura-cloud-ip.png
|
||||
:alt: Hasura Cloud IP field
|
||||
|
@ -28,7 +28,7 @@ Available APIs
|
||||
+----------------------------------+---------------------------------------------------+------------------+
|
||||
| Metadata *(> v2.0)* | :ref:`/v1/metadata <metadata_api>` | Admin only |
|
||||
+----------------------------------+---------------------------------------------------+------------------+
|
||||
| Schema/Metadata *(< v1.3)* | :ref:`/v1/query <schema_metadata_api>` | Admin only |
|
||||
| Schema/Metadata *(deprecated)* | :ref:`/v1/query <schema_metadata_api>` | Admin only |
|
||||
+----------------------------------+---------------------------------------------------+------------------+
|
||||
| Restified GQL | :ref:`/api/rest <restified_api>` | GQL REST Routes |
|
||||
+----------------------------------+---------------------------------------------------+------------------+
|
||||
@ -65,8 +65,8 @@ See details at :ref:`api_reference_relay_graphql`.
|
||||
|
||||
.. _schema_api:
|
||||
|
||||
Schema API (v2.0 and above)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Schema API
|
||||
^^^^^^^^^^
|
||||
|
||||
Hasura exposes a schema API for directly executing SQL on the underlying Postgres.
|
||||
|
||||
@ -76,8 +76,8 @@ See details at :ref:`schema_apis`.
|
||||
|
||||
.. _metadata_api:
|
||||
|
||||
Metadata API (v2.0 and above)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Metadata API
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Hasura exposes a metadata API for managing metadata.
|
||||
|
||||
@ -87,8 +87,8 @@ See details at :ref:`metadata_apis`.
|
||||
|
||||
.. _schema_metadata_api:
|
||||
|
||||
Schema / metadata API (v1.3 and below)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Schema / metadata API (Deprecated)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Hasura exposes a schema / metadata API for managing metadata for permissions/relationships or for directly
|
||||
executing SQL on the underlying Postgres.
|
||||
@ -163,9 +163,9 @@ See details at :ref:`explain_api_reference`.
|
||||
|
||||
GraphQL API <graphql-api/index>
|
||||
Relay GraphQL API <relay-graphql-api/index>
|
||||
Schema APIs (v2.0 and above) <schema-api/index>
|
||||
Metadata APIs (v2.0 and above) <metadata-api/index>
|
||||
Schema / Metadata APIs <schema-metadata-api/index>
|
||||
Schema APIs <schema-api/index>
|
||||
Metadata APIs <metadata-api/index>
|
||||
Schema / Metadata APIs (Deprecated) <schema-metadata-api/index>
|
||||
RESTified GraphQL Endpoints <restified>
|
||||
Version API <version>
|
||||
Health check API <health>
|
||||
|
@ -4,8 +4,8 @@
|
||||
|
||||
.. _metadata_apis:
|
||||
|
||||
Metadata API Reference (v2.0 and above)
|
||||
=======================================
|
||||
Metadata API Reference
|
||||
======================
|
||||
|
||||
.. contents:: Table of contents
|
||||
:backlinks: none
|
||||
|
@ -4,8 +4,8 @@
|
||||
|
||||
.. _schema_apis:
|
||||
|
||||
Schema API Reference (v2.0 and above)
|
||||
=====================================
|
||||
Schema API Reference
|
||||
====================
|
||||
|
||||
.. contents:: Table of contents
|
||||
:backlinks: none
|
||||
|
@ -4,8 +4,8 @@
|
||||
|
||||
.. _schema_metadata_apis:
|
||||
|
||||
Schema / Metadata API Reference
|
||||
===============================
|
||||
Schema / Metadata API Reference (Deprecated)
|
||||
============================================
|
||||
|
||||
.. contents:: Table of contents
|
||||
:backlinks: none
|
||||
|
@ -86,7 +86,7 @@ Creating a Service Account
|
||||
:width: 400px
|
||||
|
||||
|
||||
- Give it a name, and under roles, and grant these 3 roles: ``Bigquery Metadata Viewer``, ``BigQuery Data Viewer`` and ``BigQuery Job User``.
|
||||
- Give it a name, and under roles, and grant these 3 roles: ``BigQuery Metadata Viewer``, ``BigQuery Data Viewer`` and ``BigQuery Job User``.
|
||||
|
||||
.. thumbnail:: /img/graphql/core/databases/bigquery/2-service-account-details.png
|
||||
:alt: Add source
|
||||
|
@ -4,8 +4,8 @@
|
||||
|
||||
.. _database_citus-hyperscale-postgres:
|
||||
|
||||
Citus - Hyperscale (Postgres flavour)
|
||||
=====================================
|
||||
Citus / Hyperscale
|
||||
==================
|
||||
|
||||
.. contents:: Table of contents
|
||||
:backlinks: none
|
||||
|
@ -208,6 +208,12 @@ in our table.
|
||||
See the :ref:`query <graphql_api_query>` and :ref:`mutation <graphql_api_mutation>`
|
||||
API references for the full specifications.
|
||||
|
||||
GraphQL types documentation
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Hasura automatically picks up any comments that might have been added to your tables
|
||||
and columns and adds them as GraphQL descriptions of the auto-generated types and fields.
|
||||
|
||||
Try out basic GraphQL requests
|
||||
------------------------------
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user