caliban
API
Generated with
caliban/caliban/Configurator

Configurator

caliban.Configurator
object Configurator

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class ExecutionConfiguration(skipValidation: Boolean, enableIntrospection: Boolean, allowMutationsOverGetRequests: Boolean, queryExecution: QueryExecution, validations: List[QueryValidation], queryCache: UIO[Cache])

Configuration for the execution of a GraphQL query.

Configuration for the execution of a GraphQL query.

Value parameters

allowMutationsOverGetRequests

if true, mutations are allowed for GET requests. Note that this is highly discouraged as it goes against the recommended practices. Default: false.

enableIntrospection

if true, introspection queries are allowed. Default: true.

queryCache

An effect used to create a zio.query.Cache to use with zio.query.DataSource-backed ZQueries. The effect will be run for each query execution to create a new cache, so ensure that any side-effects are properly captured in the provided effect. Default: The default empty cache implementation from zio-query

queryExecution

the execution strategy to use (sequential, parallel, batched). Default: parallel.

skipValidation

if true, the query will not be validated (in that case, the validations field is ignored). Default: false.

validations

the validations to run on the query during the validation phase. Default: all available validations.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Concrete methods

def setAllowMutationsOverGetRequests(allow: Boolean): URIO[Scope, Unit]

Enable or disable mutations for GET requests. See ExecutionConfiguration for more details

Enable or disable mutations for GET requests. See ExecutionConfiguration for more details

Attributes

def setEnableIntrospection(enable: Boolean): URIO[Scope, Unit]

Enable or disable introspection queries.

Enable or disable introspection queries.

Value parameters

enable

if true, introspection queries are allowed.

Attributes

def setQueryCache(mkCache: UIO[Cache]): URIO[Scope, Unit]

Sets an effect which will be used to create a new ZQuery zio.query.Cache for each query execution. This allows customizing the initial cache parameters or providing a custom implementation.

Sets an effect which will be used to create a new ZQuery zio.query.Cache for each query execution. This allows customizing the initial cache parameters or providing a custom implementation.

Attributes

See also

ExecutionConfiguration for more details

def setQueryExecution(queryExecution: QueryExecution): URIO[Scope, Unit]

Set the execution strategy to use (sequential, parallel, batched).

Set the execution strategy to use (sequential, parallel, batched).

Value parameters

queryExecution

the execution strategy to use.

Attributes

def setSkipValidation(skip: Boolean): URIO[Scope, Unit]

Skip validation of the query.

Skip validation of the query.

Value parameters

skip

if true, the query will not be validated (in that case, the validations field is ignored).

Attributes

def setValidations(validations: List[QueryValidation]): URIO[Scope, Unit]

Set the validations to run on the query during the validation phase.

Set the validations to run on the query during the validation phase.

Value parameters

validations

the validations to run on the query during the validation phase.

Attributes

Generated with