[documentation] Fix Connection patterns (#264)

Author: jnak

docs/examples.rst

@@ -13,22 +13,12 @@ Search all Models with Union
             interfaces = (relay.Node,)
 
 
-    class BookConnection(relay.Connection):
-        class Meta:
-            node = Book
-
-
     class Author(SQLAlchemyObjectType):
         class Meta:
             model = AuthorModel
             interfaces = (relay.Node,)
 
 
-    class AuthorConnection(relay.Connection):
-        class Meta:
-            node = Author
-
-
     class SearchResult(graphene.Union):
         class Meta:
             types = (Book, Author)
@@ -39,8 +29,8 @@ Search all Models with Union
         search = graphene.List(SearchResult, q=graphene.String())  # List field for search results
 
         # Normal Fields
-        all_books = SQLAlchemyConnectionField(BookConnection)
-        all_authors = SQLAlchemyConnectionField(AuthorConnection)
+        all_books = SQLAlchemyConnectionField(Book.connection)
+        all_authors = SQLAlchemyConnectionField(Author.connection)
 
         def resolve_search(self, info, **args):
             q = args.get("q")  # Search query

docs/tips.rst

@@ -50,13 +50,8 @@ Given the model
             model = Pet
 
 
-    class PetConnection(Connection):
-        class Meta:
-            node = PetNode
-
-
     class Query(ObjectType):
-        allPets = SQLAlchemyConnectionField(PetConnection)
+        allPets = SQLAlchemyConnectionField(PetNode.connection)
 
 some of the allowed queries are
 

docs/tutorial.rst

@@ -102,28 +102,18 @@ Create ``flask_sqlalchemy/schema.py`` and type the following:
             interfaces = (relay.Node, )
 
 
-    class DepartmentConnection(relay.Connection):
-        class Meta:
-            node = Department
-
-
     class Employee(SQLAlchemyObjectType):
         class Meta:
             model = EmployeeModel
             interfaces = (relay.Node, )
 
 
-    class EmployeeConnection(relay.Connection):
-        class Meta:
-            node = Employee
-
-
     class Query(graphene.ObjectType):
         node = relay.Node.Field()
         # Allows sorting over multiple columns, by default over the primary key
-        all_employees = SQLAlchemyConnectionField(EmployeeConnection)
+        all_employees = SQLAlchemyConnectionField(Employee.connection)
         # Disable sorting over this field
-        all_departments = SQLAlchemyConnectionField(DepartmentConnection, sort=None)
+        all_departments = SQLAlchemyConnectionField(Department.connection, sort=None)
 
     schema = graphene.Schema(query=Query)
 

examples/flask_sqlalchemy/schema.py

@@ -29,11 +29,11 @@ class Query(graphene.ObjectType):
     node = relay.Node.Field()
     # Allow only single column sorting
     all_employees = SQLAlchemyConnectionField(
-        Employee, sort=Employee.sort_argument())
+        Employee.connection, sort=Employee.sort_argument())
     # Allows sorting over multiple columns, by default over the primary key
-    all_roles = SQLAlchemyConnectionField(Role)
+    all_roles = SQLAlchemyConnectionField(Role.connection)
     # Disable sorting over this field
-    all_departments = SQLAlchemyConnectionField(Department, sort=None)
+    all_departments = SQLAlchemyConnectionField(Department.connection, sort=None)
 
 
-schema = graphene.Schema(query=Query, types=[Department, Employee, Role])
+schema = graphene.Schema(query=Query)

examples/nameko_sqlalchemy/README.md

@@ -46,7 +46,6 @@ Now the following command will setup the database, and start the server:
 
 ```bash
 ./run.sh
-
 ```
 
 Now head on over to postman and send POST request to:

examples/nameko_sqlalchemy/database.py

@@ -14,7 +14,7 @@ def init_db():
     # import all modules here that might define models so that
     # they will be registered properly on the metadata.  Otherwise
     # you will have to import them first before calling init_db()
-    from .models import Department, Employee, Role
+    from models import Department, Employee, Role
     Base.metadata.drop_all(bind=engine)
     Base.metadata.create_all(bind=engine)
 

examples/nameko_sqlalchemy/schema.py

@@ -8,31 +8,28 @@
 
 
 class Department(SQLAlchemyObjectType):
-
     class Meta:
         model = DepartmentModel
-        interfaces = (relay.Node, )
+        interfaces = (relay.Node,)
 
 
 class Employee(SQLAlchemyObjectType):
-
     class Meta:
         model = EmployeeModel
-        interfaces = (relay.Node, )
+        interfaces = (relay.Node,)
 
 
 class Role(SQLAlchemyObjectType):
-
     class Meta:
         model = RoleModel
-        interfaces = (relay.Node, )
+        interfaces = (relay.Node,)
 
 
 class Query(graphene.ObjectType):
     node = relay.Node.Field()
-    all_employees = SQLAlchemyConnectionField(Employee)
-    all_roles = SQLAlchemyConnectionField(Role)
+    all_employees = SQLAlchemyConnectionField(Employee.connection)
+    all_roles = SQLAlchemyConnectionField(Role.connection)
     role = graphene.Field(Role)
 
 
-schema = graphene.Schema(query=Query, types=[Department, Employee, Role])
+schema = graphene.Schema(query=Query)

graphene_sqlalchemy/tests/test_query.py

@@ -1,5 +1,5 @@
 import graphene
-from graphene.relay import Connection, Node
+from graphene.relay import Node
 
 from ..converter import convert_sqlalchemy_composite
 from ..fields import SQLAlchemyConnectionField
@@ -96,14 +96,10 @@ class Meta:
             model = Article
             interfaces = (Node,)
 
-    class ArticleConnection(Connection):
-        class Meta:
-            node = ArticleNode
-
     class Query(graphene.ObjectType):
         node = Node.Field()
         reporter = graphene.Field(ReporterNode)
-        all_articles = SQLAlchemyConnectionField(ArticleConnection)
+        all_articles = SQLAlchemyConnectionField(ArticleNode.connection)
 
         def resolve_reporter(self, _info):
             return session.query(Reporter).first()
@@ -230,13 +226,9 @@ class Meta:
             model = Editor
             interfaces = (Node,)
 
-    class EditorConnection(Connection):
-        class Meta:
-            node = EditorNode
-
     class Query(graphene.ObjectType):
         node = Node.Field()
-        all_editors = SQLAlchemyConnectionField(EditorConnection)
+        all_editors = SQLAlchemyConnectionField(EditorNode.connection)
 
     query = """
         query {

graphene_sqlalchemy/tests/test_sort_enums.py

@@ -2,7 +2,7 @@
 import sqlalchemy as sa
 
 from graphene import Argument, Enum, List, ObjectType, Schema
-from graphene.relay import Connection, Node
+from graphene.relay import Node
 
 from ..fields import SQLAlchemyConnectionField
 from ..types import SQLAlchemyObjectType
@@ -249,22 +249,18 @@ class Meta:
             model = Pet
             interfaces = (Node,)
 
-    class PetConnection(Connection):
-        class Meta:
-            node = PetNode
-
     class Query(ObjectType):
-        defaultSort = SQLAlchemyConnectionField(PetConnection)
-        nameSort = SQLAlchemyConnectionField(PetConnection)
-        multipleSort = SQLAlchemyConnectionField(PetConnection)
-        descSort = SQLAlchemyConnectionField(PetConnection)
+        defaultSort = SQLAlchemyConnectionField(PetNode.connection)
+        nameSort = SQLAlchemyConnectionField(PetNode.connection)
+        multipleSort = SQLAlchemyConnectionField(PetNode.connection)
+        descSort = SQLAlchemyConnectionField(PetNode.connection)
         singleColumnSort = SQLAlchemyConnectionField(
-            PetConnection, sort=Argument(PetNode.sort_enum())
+            PetNode.connection, sort=Argument(PetNode.sort_enum())
         )
         noDefaultSort = SQLAlchemyConnectionField(
-            PetConnection, sort=PetNode.sort_argument(has_default=False)
+            PetNode.connection, sort=PetNode.sort_argument(has_default=False)
         )
-        noSort = SQLAlchemyConnectionField(PetConnection, sort=None)
+        noSort = SQLAlchemyConnectionField(PetNode.connection, sort=None)
 
     query = """
         query sortTest {