From c643b488ab1aa66b6c4cb2531d814c2fbb3a372a Mon Sep 17 00:00:00 2001 From: abernatskiy Date: Sun, 24 Mar 2024 02:25:04 +0900 Subject: [PATCH] Revert "PostGraphile support" This reverts commit 04c13b90d91c85946036ddb17619f11891372100. --- docs/cloud/overview.md | 4 ---- docs/cloud/resources/postgraphile.md | 15 --------------- docs/sdk/how-to-start/squid-from-scratch.mdx | 3 ++- docs/sdk/overview.mdx | 2 -- 4 files changed, 2 insertions(+), 22 deletions(-) delete mode 100644 docs/cloud/resources/postgraphile.md diff --git a/docs/cloud/overview.md b/docs/cloud/overview.md index a71c3b56..5251b0a5 100644 --- a/docs/cloud/overview.md +++ b/docs/cloud/overview.md @@ -24,10 +24,6 @@ Make sure to check our [best practices guide](/cloud/resources/best-practices) b Consider our [RPC proxy service](/cloud/resources/rpc-proxy) if your squid requires an endpoint. ::: -:::info -Squids that use [PostGraphile](https://www.graphile.org/postgraphile/) to serve their GraphQL APIs must be able to serve status queries. Visit the [PostGraphile support](/cloud/resources/postgraphile) page to learn more. -::: - ## 0. Install Squid CLI Follow [this guide](/squid-cli/installation), including the optional authentication steps. diff --git a/docs/cloud/resources/postgraphile.md b/docs/cloud/resources/postgraphile.md deleted file mode 100644 index 0fd2a51b..00000000 --- a/docs/cloud/resources/postgraphile.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -sidebar_position: 90 -title: PostGraphile support -description: Making your API compatible with the Cloud ---- - -# PostGraphile support - -Although Squid SDK ships with its own [GraphQL server](/sdk/resources/graphql-server), it is also possible to serve squid APIs using third-party tools like [PostGraphile](https://www.graphile.org/postgraphile/) and [Hasura](https://hasura.io). No special configuration is required when the squid is deployed locally; however, if you want to deploy it to Subsquid Cloud and take advantage of the monitoring capabilities, your squid must be able to serve `_squidStatus` queries. - -For PostGraphile you can do that by [extending the service with a plugin](https://github.com/subsquid-labs/squid-postgraphile-example/blob/f1fd1691eb59da2c9d57c475a71d0ed44cfed891/src/api.ts#L11). - -With this, your GraphQL server will require a separate entry point. We recommend that you create [an `sqd` command](https://github.com/subsquid-labs/squid-postgraphile-example/blob/f1fd1691eb59da2c9d57c475a71d0ed44cfed891/commands.json#L58) for that. Do not forget to [add it to your manifest](https://github.com/subsquid-labs/squid-postgraphile-example/blob/f1fd1691eb59da2c9d57c475a71d0ed44cfed891/squid.yaml#L15). - -Full example is available [here](https://github.com/subsquid-labs/squid-postgraphile-example/). diff --git a/docs/sdk/how-to-start/squid-from-scratch.mdx b/docs/sdk/how-to-start/squid-from-scratch.mdx index f3345a20..33e09b15 100644 --- a/docs/sdk/how-to-start/squid-from-scratch.mdx +++ b/docs/sdk/how-to-start/squid-from-scratch.mdx @@ -19,11 +19,12 @@ Suppose the task is to track transfers of USDT on Ethereum, then save the result * `@subsquid/evm-processor` - for retrieving Ethereum data * the triad of `@subsquid/typeorm-store`, `@subsquid/typeorm-codegen` and `@subsquid/typeorm-migration` - for saving data to PostgreSQL +* `@subsquid/graphql-server` We also assume the following choice of _optional_ packages: * `@subsquid/evm-typegen` - for decoding Ethereum data and useful constants such as event topic0 values -* `@subsquid/archive-registry` - for retrieving the URLs of [open private network](/subsquid-network/overview/#open-private-network) EVM [datasets](/subsquid-network/reference/evm-networks)* `@subsquid/graphql-server` +* `@subsquid/archive-registry` - for retrieving the URLs of [open private network](/subsquid-network/overview/#open-private-network) EVM [datasets](/subsquid-network/reference/evm-networks) To make the indexer, follow these steps: diff --git a/docs/sdk/overview.mdx b/docs/sdk/overview.mdx index cef54bc9..4da6157f 100644 --- a/docs/sdk/overview.mdx +++ b/docs/sdk/overview.mdx @@ -78,8 +78,6 @@ Squids that store their data in PostgreSQL can subsequently make it available as The [server](/sdk/resources/graphql-server) runs as a separate process. [Core API](/sdk/reference/openreader) is automatically derived from the database schema; it is possible to extend it with [custom queries](/sdk/resources/graphql-server/custom-resolvers) and [basic access control](/sdk/resources/graphql-server/authorization). -Keep in mind that `@subsquid/graphql-server` is not the only option for creating squid-based GraphQL APIs - you are free to use third-party tools like PostGraphile and Hasura. - ### Misc utilities ```mdx-code-block