[python] Flask-RESTful에서 데이터베이스 쿼리 튜닝 방법

30 Nov 2023

python

Flask-RESTful은 Flask 프레임워크의 확장 기능으로, 간단하고 효율적인 RESTful API를 구축할 수 있도록 도와줍니다. 데이터베이스를 사용하는 RESTful API를 개발할 때, 쿼리의 성능을 향상시키는 것은 매우 중요합니다. 이 글에서는 Flask-RESTful에서 데이터베이스 쿼리를 튜닝하는 방법에 대해 알아보겠습니다.

1. 인덱스 생성

데이터베이스 쿼리의 성능을 향상시키는 가장 기본적인 방법은 인덱스를 생성하는 것입니다. 인덱스는 테이블의 컬럼에 대한 검색을 빠르게 하는 데 도움을 줍니다. Flask-RESTful에서는 데이터베이스 스키마를 정의하는 SQLAlchemy를 많이 사용하므로, SQLAlchemy에서 제공하는 @index 데코레이터를 사용하여 인덱스를 생성할 수 있습니다.

from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

class User(db.Model):
    __tablename__ = 'users'

    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(50))
    email = db.Column(db.String(50))

    @db.index('idx_name')
    def index_name(cls):
        return cls.name

위의 코드에서 @db.index 데코레이터를 사용하여 name 컬럼에 대한 인덱스를 생성했습니다. 이렇게 인덱스를 생성하면 name 컬럼을 사용한 쿼리가 더 빠르게 실행될 수 있습니다.

2. 쿼리 최적화

Flask-RESTful에서 데이터베이스 쿼리를 최적화하는 또 다른 방법은 쿼리 튜닝을 수행하는 것입니다. SQLAlchemy에서는 쿼리 튜닝을 위한 다양한 기능을 제공합니다.

2.1. Lazy Loading 방지

관계형 데이터베이스에서의 Lazy Loading은 필요한 데이터만 실제로 로드하여 성능을 향상시키는 방법입니다. 하지만 많은 데이터를 로드해야 할 경우에는 오히려 성능 저하를 초래할 수 있습니다. 이럴 때는 SQLAlchemy의 joinedload를 사용하여 Eager Loading을 수행하여 필요한 모든 데이터를 한 번에 로드하는 것이 좋습니다.

from sqlalchemy.orm import joinedload

users = User.query.options(joinedload('name')).all()

2.2. 쿼리 결과 캐싱

쿼리 결과를 캐싱하여 나중에 같은 쿼리를 실행할 때 더 빠르게 데이터를 받아올 수 있습니다. SQLAlchemy는 메모리 캐시와 Redis, Memcached 등의 외부 캐시 시스템을 지원합니다.

from werkzeug.contrib.cache import SimpleCache

cache = SimpleCache()

def get_users():
    users = cache.get('users')
    if users is None:
        users = User.query.all()
        cache.set('users', users)
    return users

위의 코드에서는 SimpleCache를 사용하여 users 쿼리 결과를 캐싱하고 있습니다.

3. 쿼리 힌트 사용

데이터베이스 쿼리 실행 방식을 명시적으로 지정하여 성능을 개선할 수 있습니다. SQLAlchemy에서는 with_hint 메서드를 사용하여 데이터베이스 쿼리 힌트를 지정할 수 있습니다.

from sqlalchemy.dialects import postgresql

users = User.query.with_hint(User, 'USE INDEX (idx_name)', dialect_name='postgresql').all()

위의 코드에서는 idx_name 인덱스를 사용하는 것을 PostgreSQL 데이터베이스에게 지시하고 있습니다.

4. 쿼리 실행 계획 확인

SQLAlchemy는 쿼리 실행 계획을 확인할 수 있는 기능을 제공합니다. 이를 활용하여 쿼리의 성능을 분석하고 개선할 수 있습니다.

users = User.query.all()
print(users.statement.compile(compile_kwargs={"literal_binds": True}).string)

위의 코드에서는 users 쿼리의 실행 계획을 확인하는 방법을 보여줍니다.

결론

Flask-RESTful에서 데이터베이스 쿼리의 성능을 향상시키는 방법으로 인덱스 생성, 쿼리 최적화, 쿼리 힌트 사용, 쿼리 실행 계획 확인 등을 소개했습니다. 이러한 기법들을 활용하여 Flask-RESTful 애플리케이션의 성능을 향상시키는데 도움이 되길 바랍니다.