Repository navigation
Add database handle for sync database access #419
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
bjester
merged 6 commits into
learningequality:db-handle-365
from
srikar-naidu:sync-database-handle-365
Nov 10, 2026
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
984f435
Add explicit database handle for sync access
srikar-naidu 75988a6
Address sync database handle review
srikar-naidu 16b6853
Apply Ruff formatting to sync database helper
srikar-naidu f4131c7
Address sync database documentation and test review
srikar-naidu 8940331
Identify legacy instances by their original UUID
srikar-naidu fb59b94
Revert "Identify legacy instances by their original UUID"
srikar-naidu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,101 @@ | ||
| import logging | ||
| from contextlib import contextmanager | ||
| from threading import local | ||
|
|
||
| from django.db import connection | ||
| from django.db import connections | ||
| from django.db import DEFAULT_DB_ALIAS | ||
| from django.db import transaction | ||
| from django.db.models import F | ||
|
|
||
| from morango.models.core import InstanceIDModel | ||
| from morango.sync.backends.utils import load_backend | ||
| from morango.sync.utils import lock_partitions | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
| class SyncDatabase: | ||
| """Database access for sync, with routed ORM access when no alias is supplied.""" | ||
|
|
||
| def __init__(self, alias=None): | ||
| self.alias = alias | ||
| self._backends = local() | ||
|
|
||
| @classmethod | ||
| def default(cls): | ||
| return cls() | ||
|
|
||
| @property | ||
| def connection(self): | ||
| alias = DEFAULT_DB_ALIAS if self.alias is None else self.alias | ||
| return connections[alias] | ||
|
|
||
| @property | ||
| def backend(self): | ||
| if self.alias is None: | ||
| return DBBackend | ||
|
|
||
| conn = self.connection | ||
| backend = getattr(self._backends, "backend", None) | ||
| if backend is None or backend.connection is not conn: | ||
| backend = self._backends.backend = load_backend(conn) | ||
| return backend | ||
|
|
||
| def manager(self, model): | ||
| manager = model._default_manager | ||
| if self.alias is None: | ||
| return manager | ||
| return manager.db_manager(self.alias) | ||
|
|
||
| def atomic(self, savepoint=True): | ||
| return transaction.atomic(using=self.connection.alias, savepoint=savepoint) | ||
|
|
||
| @contextmanager | ||
| def begin_transaction(self, sync_filter, isolated=False, shared_lock=False): | ||
| """ | ||
| Start a transaction and lock the affected partitions. | ||
|
|
||
| :param sync_filter: The sync filter, or None to lock all partitions | ||
| :type sync_filter: morango.models.certificates.Filter | None | ||
| :param isolated: Whether to set repeatable-read isolation for the transaction | ||
| :param shared_lock: Whether to acquire shared rather than exclusive locks | ||
| """ | ||
| if isolated: | ||
| with self.backend._set_transaction_repeatable_read(): | ||
| with self.atomic(savepoint=False): | ||
| lock_partitions(self.backend, sync_filter=sync_filter, shared=shared_lock) | ||
| yield | ||
| else: | ||
| with self.atomic(): | ||
| lock_partitions(self.backend, sync_filter=sync_filter, shared=shared_lock) | ||
| yield | ||
|
|
||
| def cursor(self): | ||
| return self.connection.cursor() | ||
|
|
||
| def current_instance_and_increment_counter(self): | ||
| """Increment the current instance, which must already exist on a pinned alias.""" | ||
| if self.alias is None: | ||
| return InstanceIDModel.get_current_instance_and_increment_counter() | ||
|
|
||
| with self.atomic(): | ||
| instances = self.manager(InstanceIDModel) | ||
| instance = instances.get(current=True) | ||
| instances.filter(pk=instance.pk).update(counter=F("counter") + 1) | ||
| instance.refresh_from_db(using=self.alias, fields=["counter"]) | ||
| return instance | ||
|
|
||
|
|
||
| # Django's default connection proxy resolves the connection on the calling thread. | ||
| DBBackend = load_backend(connection) | ||
| _default = SyncDatabase.default() | ||
|
|
||
|
|
||
| @contextmanager | ||
| def begin_transaction(sync_filter, isolated=False, shared_lock=False): | ||
| """ | ||
| Starts a transaction, sets the transaction isolation level to repeatable read, and locks | ||
| affected partitions | ||
|
|
||
| :param sync_filter: The filter for filtering applicable records of the sync | ||
| :type sync_filter: morango.models.certificates.Filter|None | ||
| :param isolated: Whether to alter the transaction isolation to repeatable-read | ||
| :type isolated: bool | ||
| :param shared_lock: Whether the advisory lock should be exclusive or shared | ||
| :type shared_lock: bool | ||
| Start a sync transaction on the default database and lock affected partitions. | ||
|
|
||
| :param sync_filter: The sync filter, or None to lock all partitions | ||
| :type sync_filter: morango.models.certificates.Filter | None | ||
| :param isolated: Whether to set repeatable-read isolation for the transaction | ||
| :param shared_lock: Whether to acquire shared rather than exclusive locks | ||
| """ | ||
| if isolated: | ||
| # when isolation is requested, we modify the transaction isolation of the connection for the | ||
| # duration of the transaction | ||
| with DBBackend._set_transaction_repeatable_read(): | ||
| with transaction.atomic(savepoint=False): | ||
| lock_partitions(DBBackend, sync_filter=sync_filter, shared=shared_lock) | ||
| yield | ||
| else: | ||
| with transaction.atomic(): | ||
| lock_partitions(DBBackend, sync_filter=sync_filter, shared=shared_lock) | ||
| yield | ||
| return _default.begin_transaction(sync_filter, isolated=isolated, shared_lock=shared_lock) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.