Struct QueryPlannerConfig

pub struct QueryPlannerConfig {
    pub incremental_delivery: Option<IncrementalDeliverySupport>,
    pub graphql_validation: bool,
    pub reuse_query_fragments: Option<bool>,
    pub generate_query_fragments: Option<bool>,
    pub debug: Option<QueryPlannerDebugConfig>,
    pub type_conditioned_fetching: bool,
}

Query planner configuration

Fields

incremental_delivery: Option<IncrementalDeliverySupport>

Option for @defer directive support

graphql_validation: bool

Whether to validate GraphQL schema and query text

reuse_query_fragments: Option<bool>

Whether the query planner should try to reused the named fragments of the planned query in subgraph fetches.

This is often a good idea as it can prevent very large subgraph queries in some cases (named fragments can make some relatively small queries (using said fragments) expand to a very large query if all the spreads are inline). However, due to architecture of the query planner, this optimization is done as an additional pass on the subgraph queries of the generated plan and can thus increase the latency of building a plan. As long as query plans are sufficiently cached, this should not be a problem, which is why this option is enabled by default, but if the distribution of inbound queries prevents efficient caching of query plans, this may become an undesirable trade-off and can be disabled in that case.

Defaults to true in the JS query planner. Defaults to None here in order to defer to the JS query planner’s default.

generate_query_fragments: Option<bool>

If enabled, the query planner will extract inline fragments into fragment definitions before sending queries to subgraphs. This can significantly reduce the size of the query sent to subgraphs, but may increase the time it takes to plan the query.

debug: Option<QueryPlannerDebugConfig>

A sub-set of configurations that are meant for debugging or testing. All the configurations in this sub-set are provided without guarantees of stability (they may be dangerous) or continued support (they may be removed without warning).

type_conditioned_fetching: bool

Enables type conditioned fetching. This flag is a workaround, which may yield significant performance degradation when computing query plans, and increase query plan size.

If you aren’t aware of this flag, you probably don’t need it. Defaults to false.

Trait Implementations

impl Clone for QueryPlannerConfig

fn clone(&self) -> QueryPlannerConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryPlannerConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QueryPlannerConfig

fn default() -> Self

Returns the “default value” for a type.

impl Hash for QueryPlannerConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for QueryPlannerConfig

fn eq(&self, other: &QueryPlannerConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for QueryPlannerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for QueryPlannerConfig

impl StructuralPartialEq for QueryPlannerConfig