Files
edx-platform/common/djangoapps/util/db.py
2015-01-15 10:37:24 -05:00

60 lines
2.0 KiB
Python

"""
Utility functions related to databases.
"""
from functools import wraps
import random
from django.db import connection, transaction
MYSQL_MAX_INT = (2 ** 31) - 1
def commit_on_success_with_read_committed(func): # pylint: disable=invalid-name
"""
Decorator which executes the decorated function inside a transaction with isolation level set to READ COMMITTED.
If the function returns a response the transaction is committed and if the function raises an exception the
transaction is rolled back.
Raises TransactionManagementError if there are already more than 1 level of transactions open.
Note: This only works on MySQL.
"""
@wraps(func)
def wrapper(*args, **kwargs): # pylint: disable=missing-docstring
if connection.vendor == 'mysql':
# The isolation level cannot be changed while a transaction is in progress. So we close any existing one.
if connection.transaction_state:
if len(connection.transaction_state) == 1:
connection.commit()
# We can commit all open transactions. But it does not seem like a good idea.
elif len(connection.transaction_state) > 1:
raise transaction.TransactionManagementError('Cannot change isolation level. '
'More than 1 level of nested transactions.')
# This will set the transaction isolation level to READ COMMITTED for the next transaction.
cursor = connection.cursor()
cursor.execute("SET TRANSACTION ISOLATION LEVEL READ COMMITTED")
with transaction.commit_on_success():
return func(*args, **kwargs)
return wrapper
def generate_int_id(minimum=0, maximum=MYSQL_MAX_INT, used_ids=None):
"""
Return a unique integer in the range [minimum, maximum], inclusive.
"""
if used_ids is None:
used_ids = []
cid = random.randint(minimum, maximum)
while cid in used_ids:
cid = random.randint(minimum, maximum)
return cid