hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-09-11 10:46:25 +03:00
Code Issues Projects Releases Wiki Activity

docs: add note for downgrading catalog version

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9957
GitOrigin-RevId: 2449dc2aa2ed2550e1ba9738b6c795082b07cc8f
This commit is contained in:
Rob Dominguez 2023-07-26 12:01:53 -05:00 committed by hasura-bot
parent 37726b088c
commit 62aff83ccd
1 changed files with 29 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/docs/deployment/downgrading.mdx
View File

@ -24,23 +24,23 @@ downgrade the GraphQL Engine version you're running:
- [Updating on Kubernetes](/deployment/deployment-guides/kubernetes.mdx#kubernetes-update)
If the GraphQL Engine version you are downgrading to has a different
catalogue version than your current, you will have to downgrade the
catalogue to the corresponding version manually as described below.
catalog version than your current, you will have to downgrade the
catalog to the corresponding version manually as described below.
## Step 2: Downgrade Hasura catalogue version
## Step 2: Downgrade Hasura catalog version
The Hasura GraphQL Engine maintains its Metadata state in a "catalogue"
The Hasura GraphQL Engine maintains its Metadata state in a "catalog"
as described [here](/migrations-metadata-seeds/metadata-format.mdx). The schema of the
catalogue is versioned. Updates to the Hasura GraphQL Engine may have
Hasura catalogue version bumps.
catalog is versioned. Updates to the Hasura GraphQL Engine may have
Hasura catalog version bumps.
Downgrades to the catalogue need to be carried out manually in case you
Downgrades to the catalog need to be carried out manually in case you
are attempting to downgrade to a lower Hasura GraphQL Engine version.
From `v1.2.0`, you can downgrade the catalogue from a particular version
From `v1.2.0`, you can downgrade the catalog from a particular version
to a previous version by executing the `graphql-engine` executable on
the command line, with the `downgrade` command, specifying the desired
catalogue version using one of the `--to-` flags. For earlier versions,
catalog version using one of the `--to-` flags. For earlier versions,
it is recommended to first upgrade to the latest version and then use
the `downgrade` command to downgrade to the desired version.
@ -65,7 +65,7 @@ single transaction.
Running this command while Hasura GraphQL Engine is running might lead
to unexpected results. It is recommended to first bring down any running
Hasura GraphQL Engine instances before downgrading the catalogue
Hasura GraphQL Engine instances before downgrading the catalog
:::
@ -75,3 +75,22 @@ You can downgrade a Hasura GraphQL Engine v2 instance to v1 only if
there is only one database connected to it.
:::
:::tip Issues with downgrading the catalog version?
Please note that downgrading the Hasura catalog version is unavailable from `v2.12.1` onward. We apologize for the inconvenience
and are working to restore this feature as soon as possible. In the meantime, should you need to execute the migration manually,
you can utilize the following SQL on your Metadata database:
```sql
ALTER TABLE hdb_catalog.hdb_version
DROP COLUMN ee_client_id,
DROP COLUMN ee_client_secret;
INSERT INTO hdb_catalog.hdb_version (version) VALUES (47)
ON CONFLICT ((version IS NOT NULL))
DO UPDATE SET version = 47;
```
This will downgrade your Hasura instance from catalog version 48 to version 47, which was introduced in `v2.0.7`.
:::