strawberry.Schema
Constructor:
Default Schema to be to be used in a Strawberry application.
A GraphQL Schema class used to define the structure and configuration of GraphQL queries, mutations, and subscriptions.
This class allows the creation of a GraphQL schema by specifying the types for queries, mutations, and subscriptions, along with various configuration options such as directives, extensions, and scalar overrides.
Signature:
def __init__( self, query: Type, mutation: Type | None = None, subscription: Type | None = None, directives: Iterable[StrawberryDirective] = (), types: Iterable[Type | StrawberryType] = (), extensions: Iterable[Type[SchemaExtension] | SchemaExtension] = (), execution_context_class: Type[GraphQLExecutionContext] | None = None, config: StrawberryConfig | None = None, scalar_overrides: Dict[object, Type | ScalarWrapper | ScalarDefinition] | None = None, schema_directives: Iterable[object] = (),) -> None: ...Parameters:
-
query:The entry point for queries.
- Type
-
Type
-
mutation:The entry point for mutations.
- Type
-
Type | None - Default
-
None
-
subscription:The entry point for subscriptions.
- Type
-
Type | None - Default
-
None
-
directives:A list of operation directives that clients can use. The bult-in
@includeand@skipare included by default.- Type
-
Iterable[StrawberryDirective] - Default
-
()
-
types:A list of additional types that will be included in the schema.
- Type
-
Iterable[Type | StrawberryType] - Default
-
()
-
extensions:A list of Strawberry extensions.
- Type
-
Iterable[Type[SchemaExtension] | SchemaExtension] - Default
-
()
-
execution_context_class:The execution context class.
- Type
-
Type[GraphQLExecutionContext] | None - Default
-
None
-
config:The configuration for the schema.
- Type
-
StrawberryConfig | None - Default
-
None
-
scalar_overrides:A dictionary of overrides for scalars.
- Type
-
Dict[object, Type | ScalarWrapper | ScalarDefinition] | None - Default
-
None
-
schema_directives:A list of schema directives for the schema.
- Type
-
Iterable[object] - Default
-
()
Methods:
-
get_extensions
Signature:
def get_extensions(self, sync: bool = False) -> List[Type[SchemaExtension] | SchemaExtension]:...Parameters:
-
sync:- Type
-
bool - Default
-
False
-
-
get_type_by_name
Signature:
def get_type_by_name(self, name: str) -> StrawberryObjectDefinition | ScalarDefinition | EnumDefinition | StrawberryUnion | None:...Parameters:
-
name:- Type
-
str
-
-
get_field_for_type
Signature:
def get_field_for_type(self, field_name: str, type_name: str) -> StrawberryField | None:...Parameters:
-
field_name:- Type
-
str
-
type_name:- Type
-
str
-
-
get_directive_by_name
Signature:
def get_directive_by_name(self, graphql_name: str) -> StrawberryDirective | None:...Parameters:
-
graphql_name:- Type
-
str
-
-
get_fields
Signature:
def get_fields(self, type_definition: StrawberryObjectDefinition) -> List[StrawberryField]:...Parameters:
-
type_definition:- Type
-
StrawberryObjectDefinition
-
-
execute
Signature:
def execute(self,query: str | None,variable_values: Dict[str, Any] | None = None,context_value: Any | None = None,root_value: Any | None = None,operation_name: str | None = None,allowed_operation_types: Iterable[OperationType] | None = None,) -> ExecutionResult:...Parameters:
-
query:- Type
-
str | None
-
variable_values:- Type
-
Dict[str, Any] | None - Default
-
None
-
context_value:- Type
-
Any | None - Default
-
None
-
root_value:- Type
-
Any | None - Default
-
None
-
operation_name:- Type
-
str | None - Default
-
None
-
allowed_operation_types:- Type
-
Iterable[OperationType] | None - Default
-
None
-
-
execute_sync
Signature:
def execute_sync(self,query: str | None,variable_values: Dict[str, Any] | None = None,context_value: Any | None = None,root_value: Any | None = None,operation_name: str | None = None,allowed_operation_types: Iterable[OperationType] | None = None,) -> ExecutionResult:...Parameters:
-
query:- Type
-
str | None
-
variable_values:- Type
-
Dict[str, Any] | None - Default
-
None
-
context_value:- Type
-
Any | None - Default
-
None
-
root_value:- Type
-
Any | None - Default
-
None
-
operation_name:- Type
-
str | None - Default
-
None
-
allowed_operation_types:- Type
-
Iterable[OperationType] | None - Default
-
None
-
-
subscribe
Signature:
def subscribe(self,query: str,variable_values: Dict[str, Any] | None = None,context_value: Any | None = None,root_value: Any | None = None,operation_name: str | None = None,) -> AsyncIterator[GraphQLExecutionResult] | GraphQLExecutionResult:...Parameters:
-
query:- Type
-
str
-
variable_values:- Type
-
Dict[str, Any] | None - Default
-
None
-
context_value:- Type
-
Any | None - Default
-
None
-
root_value:- Type
-
Any | None - Default
-
None
-
operation_name:- Type
-
str | None - Default
-
None
-
-
as_str
Signature:
def as_str(self) -> str:... -
introspect
Return the introspection query result for the current schema.
Signature:
def introspect(self) -> Dict[str, Any]:...
Attributes:
-
query: -
mutation: -
subscription: -
extensions: -
execution_context_class: -
config: -
schema_converter: -
directives: -
schema_directives: