From 6f17e0bbec2ca534819a5cb3b790081b6320b3ef Mon Sep 17 00:00:00 2001 From: Kamil Kisiela Date: Tue, 7 Feb 2023 17:19:57 +0100 Subject: [PATCH] Document schema:delete command (#1290) --- .../web/docs/src/pages/features/_meta.json | 1 + .../docs/src/pages/features/delete-schema.mdx | 53 +++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 packages/web/docs/src/pages/features/delete-schema.mdx diff --git a/packages/web/docs/src/pages/features/_meta.json b/packages/web/docs/src/pages/features/_meta.json index 734fcf46b..b523931a5 100644 --- a/packages/web/docs/src/pages/features/_meta.json +++ b/packages/web/docs/src/pages/features/_meta.json @@ -2,6 +2,7 @@ "tokens": "Managing Tokens", "publish-schema": "Publishing Schema", "checking-schema": "Checking Schema", + "delete-schema": "Deleting Schema", "registry-usage": "Using Registry", "monitoring": "Monitoring", "schema-history": "Schema and History", diff --git a/packages/web/docs/src/pages/features/delete-schema.mdx b/packages/web/docs/src/pages/features/delete-schema.mdx new file mode 100644 index 000000000..5cc3d7369 --- /dev/null +++ b/packages/web/docs/src/pages/features/delete-schema.mdx @@ -0,0 +1,53 @@ +import { Callout, PackageCmd } from '@theguild/components' + +# Deleting a schema + +In case you want to delete a schema (or a subgraph in case of Federation), you can do so by using +the `hive schema:delete` command. + +## Requirements + +- An active [token](./tokens) with "Read & Write" permissions to the Registry. +- Available only for Stitching and Federation projects + +### NPM + +Install [`@graphql-hive/cli`](https://www.npmjs.com/package/@graphql-hive/cli) package from NPM: + + + +### Linux / MacOS + +Install latest version: + +```bash +curl -sSL https://graphql-hive.com/install.sh | sh +``` + +Now, create a config file as `hive.json` and paste there your token: + +```json +{ + "token": "YOUR-TOKEN" +} +``` + + + Having a config file is not mandatory, you can use `--token YOUR-TOKEN` or an environment variable + called `HIVE_TOKEN` instead. + + +To delete a schema, use `hive schema:delete` command: + +```bash +hive schema:delete +``` + + + +You can also use `--dryRun` flag first to see what effect the command will have on the registry. + +In case you want to confirm deletion of the service without typing anything in the terminal, use +`--confirm` flag. + +