Skip to content

Django Settings

Certain features of this library are configured using custom Django settings.

STRAWBERRY_DJANGO

A dictionary with the following optional keys:

  • FIELD_DESCRIPTION_FROM_HELP_TEXT (default: False)

    If True, GraphQL field's description will be fetched from the corresponding Django model field's help_text attribute. If a description is provided using field customization, that description will be used instead.

  • TYPE_DESCRIPTION_FROM_MODEL_DOCSTRING (default: False)

    If True, GraphQL type descriptions will be fetched from the corresponding Django model's docstring. If a description is provided using the strawberry_django.type decorator, that description will be used instead.

  • MUTATIONS_DEFAULT_ARGUMENT_NAME (default: "data")

    Change the CUD mutations' default argument name when no option is passed (e.g. to "input")

  • MUTATIONS_DEFAULT_HANDLE_ERRORS (default: False)

    Set the default behaviour of the Django Errors Handling when no option is passed.

  • GENERATE_ENUMS_FROM_CHOICES (default: False)

    If True, fields with choices will have automatically generate an enum of possibilities instead of being exposed as String. A better option is to use Django's TextChoices/IntegerChoices with the django-choices-field integration.

  • MAP_AUTO_ID_AS_GLOBAL_ID (default: False)

    If True, auto fields that refer to model ids will be mapped to relay.GlobalID instead of strawberry.ID. This is mostly useful if all your model types inherit from relay.Node and you want to work only with GlobalID.

  • DEFAULT_PK_FIELD_NAME (default: "pk")

    Change the CRUD mutations' default primary key field.

  • USE_DEPRECATED_FILTERS (default: False)

    If True, legacy filters are enabled. This is usefull for migrating from previous version.

These features can be enabled by adding this code to your settings.py file.

settings.py
1
2
3
4
5
6
7
8
9
STRAWBERRY_DJANGO = {
    "FIELD_DESCRIPTION_FROM_HELP_TEXT": True,
    "TYPE_DESCRIPTION_FROM_MODEL_DOCSTRING": True,
    "MUTATIONS_DEFAULT_ARGUMENT_NAME": "input",
    "MUTATIONS_DEFAULT_HANDLE_ERRORS": True,
    "GENERATE_ENUMS_FROM_CHOICES": False,
    "MAP_AUTO_ID_AS_GLOBAL_ID": True,
    "DEFAULT_PK_FIELD_NAME": "id",
}