Fields API Reference¶

This section provides detailed API documentation for GraphQL field classes in graphene-django-extras.

DjangoObjectField¶

A GraphQL field for querying a single Django model object by ID.

class DjangoObjectField(Field)

Parameters¶

Parameter	Type	Description
`_type`	`DjangoObjectType`	The GraphQL type representing the Django model
`*args`	`Any`	Additional positional arguments passed to base Field
`**kwargs`	`Any`	Additional keyword arguments passed to base Field

Attributes¶

Attribute	Type	Description
`model`	`Model`	The Django model class associated with this field

Methods¶

`object_resolver(manager, root, info, **kwargs)`¶

Static method that resolves a single object by its ID.

Parameters: - manager (Manager): Django model manager - root (Any): Parent object in GraphQL resolution - info (ResolveInfo): GraphQL resolve info - **kwargs: Query arguments including id

Returns: Model instance or None if not found

`wrap_resolve(parent_resolver)`¶

Wraps the resolver with the object resolver functionality.

Parameters: - parent_resolver (Callable): Parent resolver function

Returns: Wrapped resolver function

Example Usage¶

import graphene
from graphene_django_extras import DjangoObjectField, DjangoObjectType
from .models import User

class UserType(DjangoObjectType):
    class Meta:
        model = User

class Query(graphene.ObjectType):
    user = DjangoObjectField(UserType, description="Get a single user")

schema = graphene.Schema(query=Query)

GraphQL Query¶

query GetUser($id: ID!) {
  user(id: $id) {
    id
    username
    email
  }
}

DjangoListField¶

A basic GraphQL field for querying a list of Django model objects.

class DjangoListField(DjangoListField)

Parameters¶

Parameter	Type	Description
`_type`	`DjangoObjectType`	The GraphQL type representing the Django model
`*args`	`Any`	Additional positional arguments
`**kwargs`	`Any`	Additional keyword arguments

Properties¶

Property	Type	Description
`type`	`Field`	Returns the GraphQL field type

Example Usage¶

from graphene_django_extras import DjangoListField

class Query(graphene.ObjectType):
    users = DjangoListField(UserType)

DjangoFilterListField¶

A GraphQL field for querying a filtered list of Django model objects.

class DjangoFilterListField(Field)

Parameters¶

Parameter	Type	Default	Description
`_type`	`DjangoObjectType`	Required	The GraphQL type
`fields`	`dict`	`None`	Filter field configuration
`extra_filter_meta`	`dict`	`None`	Additional filter metadata
`filterset_class`	`FilterSet`	`None`	Custom FilterSet class
`*args`	`Any`	-	Additional positional arguments
`**kwargs`	`Any`	-	Additional keyword arguments

Attributes¶

Attribute	Type	Description
`model`	`Model`	The Django model class
`fields`	`dict`	Filter field configuration
`filterset_class`	`FilterSet`	The FilterSet class used for filtering
`filtering_args`	`dict`	GraphQL arguments generated from FilterSet

Methods¶

`list_resolver(manager, filterset_class, filtering_args, root, info, **kwargs)`¶

Static method that resolves a filtered list of objects.

Parameters: - manager (Manager): Django model manager - filterset_class (FilterSet): FilterSet class for filtering - filtering_args (dict): Available filtering arguments - root (Any): Parent object in GraphQL resolution - info (ResolveInfo): GraphQL resolve info - **kwargs: Query arguments including filters

Returns: Filtered QuerySet

Example Usage¶

from graphene_django_extras import DjangoFilterListField

class Query(graphene.ObjectType):
    users = DjangoFilterListField(
        UserType,
        filterset_class=UserFilterSet,
        description="Filtered list of users"
    )

GraphQL Query¶

query GetFilteredUsers {
  users(username_Icontains: "john", isActive: true) {
    id
    username
    email
    isActive
  }
}

DjangoFilterPaginateListField¶

A GraphQL field for querying a filtered and paginated list of Django model objects.

class DjangoFilterPaginateListField(Field)

Parameters¶

Parameter	Type	Default	Description
`_type`	`DjangoObjectType`	Required	The GraphQL type
`pagination`	`BaseDjangoGraphqlPagination`	Default pagination	Pagination configuration
`fields`	`dict`	`None`	Filter field configuration
`extra_filter_meta`	`dict`	`None`	Additional filter metadata
`filterset_class`	`FilterSet`	`None`	Custom FilterSet class
`*args`	`Any`	-	Additional positional arguments
`**kwargs`	`Any`	-	Additional keyword arguments

Attributes¶

Attribute	Type	Description
`model`	`Model`	The Django model class
`fields`	`dict`	Filter field configuration
`filterset_class`	`FilterSet`	The FilterSet class used for filtering
`filtering_args`	`dict`	GraphQL arguments generated from FilterSet
`pagination`	`BaseDjangoGraphqlPagination`	Pagination instance

Methods¶

`get_queryset(manager, root, info, **kwargs)`¶

Get the base queryset for this field.

Parameters: - manager (Manager): Django model manager - root (Any): Parent object - info (ResolveInfo): GraphQL resolve info - **kwargs: Query arguments

Returns: Base QuerySet

`list_resolver(manager, filterset_class, filtering_args, root, info, **kwargs)`¶

Resolve a filtered and paginated list of objects.

Parameters: - manager (Manager): Django model manager - filterset_class (FilterSet): FilterSet class for filtering - filtering_args (dict): Available filtering arguments - root (Any): Parent object - info (ResolveInfo): GraphQL resolve info - **kwargs: Query arguments including filters and pagination

Returns: Paginated QuerySet

Example Usage¶

from graphene_django_extras import (
    DjangoFilterPaginateListField,
    LimitOffsetGraphqlPagination
)

class Query(graphene.ObjectType):
    users = DjangoFilterPaginateListField(
        UserType,
        pagination=LimitOffsetGraphqlPagination(default_limit=20),
        description="Paginated and filtered list of users"
    )

GraphQL Query¶

query GetPaginatedUsers {
  users(
    username_Icontains: "john",
    isActive: true,
    limit: 10,
    offset: 20
  ) {
    id
    username
    email
    isActive
  }
}

DjangoListObjectField¶

A GraphQL field for Django list objects that returns both count and results.

class DjangoListObjectField(Field)

Parameters¶

Parameter	Type	Default	Description
`_type`	`DjangoListObjectType`	Required	The GraphQL list type
`fields`	`dict`	`None`	Filter field configuration
`extra_filter_meta`	`dict`	`None`	Additional filter metadata
`filterset_class`	`FilterSet`	`None`	Custom FilterSet class
`*args`	`Any`	-	Additional positional arguments
`**kwargs`	`Any`	-	Additional keyword arguments

Attributes¶

Attribute	Type	Description
`model`	`Model`	The Django model class
`fields`	`dict`	Filter field configuration
`filterset_class`	`FilterSet`	The FilterSet class used for filtering
`filtering_args`	`dict`	GraphQL arguments generated from FilterSet

Methods¶

`list_resolver(manager, filterset_class, filtering_args, root, info, **kwargs)`¶

Resolve a list object with count and results.

Parameters: - manager (Manager): Django model manager - filterset_class (FilterSet): FilterSet class for filtering - filtering_args (dict): Available filtering arguments - root (Any): Parent object - info (ResolveInfo): GraphQL resolve info - **kwargs: Query arguments including filters

Returns: DjangoListObjectBase with count and results

Example Usage¶

from graphene_django_extras import DjangoListObjectField, DjangoListObjectType

class UserListType(DjangoListObjectType):
    class Meta:
        model = User
        pagination = LimitOffsetGraphqlPagination(default_limit=25)

class Query(graphene.ObjectType):
    all_users = DjangoListObjectField(
        UserListType,
        description="All users with count and pagination"
    )

GraphQL Query¶

query GetUserList {
  allUsers(limit: 10, offset: 0) {
    count
    results {
      id
      username
      email
    }
  }
}

Response Structure¶

{
  "data": {
    "allUsers": {
      "count": 150,
      "results": [
        {
          "id": "1",
          "username": "user1",
          "email": "user1@example.com"
        }
      ]
    }
  }
}

Field Configuration Examples¶

Basic Field Setup¶

import graphene
from graphene_django_extras import (
    DjangoObjectField,
    DjangoFilterListField,
    DjangoFilterPaginateListField,
    DjangoListObjectField
)

class Query(graphene.ObjectType):
    # Single object
    user = DjangoObjectField(UserType)

    # Simple filtered list
    users = DjangoFilterListField(UserType)

    # Filtered and paginated list
    users_paginated = DjangoFilterPaginateListField(UserType)

    # List object with count
    all_users = DjangoListObjectField(UserListType)

Advanced Field Configuration¶

from .filtersets import UserFilterSet
from .paginations import CustomPagination

class Query(graphene.ObjectType):
    # Custom filtered list
    staff_users = DjangoFilterListField(
        UserType,
        filterset_class=UserFilterSet,
        description="Filtered list of staff users"
    )

    # Custom paginated list
    paginated_users = DjangoFilterPaginateListField(
        UserType,
        pagination=CustomPagination(default_limit=50),
        filterset_class=UserFilterSet,
        description="Custom paginated user list"
    )

    # Custom resolver
    active_users = DjangoFilterListField(UserType)

    def resolve_active_users(self, info, **kwargs):
        return User.objects.filter(is_active=True)

Error Handling¶

class Query(graphene.ObjectType):
    user = DjangoObjectField(UserType)

    def resolve_user(self, info, **kwargs):
        try:
            return User.objects.get(id=kwargs.get('id'))
        except User.DoesNotExist:
            return None  # Will return null in GraphQL response

Best Practices¶

Field Best Practices

Use Appropriate Fields: Choose the right field type for your use case
Add Descriptions: Always provide meaningful descriptions for your fields
Configure Filtering: Set up proper filter configurations for list fields
Handle Errors: Implement proper error handling in custom resolvers
Optimize Queries: Use select_related and prefetch_related for performance
Limit Results: Always configure reasonable pagination limits

Performance Optimization¶

class UserListType(DjangoListObjectType):
    class Meta:
        model = User
        pagination = LimitOffsetGraphqlPagination(default_limit=25)

    @classmethod
    def get_queryset(cls, queryset, info):
        return queryset.select_related('profile').prefetch_related('posts')

class Query(graphene.ObjectType):
    users = DjangoListObjectField(UserListType)

This API reference provides comprehensive documentation for all field classes in graphene-django-extras, enabling developers to effectively use and customize GraphQL fields for their Django applications.

Fields API Reference¶

DjangoObjectField¶

Parameters¶

Attributes¶

Methods¶

object_resolver(manager, root, info, **kwargs)¶

wrap_resolve(parent_resolver)¶

Example Usage¶

GraphQL Query¶

DjangoListField¶

Parameters¶

Properties¶

Example Usage¶

DjangoFilterListField¶

Parameters¶

Attributes¶

Methods¶

list_resolver(manager, filterset_class, filtering_args, root, info, **kwargs)¶

Example Usage¶

GraphQL Query¶

DjangoFilterPaginateListField¶

Parameters¶

Attributes¶

Methods¶

get_queryset(manager, root, info, **kwargs)¶

list_resolver(manager, filterset_class, filtering_args, root, info, **kwargs)¶

Example Usage¶

GraphQL Query¶

DjangoListObjectField¶

Parameters¶

Attributes¶

Methods¶

list_resolver(manager, filterset_class, filtering_args, root, info, **kwargs)¶

Example Usage¶

GraphQL Query¶

Response Structure¶

Field Configuration Examples¶

Basic Field Setup¶

Advanced Field Configuration¶

Error Handling¶

Best Practices¶

Performance Optimization¶

`object_resolver(manager, root, info, **kwargs)`¶

`wrap_resolve(parent_resolver)`¶

`list_resolver(manager, filterset_class, filtering_args, root, info, **kwargs)`¶

`get_queryset(manager, root, info, **kwargs)`¶

`list_resolver(manager, filterset_class, filtering_args, root, info, **kwargs)`¶

`list_resolver(manager, filterset_class, filtering_args, root, info, **kwargs)`¶