From 2ec2444ef38ac0134a0fa053e2a11255db0f38af Mon Sep 17 00:00:00 2001 From: pranshi06 <85474619+pranshi06@users.noreply.github.com> Date: Thu, 21 Mar 2024 19:10:10 +0530 Subject: [PATCH] docs: add automated persisted queries env var documentation PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10743 Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com> GitOrigin-RevId: d89ddaac566cfa88e21826706e0e9c2925b3a08a --- .../graphql-engine-flags/reference.mdx | 46 +++++++++++++++---- 1 file changed, 37 insertions(+), 9 deletions(-) diff --git a/docs/docs/deployment/graphql-engine-flags/reference.mdx b/docs/docs/deployment/graphql-engine-flags/reference.mdx index 78dc330ee5a..544e2fa44cb 100644 --- a/docs/docs/deployment/graphql-engine-flags/reference.mdx +++ b/docs/docs/deployment/graphql-engine-flags/reference.mdx @@ -387,17 +387,31 @@ subgraph in an Apollo supergraph. | **Default** | `false` | | **Supported in** | CE, Enterprise Edition, Cloud | -### Header Size Limit -Sets the maximum cumulative length of all headers in bytes. +### Enable Automated Persisted Queries + +Enables the [Automated Persisted Queries](https://www.apollographql.com/docs/apollo-server/performance/apq/) feature. + +| | | +| ------------------- | ------------------------------------------------ | +| **Flag** | `--enable-persisted-queries` | +| **Env var** | `HASURA_GRAPHQL_ENABLE_PERSISTED_QUERIES` | +| **Accepted values** | Boolean | +| **Default** | `false` | +| **Supported in** | Enterprise Edition | + +### Set Automated Persisted Queries TTL + +Sets the query TTL in the cache store for Automated Persisted Queries. + +| | | +| ------------------- | ------------------------------------------------ | +| **Flag** | `--persisted-queries-ttl` | +| **Env var** | `HASURA_GRAPHQL_PERSISTED_QUERIES_TTL` | +| **Accepted values** | Integer | +| **Default** | `5` (seconds) | +| **Supported in** | Enterprise Edition | -| | | -| ------------------- | ---------------------------------------- | -| **Flag** | `--max-total-header-length` | -| **Env var** | `HASURA_GRAPHQL_MAX_TOTAL_HEADER_LENGTH` | -| **Accepted values** | Integer | -| **Default** | `1024*1024` (1MB) | -| **Supported in** | CE, Enterprise Edition | ### Enable Error Log Level for Trigger Errors @@ -411,6 +425,7 @@ Sets the log-level as `error` for Trigger type error logs (Event Triggers, Sched | **Default** | `false` | | **Supported in** | CE, Enterprise Edition | + ### Enable Console Enable the Hasura Console (served by the server on `/` and `/console`). @@ -424,6 +439,19 @@ Enable the Hasura Console (served by the server on `/` and `/console`). | **Default** | **CE**, **Enterprise Edition**: `false`
**Cloud**: Console is always enabled | | **Supported in** | CE, Enterprise Edition | +### Header Size Limit + +Sets the maximum cumulative length of all headers in bytes. + +| | | +| ------------------- | ---------------------------------------- | +| **Flag** | `--max-total-header-length` | +| **Env var** | `HASURA_GRAPHQL_MAX_TOTAL_HEADER_LENGTH` | +| **Accepted values** | Integer | +| **Default** | `1024*1024` (1MB) | +| **Supported in** | CE, Enterprise Edition | + + ### Enable High-cardinality Labels for Metrics Enable high-cardinality labels for [Prometheus Metrics](/observability/enterprise-edition/prometheus/metrics.mdx).