graphQL

Refer to graphene-python tutorial

SqlAlchemy에서 선언한 table을 사용하여 graphQL을 구현 함. - graphene_sqlalchemy를 설치 해야함.

세션 연결

SqlAlchemy 에서 사용한 내용 그대로 사용 가능. Model query 를 이용하여 query 를 수행하기 때문에 해당 부분에 대한 선언이 필요함.

import cx_Oracle
from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import scoped_session, sessionmaker

dsn = cx_Oracle.makedsn(host="{HOST}", port=${PORT}, sid=${SID})
engine = create_engine("oracle+cx_oracle://${user_id}:${user_pw}@%s" % str(dsn))
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)

Base = declarative_base()

# Below Parsts should be delcared in main or entry point!!
Base.metadata.create_all(bind=engine)
**#This part is for graphQL**
**Base.query = scoped_session(SessionLocal).query_property()** 

Schema

SqlAlchemy의 ORM 모델을 이용하여 representative model을 만들어 줌 (비지니스 모델).

Relay는 React 애플리케이션을 위한 데이터 관리 프레임워크. 각 컴포넌트마다 필요한 데이터를 선언하고, 컴포넌트의 계층 구조를 따라서 필요한 데이터를 상위 컴포넌트로 전달 및 조합하여 단일 GraphQL 쿼리로 만들어 줌.

(여러개의 query요청 시 원하는 output형태로 전달하기 위한 framework)

Node는 연결된 컴포넌트를 의미함. 즉 릴레이로 전달 할 때 다음 주자를 의미함.

from app.model.item import Item
from graphene import relay, String
from graphene_sqlalchemy import SQLAlchemyConnectionField, SQLAlchemyObjectType

class UserGqlModel(SQLAlchemyObjectType):
    class Meta:
        model = User
        interfaces = (relay.Node,)

class ItemGqlModel(SQLAlchemyObjectType):
    class Meta:
        model = Item
        interfaces = (relay.Node,)

Query

SELECT or GET

db에 대한 전체 조회는 아래와 같이 all_users or all_items를 통해 접근 가능

만약 족건이 있는 조회의 경우 resolve를 이용해서 구현 해야 함.

import graphene
from app.model.user import User
from app.model.item import Item
from graphene import relay, String
from graphene_sqlalchemy import SQLAlchemyConnectionField, SQLAlchemyObjectType
from app.graph_ql.gql_model import UserGqlModel, ItemGqlModel
import logging
import os

logger = logging.getLogger(os.environ.get("PROJECT"))

class Query(graphene.ObjectType):
    node = relay.Node.Field()

    user = SQLAlchemyConnectionField(UserGqlModel.connection, name=String())
    all_users = SQLAlchemyConnectionField(UserGqlModel.connection)
    all_items = SQLAlchemyConnectionField(ItemGqlModel.connection)

    def resolve_user(self, info, **kwargs):
        name = kwargs.get("name")
        logger.info("resolve_user")
        logger.info("name : %s" % name)

        if name is not None:
            return UserGqlModel.get_query(info).filter_by(name=name)

아래와 같이 graphQL을 요청 하면 "user" interface를 이용하여 user table의 email과 join된 item 테이블의 architeture항목만 가져옴.( 😮)

query {
  user(name:"MinHeeKim") {
    edges {
      node {
        **email**
        item {
           **architecutre**
        }
      }
    }
  }
}

Mutation

INSERT, UPDATE, DELETE or POST, PUT, PATCH, DELETE

각 behavior에 대한 mutation을 정의해서 사용함. 아래는 creation에 대해당되며, update, delete역시 비슷하게 사용 가능.

Arguement class 는 입력받을 field에 정의하고, 그 아래 어떤식의 return받을지를 정의함.

mutate 함수에서 실제 DB 를 통해 수행되는 기능을 작성하고 위에 정의한 return field 를 반환 한다.

Mutaion class 통해 해당 class 와 연결 시켜줌.

from graphene import String, Mutation, Int, Boolean, Field
import graphene
from app.graph_ql.gql_model import UserGqlModel
from app.model.user import User
from app.repository.sql_session import SessionLocal
import logging
import os

logger = logging.getLogger(os.environ.get("PROJECT"))
db = SessionLocal()

class CreateUser(Mutation):
    # input parameters
    class Arguments:
        name = String(required=True)
        department = String()
        email = String()
        age = Int()
        phone = String()
        address = String()
        floor = Int()

    # return fields definition
    data = Field(User)
    success = Boolean()

    @staticmethod
    def mutate(self, info, **kwars):
        user = User(**kwars)

        db.add(user)
        db.commit()
        db.refresh(user)

        logger.info("mutation")

        return CreateUser(data=user, success=True)

class Mutation(graphene.ObjectType):
    logger.info("hello")
    create_user = CreateUser.Field()

아래와 같이 mutation을 요청하면 새로운 User 가 insert 되고 결과에 대한 result 와 User field중에서 name, department, age, email에 대한 값을 돌려줌.

mutation{
  createUser (
    name : "UJHan",
    department: "FrontEnd Service",
    age: 27,
    email: "[[email protected]](mailto:[email protected])",
    phone: "000-9999-8888",
    address: "Pankyo",
    floor:17
  ){
    success
    data{
        name
        department
        age
        email
  }
}

endpoint 연결

GraphQLApp으로query와 mutation을 연결 시켜준다.

...
# Add graphql endpoint
app.add_route(
    "/graph", GraphQLApp(schema=graphene.Schema(query=Query, mutation=Mutation))
)
...