Sort is added by default to the connectionField

Author: CaselIT

examples/flask_sqlalchemy/schema.py

@@ -34,10 +34,13 @@ class Meta:
 
 class Query(graphene.ObjectType):
     node = relay.Node.Field()
+    # Supports sorting only over one field
     all_employees = SQLAlchemyConnectionField(Employee, sort=graphene.Argument(SortEnumEmployee,
             default_value=utils.EnumValue('id_asc', EmployeeModel.id.asc())))
-    all_roles = SQLAlchemyConnectionField(Role, sort=utils.sort_argument_for_model(RoleModel))
-    all_departments = SQLAlchemyConnectionField(Department)
+    # Add sort over multiple fields, sorting by default over the primary key
+    all_roles = SQLAlchemyConnectionField(Role)
+    # Disable sorting over this field
+    all_departments = SQLAlchemyConnectionField(Department, sort=None)
 
 
 schema = graphene.Schema(query=Query, types=[Department, Employee, Role])

graphene_sqlalchemy/fields.py

@@ -6,10 +6,10 @@
 from graphene.relay.connection import PageInfo
 from graphql_relay.connection.arrayconnection import connection_from_list_slice
 
-from .utils import get_query
+from .utils import get_query, sort_argument_for_model
 
 
-class SQLAlchemyConnectionField(ConnectionField):
+class _UnsortedSQLAlchemyConnectionField(ConnectionField):
 
     @property
     def model(self):
@@ -62,7 +62,17 @@ def get_resolver(self, parent_resolver):
         return partial(self.connection_resolver, parent_resolver, self.type, self.model)
 
 
-__connectionFactory = SQLAlchemyConnectionField
+class SQLAlchemyConnectionField(_UnsortedSQLAlchemyConnectionField):
+
+    def __init__(self, type, *args, **kwargs):
+        if 'sort' not in kwargs:
+            kwargs.setdefault('sort', sort_argument_for_model(type._meta.model))
+        elif kwargs['sort'] is None:
+            del kwargs['sort']
+        super(SQLAlchemyConnectionField, self).__init__(type, *args, **kwargs)
+
+
+__connectionFactory = _UnsortedSQLAlchemyConnectionField
 
 
 def createConnectionField(_type):
@@ -76,4 +86,4 @@ def registerConnectionFieldFactory(factoryMethod):
 
 def unregisterConnectionFieldFactory():
     global __connectionFactory
-    __connectionFactory = SQLAlchemyConnectionField
+    __connectionFactory = _UnsortedSQLAlchemyConnectionField

graphene_sqlalchemy/tests/test_converter.py

@@ -16,7 +16,7 @@
 from ..converter import (convert_sqlalchemy_column,
                          convert_sqlalchemy_composite,
                          convert_sqlalchemy_relationship)
-from ..fields import SQLAlchemyConnectionField
+from ..fields import _UnsortedSQLAlchemyConnectionField
 from ..registry import Registry
 from ..types import SQLAlchemyObjectType
 from .models import Article, Pet, Reporter
@@ -205,7 +205,7 @@ class Meta:
 
     dynamic_field = convert_sqlalchemy_relationship(Reporter.pets.property, A._meta.registry)
     assert isinstance(dynamic_field, graphene.Dynamic)
-    assert isinstance(dynamic_field.get_type(), SQLAlchemyConnectionField)
+    assert isinstance(dynamic_field.get_type(), _UnsortedSQLAlchemyConnectionField)
 
 
 def test_should_manytoone_convert_connectionorlist():