Made other documentation compatible with v2

Author: CaselIT

docs/examples.rst

@@ -3,22 +3,32 @@ Schema Examples
 
 
 Search all Models with Union
------------------
+----------------------------
 
 .. code:: python
 
     class Book(SQLAlchemyObjectType):
         class Meta:
             model = BookModel
             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)
@@ -29,8 +39,8 @@ Search all Models with Union
         search = graphene.List(SearchResult, q=graphene.String())  # List field for search results
         
         # Normal Fields
-        all_books = SQLAlchemyConnectionField(Book)
-        all_authors = SQLAlchemyConnectionField(Author)
+        all_books = SQLAlchemyConnectionField(BookConnection)
+        all_authors = SQLAlchemyConnectionField(AuthorConnection)
 
         def resolve_search(self, info, **args):
             q = args.get("q")  # Search query
@@ -47,13 +57,13 @@ Search all Models with Union
             # Query Authors
             authors = author_query.filter(AuthorModel.name.contains(q)).all()
 
-        return authors + books  # Combine lists
+            return authors + books  # Combine lists
 
     schema = graphene.Schema(query=Query, types=[Book, Author, SearchResult])
     
 Example GraphQL query
 
-.. code:: GraphQL
+.. code::
 
     book(id: "Qm9vazow") {
         id

docs/tutorial.rst

@@ -102,15 +102,28 @@ 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()
-        all_employees = SQLAlchemyConnectionField(Employee)
+        # Allows sorting over multiple columns, by default over the primary key
+        all_employees = SQLAlchemyConnectionField(EmployeeConnection)
+        # Disable sorting over this field
+        all_departments = SQLAlchemyConnectionField(DepartmentConnection, sort=None)
 
     schema = graphene.Schema(query=Query)
 

examples/flask_sqlalchemy/schema.py

@@ -7,40 +7,54 @@
 
 
 class Department(SQLAlchemyObjectType):
-
     class Meta:
         model = DepartmentModel
         interfaces = (relay.Node, )
 
 
-class Employee(SQLAlchemyObjectType):
+class DepartmentConnection(relay.Connection):
+    class Meta:
+        node = Department
 
+
+class Employee(SQLAlchemyObjectType):
     class Meta:
         model = EmployeeModel
         interfaces = (relay.Node, )
 
 
-class Role(SQLAlchemyObjectType):
+class EmployeeConnection(relay.Connection):
+    class Meta:
+        node = Employee
+
 
+class Role(SQLAlchemyObjectType):
     class Meta:
         model = RoleModel
         interfaces = (relay.Node, )
 
 
-SortEnumEmployee = utils.sort_enum_for_model(
-    EmployeeModel, 'SortEnumEmployee',
+class RoleConnection(relay.Connection):
+    class Meta:
+        node = Role
+
+
+SortEnumEmployee = utils.sort_enum_for_model(EmployeeModel, 'SortEnumEmployee',
     lambda c, d: c.upper() + ('_ASC' if d else '_DESC'))
 
 
 class Query(graphene.ObjectType):
     node = relay.Node.Field()
     # Allow only single column sorting
-    all_employees = SQLAlchemyConnectionField(Employee, sort=graphene.Argument(SortEnumEmployee,
+    all_employees = SQLAlchemyConnectionField(
+        EmployeeConnection,
+        sort=graphene.Argument(
+            SortEnumEmployee,
             default_value=utils.EnumValue('id_asc', EmployeeModel.id.asc())))
-    # Add sort over multiple columns, sorting by default over the primary key
-    all_roles = SQLAlchemyConnectionField(Role)
+    # Allows sorting over multiple columns, by default over the primary key
+    all_roles = SQLAlchemyConnectionField(RoleConnection)
     # Disable sorting over this field
-    all_departments = SQLAlchemyConnectionField(Department, sort=None)
+    all_departments = SQLAlchemyConnectionField(DepartmentConnection, sort=None)
 
 
 schema = graphene.Schema(query=Query, types=[Department, Employee, Role])