Merge branch 'master' of github.com:expedock/strawberry-sqlalchemy-mapper

Author: raguiar2

README.md

@@ -6,14 +6,12 @@ Strawberry-sqlalchemy-mapper is the simplest way to implement autogenerated stra
 
 - Instead of manually listing every column and relationship in a SQLAlchemy model, strawberry-sqlalchemy-mapper
 lets you decorate a class declaration and it will automatically generate the necessary strawberry fields
-for all columns and relationships in the given model.
+for all columns and relationships (subject to the limitations below) in the given model.
 
 - Native support for most of SQLAlchemy's most common types.
-
 - Extensible to arbitrary custom SQLAlchemy types.
-
+- Automatic batching of queries, avoiding N+1 queries when getting relationships
 - Support for SQLAlchemy >=1.4.x
-
 - Lightweight and fast.
 
 ## Getting Started
@@ -31,6 +29,7 @@ class Employee(Base):
     __tablename__ = 'employee'
     id = Column(UUID, primary_key=True)
     name = Column(String, nullable=False)
+    password_hash = Column(String, nullable=False)
 ```
 
 Next, decorate a type with `strawberry_sqlalchemy_mapper.type()`
@@ -43,13 +42,71 @@ and hybrid properties. For example:
 strawberry_sqlalchemy_mapper = StrawberrySQLAlchemyMapper()
 @strawberry_sqlalchemy_mapper.type(models.Employee)
 class Employee:
+    __exclude__ = ["password_hash"]
+
+
+# context is expected to have an instance of StrawberrySQLAlchemyLoader
+class CustomGraphQLView(GraphQLView):
+    def get_context(self):
+        return {
+            "sqlalchemy_loader": StrawberrySQLAlchemyLoader(),
+        }
+
+# call finalize() before using the schema:
+strawberry_sqlalchemy_mapper.finalize()
+# only needed if you have polymorphic types
+additional_types = list(strawberry_sqlalchemy_mapper.mapped_types.values())
+schema = strawberry.Schema(
+    query=Query,
+    mutation=Mutation,
+    extensions=extensions,
+    types=additional_types,
+)
+```
+
+Roots of polymorphic hierarchies are also expected to be registered via
+`strawberry_sqlalchemy_mapper.interface()`, and its concrete type and
+its descendants are expected to inherit from the interface:
+
+```python
+class Book(Model):
+    id = Column(UUID, primary_key=True)
+
+class Novel(Book):
+    pass
+
+class ShortStory(Book):
+    pass
+
+
+# in another file
+strawberry_sqlalchemy_mapper = StrawberrySQLAlchemyMapper()
+
+@strawberry_sqlalchemy_mapper.interface(models.Book)
+class BookInterface:
+    pass
+
+@strawberry_sqlalchemy_mapper.type(models.Book)
+class Book:
+    pass
+
+@strawberry_sqlalchemy_mapper.type(models.Novel)
+class Novel:
+    pass
+
+@strawberry_sqlalchemy_mapper.type(models.ShortStory)
+class ShortStory:
     pass
 ```
 
 Several examples to help you get started are provided in the `examples` directory.
 
 ## Limitations
 
+SQLAlchemy Models -> Strawberry Types and Interfaces are expected to have a consistent
+(customizable) naming convention. These can be configured by passing `model_to_type_name`
+and `model_to_interface_name` when constructing the mapper.
+
 Natively supports the following SQLAlchemy types:
 
 ```python