Skip to content

Commit

Permalink
Add connector response size limit (#400)
Browse files Browse the repository at this point in the history
Co-authored-by: Sean Park-Ross <[email protected]>
  • Loading branch information
rakeshkky and seanparkross authored May 17, 2024
1 parent 5fc2f04 commit 5e1e351
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/connectors/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ import Link from "@docusaurus/Link";
title: "Learn more about connectors.",
href: "/connectors/introduction/",
},
{
title: "Know connector response size limits.",
href: "/connectors/response-size-limit/",
},
]}
intro={
<div>
Expand Down Expand Up @@ -183,5 +187,5 @@ what's coming up on the roadmap.
</div>
<h5>ClickHouse</h5>
</div>
</Link>
</Link>
</div>
44 changes: 44 additions & 0 deletions docs/connectors/response-size-limit.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
sidebar_position: 10
sidebar_label: Response Size Limit
description: "Hasura rejects responses from a connector when their size exceeds a certain limit"
keywords:
- size limit
- response size limit
- connector response
seoFrontMatterUpdated: true
---

# Connector Response Size Limit

The maximum size for responses from connectors is **30 MB**. Beyond this threshold, Hasura will reject the
response to ensure optimum performance and data processing. It's important to be mindful of this constraint when making
data queries to Hasura's [GraphQL API](/graphql-api/overview/).

To prevent hitting the response size limit, API consumers are encouraged to utilize the
[limit argument](/graphql-api/queries/pagination#limit-results) in their queries to avoid over-fetching data from
sources via data connectors.

When GraphQL API requests exceed this size limit, they will result in an
[internal error](/graphql-api/errors#internal-errors) API response.

```json
{
"data": null,
"errors": [
{
"message": "internal error"
}
]
}
```

Hasura users are advised to check the traces for more detailed error information, which includes the actual response
size from the connector.

:::note Response size limit increases

If you require an increase in the response size limit, please reach out to [Hasura support](https://hasura.io/help/) for
assistance.

:::
4 changes: 4 additions & 0 deletions docs/graphql-api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ import Icon from "@site/static/icons/graphql-logo.svg";
href: "https://hasura.io/connector",
title: "Visit the Connector Hub.",
},
{
href: "/connectors/response-size-limit/",
title: "Learn about connector response size limits.",
},
]}
/>

Expand Down

0 comments on commit 5e1e351

Please sign in to comment.