Skip to content

facade

django_spire.contrib.sync.django.storage.facade

logger = logging.getLogger(__name__) module-attribute

DjangoSyncStorage

Source code in django_spire/contrib/sync/django/storage/facade.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def __init__(
    self,
    models: list[type[SyncableMixin]],
    identity_field: str = 'id',
    batch_size_max: int = _BATCH_SIZE_MAX,
    checkpoint_store: CheckpointStore | None = None,
    deferred_foreign_keys: list[DeferredForeignKey] | None = None,
    record_reader: RecordReader | None = None,
    record_writer: RecordWriter | None = None,
    sequence_allocator: SequenceAllocator | None = None,
) -> None:
    self._checkpoint_store = checkpoint_store or DjangoCheckpointStore()

    self._record_reader = record_reader or DjangoRecordReader(
        models=models,
        identity_field=identity_field,
    )

    self._record_writer = record_writer or DjangoRecordWriter(
        models=models,
        identity_field=identity_field,
        batch_size_max=batch_size_max,
        deferred_foreign_keys=deferred_foreign_keys,
    )

    self._sequence_allocator = (
        sequence_allocator or
        SyncSequenceAllocator()
    )

clear_tombstones

Source code in django_spire/contrib/sync/django/storage/facade.py 
63
64
65
66
67
68
def clear_tombstones(
    self,
    model_label: str,
    keys: set[str],
) -> None:
    self._record_writer.clear_tombstones(model_label, keys)

delete_many

Source code in django_spire/contrib/sync/django/storage/facade.py 
70
71
72
73
74
75
76
77
78
79
80
def delete_many(
    self,
    model_label: str,
    deletes: dict[str, int],
    origin_node: str,
) -> None:
    self._record_writer.delete_many(
        model_label,
        deletes,
        origin_node,
    )

flush_deferred_backfill

Source code in django_spire/contrib/sync/django/storage/facade.py 
82
83
def flush_deferred_backfill(self) -> None:
    self._record_writer.flush_deferred_backfill()

get_after_keys

Source code in django_spire/contrib/sync/django/storage/facade.py 
85
86
def get_after_keys(self, peer_node_id: str) -> dict[str, Any]:
    return self._checkpoint_store.get_after_keys(peer_node_id)

get_changed_since

Source code in django_spire/contrib/sync/django/storage/facade.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def get_changed_since(
    self,
    model_label: str,
    sequence: int,
    peer_node_id: str,
    sequence_max: int | None = None,
    limit: int | None = None,
    after_key: str | None = None,
) -> dict[str, SyncRecord]:
    return self._record_reader.get_changed_since(
        model_label,
        sequence,
        peer_node_id,
        sequence_max=sequence_max,
        limit=limit,
        after_key=after_key,
    )

get_deletes_since

Source code in django_spire/contrib/sync/django/storage/facade.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
def get_deletes_since(
    self,
    model_label: str,
    sequence: int,
    peer_node_id: str,
    sequence_max: int | None = None,
) -> dict[str, int]:
    return self._record_reader.get_deletes_since(
        model_label,
        sequence,
        peer_node_id,
        sequence_max=sequence_max,
    )

get_checkpoint

Source code in django_spire/contrib/sync/django/storage/facade.py 
120
121
def get_checkpoint(self, peer_node_id: str) -> CheckpointPosition:
    return self._checkpoint_store.get_checkpoint(peer_node_id)

get_records

Source code in django_spire/contrib/sync/django/storage/facade.py 
123
124
125
126
127
128
def get_records(
    self,
    model_label: str,
    keys: set[str],
) -> dict[str, SyncRecord]:
    return self._record_reader.get_records(model_label, keys)

get_sequence_allocator

Source code in django_spire/contrib/sync/django/storage/facade.py 
130
131
def get_sequence_allocator(self) -> SequenceAllocator:
    return self._sequence_allocator

get_syncable_models

Source code in django_spire/contrib/sync/django/storage/facade.py 
133
134
def get_syncable_models(self) -> list[str]:
    return self._record_reader.get_syncable_models()

get_tombstones

Source code in django_spire/contrib/sync/django/storage/facade.py 
136
137
138
139
140
141
def get_tombstones(
    self,
    model_label: str,
    keys: set[str],
) -> dict[str, int]:
    return self._record_reader.get_tombstones(model_label, keys)

save_checkpoint

Source code in django_spire/contrib/sync/django/storage/facade.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
def save_checkpoint(
    self,
    peer_node_id: str,
    peer_sequence: int,
    local_sequence_pushed: int,
    after_keys: dict[str, Any] | None = None,
) -> None:
    self._checkpoint_store.save_checkpoint(
        peer_node_id,
        peer_sequence,
        local_sequence_pushed,
        after_keys=after_keys,
    )

stamp_unstamped_records

Source code in django_spire/contrib/sync/django/storage/facade.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
def stamp_unstamped_records(
    self,
    clock: HybridLogicalClock,
    model_order: list[str] | None = None,
) -> None:
    count = self._record_writer.stamp_unstamped_records(
        clock=clock,
        model_order=model_order,
    )

    if count:
        logger.info(
            'Pre-sync stamping complete: %d records',
            count,
        )

upsert_many

Source code in django_spire/contrib/sync/django/storage/facade.py 
173
174
175
176
177
178
179
180
181
182
183
def upsert_many(
    self,
    model_label: str,
    records: dict[str, SyncRecord],
    origin_node: str,
) -> UpsertResult:
    return self._record_writer.upsert_many(
        model_label,
        records,
        origin_node,
    )