mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-18 13:02:11 +03:00
123 lines
2.3 KiB
ReStructuredText
123 lines
2.3 KiB
ReStructuredText
.. meta::
|
|
:description: Manage databases with the Hasura metadata API
|
|
:keywords: hasura, docs, metadata API, API reference, database, source
|
|
|
|
.. _metadata_api_sources:
|
|
|
|
Metadata API Reference: Databases (v2.0 and above)
|
|
==================================================
|
|
|
|
.. contents:: Table of contents
|
|
:backlinks: none
|
|
:depth: 1
|
|
:local:
|
|
|
|
Introduction
|
|
------------
|
|
|
|
Add/remove databases in Hasura GraphQL engine.
|
|
|
|
.. admonition:: Supported from
|
|
|
|
The metadata API is supported for versions ``v2.0.0`` and above and replaces the older
|
|
:ref:`schema/metadata API <schema_metadata_apis>`.
|
|
|
|
.. _pg_add_source:
|
|
|
|
pg_add_source
|
|
-------------
|
|
|
|
``pg_add_source`` is used to connect a Postgres database to Hasura.
|
|
|
|
Add a database with name ``pg1``:
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/metadata HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type": "pg_add_source",
|
|
"args": {
|
|
"name": "pg1",
|
|
"configuration": {
|
|
"connection_info": {
|
|
"database_url": {
|
|
"from_env": "<DB_URL_ENV_VAR>"
|
|
},
|
|
"pool_settings": {
|
|
"max_connections": 50,
|
|
"idle_timeout": 180,
|
|
"retries": 1
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
.. _pg_add_source_syntax:
|
|
|
|
Args syntax
|
|
^^^^^^^^^^^
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - name
|
|
- true
|
|
- :ref:`SourceName <SourceName>`
|
|
- Name of the Postgres database
|
|
* - configuration
|
|
- true
|
|
- :ref:`PGConfiguration <PGConfiguration>`
|
|
- Database connection configuration
|
|
* - replace_configuration
|
|
- false
|
|
- Boolean
|
|
- If set to ``true`` the configuration will be replaced if the source with
|
|
given name already exists (default: ``false``)
|
|
|
|
.. _pg_drop_source:
|
|
|
|
pg_drop_source
|
|
--------------
|
|
|
|
``pg_drop_source`` is used to remove a Postgres database from Hasura.
|
|
|
|
Remove a database with name ``pg1``:
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/metadata HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type": "pg_drop_source",
|
|
"args": {
|
|
"name": "pg1"
|
|
}
|
|
}
|
|
|
|
.. _pg_drop_source_syntax:
|
|
|
|
Args syntax
|
|
^^^^^^^^^^^
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - name
|
|
- true
|
|
- :ref:`SourceName <SourceName>`
|
|
- Name of the Postgres database
|