CostEstimation
Type members
Classlikes
A directive that can be applied to both fields and types to flag them as targets for cost analysis. This allows a simple estimation to be applied which can be used to prevent overly expensive queries from being executed
A directive that can be applied to both fields and types to flag them as targets for cost analysis. This allows a simple estimation to be applied which can be used to prevent overly expensive queries from being executed
Value members
Concrete methods
Computes the estimated cost of executing the query using the provided function and compares it to
the maxCost parameter which determines the maximum allowable cost for a query.
Computes the estimated cost of executing the query using the provided function and compares it to
the maxCost parameter which determines the maximum allowable cost for a query.
- Value Params
- f
The field cost estimate function
- maxCost
The maximum allowable cost for executing a query
More powerful version of maxCost which allow you to also specify the error that is returned when the cost exceeds the maximum cost.
More powerful version of maxCost which allow you to also specify the error that is returned when the cost exceeds the maximum cost.
- Value Params
- error
A function that will be provided the total estimated cost and must return the error that will be returned
- f
The function used to evaluate the cost of a single field
- maxCost
The total cost allowed for any one query
More powerful version of maxCost which allows the field computation function to specify a function which returns an effectful computation for the cost of a field.
More powerful version of maxCost which allows the field computation function to specify a function which returns an effectful computation for the cost of a field.
- Value Params
- f
The function used to evaluate the cost of a single field returning an effect which will result in the field cost as a double
- maxCost
The total cost allowed for any one query
Computes the estimated cost of the query based on the provided field cost function and adds it as an extension to the GraphQLResponse. This is useful for tracking the overall cost of a query either when you are trying to dial in a correct heuristic or when you want to inform users of your graph how expensive their queries are.
Computes the estimated cost of the query based on the provided field cost function and adds it as an extension to the GraphQLResponse. This is useful for tracking the overall cost of a query either when you are trying to dial in a correct heuristic or when you want to inform users of your graph how expensive their queries are.
- See also
queryCostWith, queryCostZIO
Computes the estimated cost of the query based on the provided field cost function and passes it to the second function which can run an arbitrary side effect with the result.
Computes the estimated cost of the query based on the provided field cost function and passes it to the second function which can run an arbitrary side effect with the result.
- See also
queryCost
A more powerful version of queryCost which allows the field cost computation to return an effect instead of a plain value
when computing the cost estimate.
A more powerful version of queryCost which allows the field cost computation to return an effect instead of a plain value
when computing the cost estimate.
- Value Params
- f
The field cost estimate function
- See also
queryCostZIOWith for a more powerful version
A more powerful version of queryCostZIO that allows the total result of the query to be pushed into a separate effect. This is useful when you want to compute the cost of the query but you already have your own system for recording the cost.
A more powerful version of queryCostZIO that allows the total result of the query to be pushed into a separate effect. This is useful when you want to compute the cost of the query but you already have your own system for recording the cost.
- Value Params
- f
The field cost estimate function
- p
A function which receives the total estimated cost of executing the query and can
The most powerful version of queryCost that allows maximum freedom in how the wrapper is defined. The function accepts
a function that will take a Ref that can be used for book keeping to track the current cost of the query, and returns a wrapper.
Normally this wrapper is a validation wrapper because it should be run before execution for the purposes of cost estimation.
However, the API provides the flexibility to redefine that. The second parameter of the function will receive the final cost estimate of the query
as well as the current graphql response, it returns an effect that produces a potentially modified response.
The most powerful version of queryCost that allows maximum freedom in how the wrapper is defined. The function accepts
a function that will take a Ref that can be used for book keeping to track the current cost of the query, and returns a wrapper.
Normally this wrapper is a validation wrapper because it should be run before execution for the purposes of cost estimation.
However, the API provides the flexibility to redefine that. The second parameter of the function will receive the final cost estimate of the query
as well as the current graphql response, it returns an effect that produces a potentially modified response.
- Value Params
- costWrapper
User provided function that will result in a wrapper that may be used when computing the cost of a query
- p
The response transforming function which receives the cost estimate as well as the response value.
- See also
queryCostZIOWith, queryCostZIO, queryCost
Concrete fields
Computes field cost by examining the @cost directive. This can be used in conjunction with queryCost or maxCost
In order to compute the estimated cost of executing a query.
Computes field cost by examining the @cost directive. This can be used in conjunction with queryCost or maxCost
In order to compute the estimated cost of executing a query.
- Note
This will be executed before the actual resolvers are called, which allows you to stop potentially expensive queries from being run, but may also require more work on the developer part to determine the correct heuristic for estimating field cost.
Computes the estimated cost of the query based on the default cost estimation (backed by the @GQLCost directive) and adds it as an extension to the GraphQLResponse. This is useful for tracking the overall cost of a query either when you are trying to dial in a correct heuristic or when you want to inform users of your graph how expensive their queries are.
Computes the estimated cost of the query based on the default cost estimation (backed by the @GQLCost directive) and adds it as an extension to the GraphQLResponse. This is useful for tracking the overall cost of a query either when you are trying to dial in a correct heuristic or when you want to inform users of your graph how expensive their queries are.
- See also
queryCostWith, queryCostZIO