Skip to content

Commit 2d2c5ee

Browse files
author
Jacob Foster
committed
Adding query optimization
1 parent 0588f89 commit 2d2c5ee

File tree

3 files changed

+89
-1
lines changed

3 files changed

+89
-1
lines changed

graphene_django/filter/fields.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# from graphene.relay import is_node
55
from graphene.types.argument import to_arguments
66
from ..fields import DjangoConnectionField
7+
from ..optimization import optimize_queryset
78
from .utils import get_filtering_args_from_filterset, get_filterset_class
89

910

@@ -75,6 +76,7 @@ def connection_resolver(cls, resolver, connection, default_manager, max_limit,
7576
data=filter_kwargs,
7677
queryset=default_manager.get_queryset()
7778
).qs
79+
qs = optimize_queryset(default_manager.model, qs, info.field_asts[0])
7880

7981
return super(DjangoFilterConnectionField, cls).connection_resolver(
8082
resolver,

graphene_django/optimization.py

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
from collections import namedtuple
2+
3+
from django.db.models import ForeignKey
4+
from django.db.models.fields.reverse_related import ForeignObjectRel
5+
from graphene.utils.str_converters import to_snake_case
6+
7+
from .registry import get_global_registry
8+
from .utils import get_related_model
9+
10+
REGISTRY = get_global_registry()
11+
SELECT = 'select'
12+
PREFETCH = 'prefetch'
13+
RelatedSelection = namedtuple('RelatedSelection', ['name', 'fetch_type'])
14+
15+
16+
def model_fields_as_dict(model):
17+
return dict((f.name, f) for f in model._meta.get_fields())
18+
19+
20+
def get_related_fetches_for_model(model, graphql_ast):
21+
model_fields = model_fields_as_dict(model)
22+
selections = graphql_ast.selection_set.selections
23+
24+
graphene_obj_type = REGISTRY.get_type_for_model(model)
25+
optimizations = {}
26+
if graphene_obj_type and graphene_obj_type._meta.optimizations:
27+
optimizations = graphene_obj_type._meta.optimizations
28+
29+
relateds = []
30+
31+
for selection in selections:
32+
selection_name = to_snake_case(selection.name.value)
33+
selection_field = model_fields.get(selection_name, None)
34+
35+
try:
36+
related_model = get_related_model(selection_field)
37+
except:
38+
# This is not a ForeignKey or Relation, check manual optimizations
39+
manual_optimizations = optimizations.get(selection_name)
40+
if manual_optimizations:
41+
for manual_select in manual_optimizations.get(SELECT, []):
42+
relateds.append(RelatedSelection(manual_select, SELECT))
43+
for manual_prefetch in manual_optimizations.get(PREFETCH, []):
44+
relateds.append(RelatedSelection(manual_prefetch, PREFETCH))
45+
46+
continue
47+
48+
query_name = selection_field.name
49+
if isinstance(selection_field, ForeignObjectRel):
50+
query_name = selection_field.field.related_query_name()
51+
52+
nested_relateds = get_related_fetches_for_model(related_model, selection)
53+
54+
related_type = PREFETCH # default to prefetch, it's safer
55+
if isinstance(selection_field, ForeignKey):
56+
related_type = SELECT # we can only select for ForeignKeys
57+
58+
if nested_relateds:
59+
for related in nested_relateds:
60+
full_name = '{0}__{1}'.format(query_name, related.name)
61+
62+
nested_related_type = PREFETCH
63+
if related_type == SELECT and related.fetch_type == SELECT:
64+
nested_related_type = related_type
65+
66+
relateds.append(RelatedSelection(full_name, nested_related_type))
67+
else:
68+
relateds.append(RelatedSelection(query_name, related_type))
69+
70+
return relateds
71+
72+
73+
def optimize_queryset(model, queryset, graphql_ast):
74+
relateds = get_related_fetches_for_model(model, graphql_ast)
75+
76+
for related in relateds:
77+
if related.fetch_type == SELECT:
78+
queryset = queryset.select_related(related.name)
79+
else:
80+
queryset = queryset.prefetch_related(related.name)
81+
82+
return queryset

graphene_django/types.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
from graphene.utils.is_base_type import is_base_type
1111

1212
from .converter import convert_django_field_with_choices
13+
from .optimization import optimize_queryset
1314
from .registry import Registry, get_global_registry
1415
from .utils import (DJANGO_FILTER_INSTALLED, get_model_fields,
1516
is_valid_django_model)
@@ -55,6 +56,7 @@ def __new__(cls, name, bases, attrs):
5556
only_fields=(),
5657
exclude_fields=(),
5758
interfaces=(),
59+
optimizations=None,
5860
skip_registry=False,
5961
registry=None
6062
)
@@ -118,7 +120,9 @@ def is_type_of(cls, root, context, info):
118120

119121
@classmethod
120122
def get_node(cls, id, context, info):
123+
query = cls._meta.model._meta.default_manager
124+
query = optimize_queryset(cls._meta.model, query, info.field_asts[0])
121125
try:
122-
return cls._meta.model.objects.get(pk=id)
126+
return query.get(pk=id)
123127
except cls._meta.model.DoesNotExist:
124128
return None

0 commit comments

Comments
 (0)