Skip to content

popoto.backends.postgres.longtail

popoto.backends.postgres.longtail

The long-tail memory fields on Postgres (#759 M5; plan §2 H, §3).

Three Redis features that each owned a Lua script, stored natively:

======================= ===================================================== feature Postgres ======================= ===================================================== CyclicDecayField the decay clock is the field's own double precision column, as for DecayingSortedField (M2a); the learned cycles are four parallel double precision[] columns, <f>__cycle_period, <f>__cycle_amp, <f>__cycle_phase and <f>__cycle_base (the #698 declared baseline, NULL element = unknown), and the homeostatic pressure two double precision columns, <f>__pressure_rate and <f>__pressure_at (last_resolved). NULL = no companion-hash entry. CYCLIC_DECAY_LUA is a SQL expression (:func:cyclic_score_sql) that rank_decayed, composite_score's decay arm and the assembler's score proxy rank with; CYCLES_MERGE_LUA is part of the save's upsert (:func:cyclic_save_parts); CYCLES_ADJUST_LUA is one UPDATE (strengthen_cycle / weaken_cycle). TDValueField a numeric column, as DecimalField; TD_UPDATE_LUA is one UPDATE that writes the new value through the script's %.14g. PredictionLedgerMixin two engine tables, popoto_prediction_ledger (model, member, entry jsonb, lua_packed) -- the $PL:{Class}:meta:{pk} hash entry -- and popoto_prediction_error (model, part, member, error) -- the $PL:{Class}:errors:{part} sorted set. RESOLVE_PREDICTION_LUA is one statement. ======================= =====================================================

Why arrays and not jsonb (plan §3 said jsonb): the cycle amplitudes are doubles the score multiplies, and jsonb numbers are numeric, which cannot hold NaN or ±Infinity (an amplitude can be either: a declared float("inf") passes the field's validation) and would add a text round trip to every row a ranking scans. A float8[] keeps every bit.

Bit-exactness

Every number the scripts compute is computed here operation for operation in double precision, in the script's order of evaluation: cos and power are the platform's libm on both servers, as for M2a's decay expression. Where C saturates (inf / 0) and Postgres would raise (value out of range, input is out of range for cos(inf)), the clamped helpers of :mod:.memory take over; the plain expression is used for every row whose inputs lie in a box where no step can leave the double range. Numbers the scripts return went through Lua's tostring (%.14g), and numbers they store through cmsgpack, which packs an integral number as an integer: :func:lua_num and :func:lua_repack apply the same rules on the way out.

CyclicSave dataclass

What one save does to its cyclic fields' state (the CYCLES_MERGE_LUA run on_save makes on Redis).

Source code in src/popoto/backends/postgres/longtail.py
@dataclass
class CyclicSave:
    """What one save does to its cyclic fields' state (the
    ``CYCLES_MERGE_LUA`` run ``on_save`` makes on Redis)."""

    cols: dict[str, Any] = field(default_factory=dict)
    overrides: dict[str, str] = field(default_factory=dict)
    returning: list[str] = field(default_factory=list)
    declared: dict[str, list[tuple[float, float, float]]] = field(default_factory=dict)

    def report(self, obj: Any, old: Sequence[Any]) -> None:
        """Emit ``on_save``'s #698 reset log line for each declared amplitude
        that won the merge, from the row's previous cycles (``RETURNING
        old.…``)."""
        from ...fields.cyclic_decay_field import log_declared_amplitude_reset

        member = obj.db_key.redis_key
        for i, (name, declared) in enumerate(self.declared.items()):
            periods, amps, bases = old[3 * i : 3 * i + 3]
            stored = None if periods is None else list(zip(periods, amps, bases))
            _out, resets = merge_cycles(stored, declared)
            for period, baseline, declared_amp, learned in resets:
                log_declared_amplitude_reset(
                    type(obj).__name__,
                    name,
                    member,
                    lua_num(period),
                    baseline,
                    declared_amp,
                    learned,
                )

report(obj, old)

Emit on_save's #698 reset log line for each declared amplitude that won the merge, from the row's previous cycles (RETURNING old.…).

Source code in src/popoto/backends/postgres/longtail.py
def report(self, obj: Any, old: Sequence[Any]) -> None:
    """Emit ``on_save``'s #698 reset log line for each declared amplitude
    that won the merge, from the row's previous cycles (``RETURNING
    old.…``)."""
    from ...fields.cyclic_decay_field import log_declared_amplitude_reset

    member = obj.db_key.redis_key
    for i, (name, declared) in enumerate(self.declared.items()):
        periods, amps, bases = old[3 * i : 3 * i + 3]
        stored = None if periods is None else list(zip(periods, amps, bases))
        _out, resets = merge_cycles(stored, declared)
        for period, baseline, declared_amp, learned in resets:
            log_declared_amplitude_reset(
                type(obj).__name__,
                name,
                member,
                lua_num(period),
                baseline,
                declared_amp,
                learned,
            )

LongtailOpsMixin

The field_call adapters of this module, for :class:~popoto.backends.postgres.PostgresBackend.

Source code in src/popoto/backends/postgres/longtail.py
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
class LongtailOpsMixin:
    """The ``field_call`` adapters of this module, for
    :class:`~popoto.backends.postgres.PostgresBackend`."""

    schema: str
    _table: Callable[..., TableSpec]
    _run: Callable[..., tuple[list[tuple[Any, ...]], int]]
    _record_locked: Callable[..., tuple[str, list[Any]]]
    _engine: Callable[[str], str]

    def _longtail_field_call(
        self,
        spec: ModelSpec,
        field: str,
        op: str,
        args: tuple[Any, ...],
        kwargs: dict[str, Any],
        uow: Optional[UnitOfWork],
    ) -> Any:
        handlers: dict[str, Callable[..., Any]] = {}
        if field == LEDGER_FIELD and LEDGER_MIXIN in spec.mixins:
            handlers = {
                "exists": self._ledger_exists,
                "record": self._ledger_record,
                "get": self._ledger_get,
                "resolve": self._ledger_resolve,
                "highest": self._ledger_highest,
                "rows": self._ledger_rows,
                "import": self._ledger_import,
            }
            handler = handlers.get(op)
            if handler is not None:
                return handler(spec, *args, uow=uow, **kwargs)
            return _NOT_HANDLED
        fs = spec.fields.get(field)
        if fs is None:
            return _NOT_HANDLED
        if fs.kind == CYCLIC_KIND:
            handlers = {
                "adjust": self._cycles_adjust,
                "resolve_pressure": self._cycles_resolve_pressure,
                "state": self._cycles_state,
                "import": self._cycles_import,
            }
        elif fs.kind == TD_KIND:
            handlers = {"td_update": self._td_update}
        handler = handlers.get(op)
        if handler is None:
            return _NOT_HANDLED
        return handler(spec, field, *args, uow=uow, **kwargs)

    # CyclicDecayField ----------------------------------------------------------

    def _cycles_adjust(
        self,
        spec: ModelSpec,
        field: str,
        id: RecordId,
        factor: float,
        max_amplitude: float,
        min_threshold: float,
        *,
        uow: Optional[UnitOfWork] = None,
    ) -> Optional[list[list[Any]]]:
        """``CYCLES_ADJUST_LUA``: every amplitude ``* factor``, clamped to
        ``[0, max_amplitude]``, below ``min_threshold`` snapped to ``0`` (a
        ``NaN`` passes every comparison untouched, as in Lua). One
        ``UPDATE``; ``None`` when there is no stored cycles entry (the
        script's ``nil``) or the record has expired (M5 TTL: the entry went
        with the row).

        A ``factor`` the script's ``tonumber`` reads as ``nil`` (``None``,
        ``"abc"``, ``True``) fails its first multiplication on Redis, so
        nothing is written; here it raises ``ValueError`` with the script's
        error text before any write -- the same message, a different class,
        as for every Lua refusal on this backend. As on Redis it is reached
        only when there is at least one cycle to multiply: no entry is
        ``None`` and an empty entry stays empty."""
        ts = self._table(spec, write=True)
        cp, ca, ch = (quote_ident(field + s) for s in CYCLE_SUFFIXES[:3])
        live = _and_live(ts)
        factor_n = lua_tonumber(factor)
        if factor_n is None:
            rows, _ = self._run(
                f"SELECT {cp}, coalesce({ca}, '{{}}'::float8[]), {ch} "
                f'FROM {ts.qualified} WHERE "_pk" = %s AND {cp} IS NOT NULL{live}',
                [id.canonical],
                uow=uow,
            )
            if not rows:
                return None
            if rows[0][1]:
                raise ValueError(_adjust_nil_factor_error())
            return _rows_cycles(rows[0][0], rows[0][1], rows[0][2], None)
        f_l = _lit(factor_n)
        mx, mn = _lit(float(max_amplitude)), _lit(float(min_threshold))
        x = safe_mul("u.a", f_l)
        # ``array_agg`` over no rows is NULL, not ``'{}'``: an empty stored
        # cycles entry (Redis keeps the empty msgpack array) must stay empty,
        # or the row carries periods with a NULL amplitude column.
        clamp = (
            f"COALESCE((SELECT array_agg((CASE WHEN w.y = {_NAN} THEN w.y "
            f"WHEN w.y < {mn} THEN {_ZERO} ELSE w.y END) ORDER BY w.o) FROM "
            f"(SELECT v.o, (CASE WHEN v.x = {_NAN} THEN v.x WHEN v.x < {_ZERO} "
            f"THEN {_ZERO} WHEN v.x > {mx} THEN {mx} ELSE v.x END) AS y FROM "
            f"(SELECT u.o, {x} AS x FROM unnest({ca}) WITH ORDINALITY AS u(a, o) "
            f"OFFSET 0) AS v) AS w), '{{}}'::float8[])"
        )
        sql, params = self._record_locked(
            ts,
            [id.canonical],
            f"UPDATE {ts.qualified} SET {ca} = {clamp} "
            f'WHERE "_pk" = %s AND {cp} IS NOT NULL{live} '
            f"RETURNING {cp}, {ca}, {ch}",
            [id.canonical],
        )
        rows, _ = self._run(sql, params, uow=uow, write=True)
        if not rows:
            return None
        return _rows_cycles(*rows[0])

    def _cycles_resolve_pressure(
        self,
        spec: ModelSpec,
        field: str,
        id: RecordId,
        rate: float,
        at: float,
        *,
        uow: Optional[UnitOfWork] = None,
    ) -> None:
        """``resolve_pressure``'s blind ``HSET {rate, last_resolved: at}``.
        Nothing is written for a record that does not exist or has expired
        (documented: Redis writes an orphan companion entry)."""
        ts = self._table(spec, write=True)
        pr, pa = (quote_ident(field + s) for s in PRESSURE_SUFFIXES)
        sql, params = self._record_locked(
            ts,
            [id.canonical],
            f"UPDATE {ts.qualified} SET {pr} = %s, {pa} = %s "
            f'WHERE "_pk" = %s{_and_live(ts)}',
            [float(rate), float(at), id.canonical],
        )
        self._run(sql, params, uow=uow, write=True)

    def _cycles_state(
        self,
        spec: ModelSpec,
        field: str,
        id: RecordId,
        *,
        uow: Optional[UnitOfWork] = None,
    ) -> Optional[dict[str, Any]]:
        """The stored companion state, as the Redis hashes decode: ``cycles``
        (``[period, amplitude, phase(, baseline)]``, ``None`` = no entry)
        and ``pressure`` (``{"rate", "last_resolved"}`` or ``None``).
        ``None`` when the record does not exist or has expired."""
        ts = self._table(spec)
        cols = ", ".join(
            quote_ident(field + s) for s in CYCLE_SUFFIXES + PRESSURE_SUFFIXES
        )
        rows, _ = self._run(
            f'SELECT {cols} FROM {ts.qualified} WHERE "_pk" = %s' + _and_live(ts),
            [id.canonical],
            uow=uow,
        )
        if not rows:
            return None
        periods, amps, phases, bases, rate, at = rows[0]
        return {
            "cycles": _rows_cycles(periods, amps, phases, bases),
            "pressure": (
                None
                if rate is None
                else {"rate": float(rate), "last_resolved": float(at)}
            ),
        }

    def _cycles_import(
        self,
        spec: ModelSpec,
        field: str,
        id: RecordId,
        cycles: Optional[Sequence[Sequence[Any]]],
        pressure: Optional[dict[str, float]],
        *,
        uow: Optional[UnitOfWork] = None,
    ) -> None:
        """``import_state``'s raw writes: cycles as 3-element entries (no
        baseline, #698), pressure as given. ``None`` leaves that half
        untouched. A record that does not exist or has expired is not
        written."""
        ts = self._table(spec, write=True)
        sets: list[str] = []
        params: list[Any] = []
        if cycles is not None:
            cp, ca, ch, cb = (quote_ident(field + s) for s in CYCLE_SUFFIXES)
            periods, amps, phases = [], [], []
            for cycle in cycles:
                values = [lua_tonumber(v) for v in cycle[:3]]
                if any(v is None for v in values):
                    raise ValueError(
                        f"cycle {tuple(cycle)!r}: Postgres stores numeric cycle "
                        "slots only"
                    )
                periods.append(values[0])
                amps.append(values[1])
                phases.append(values[2])
            sets.append(f"{cp} = %s, {ca} = %s, {ch} = %s, {cb} = %s")
            params += [periods, amps, phases, [None] * len(periods)]
        if pressure is not None:
            pr, pa = (quote_ident(field + s) for s in PRESSURE_SUFFIXES)
            sets.append(f"{pr} = %s, {pa} = %s")
            params += [float(pressure["rate"]), float(pressure["last_resolved"])]
        if not sets:
            return
        sql, all_params = self._record_locked(
            ts,
            [id.canonical],
            f"UPDATE {ts.qualified} SET {', '.join(sets)} "
            f'WHERE "_pk" = %s{_and_live(ts)}',
            params + [id.canonical],
        )
        self._run(sql, all_params, uow=uow, write=True)

    # TDValueField --------------------------------------------------------------

    def _td_update(
        self,
        spec: ModelSpec,
        field: str,
        id: RecordId,
        *,
        target: float,
        alpha: float,
        uow: Optional[UnitOfWork] = None,
    ) -> float:
        """``TD_UPDATE_LUA`` as one ``UPDATE``: ``td = target - q`` (``target``
        is the script's ``reward + gamma * max_future_q``, computed by the
        caller in the same order), ``q' = q + alpha * td``, stored as the
        ``numeric`` of ``tostring(q')`` -- Lua's ``%.14g`` -- with the
        trailing zeros of ``to_char``'s ``%.13e`` trimmed. Returns
        ``tostring(td)``. ``q`` is ``0`` when the column is ``NULL``, and the
        stored ``numeric`` reads as the script's ``tonumber`` of its text:
        past the double range it is ``±inf`` and below the smallest
        subnormal ``±0`` (:func:`_numeric_as_double_sql`), where a plain
        ``::float8`` cast raises "out of range". A ``numeric`` has no ``-0``,
        so a stored ``Decimal('-0')`` reads as ``0`` (documented: the reply
        can be ``-0.0`` where Redis's is ``0.0``). A record that does not
        exist or has expired is not written (Redis would leave a hash
        holding only the value) and the reply is the one ``q = 0`` gives."""
        ts = self._table(spec, write=True)
        col = quote_ident(field)
        # The constants enter as columns of a MATERIALIZED CTE, never as
        # literals in the arithmetic: the planner folds a constant
        # subexpression even inside a CASE arm that would not run, and the
        # clamped helpers' `x / 2` of a subnormal constant then raises
        # "underflow" at plan time.
        target_l = "c.tgt"
        nq = "e.nq"
        fmt = (
            f"(CASE WHEN {nq} = {_NAN} THEN 'NaN'::numeric "
            f"WHEN {nq} = {_INF} THEN 'Infinity'::numeric "
            f"WHEN {nq} = '-Infinity'::float8 THEN '-Infinity'::numeric "
            f"ELSE trim_scale(to_char({nq}, '9.9999999999999EEEE')::numeric) END)"
        )
        sql = (
            f'WITH c AS MATERIALIZED (SELECT t."_pk", '
            f"{_numeric_as_double_sql(f't.{col}')} AS q, "
            f"{_lit(target)} AS tgt, {_lit(alpha)} AS alpha "
            f'FROM {ts.qualified} AS t WHERE t."_pk" = %s{_and_live(ts, "t")} '
            "FOR UPDATE), "
            f'd AS (SELECT c."_pk", c.q, c.alpha, {safe_sub(target_l, "c.q")} AS td '
            f"FROM c), "
            f'm AS (SELECT d."_pk", d.q, d.td, {safe_mul("d.alpha", "d.td")} AS m '
            f"FROM d), "
            f'e AS (SELECT m."_pk", m.td, {safe_add("m.q", "m.m")} AS nq FROM m) '
            f"UPDATE {ts.qualified} AS t SET {col} = {fmt}, "
            f'"_updated_at" = now(), "_migrated_from" = NULL FROM e '
            f'WHERE t."_pk" = e."_pk" RETURNING e.td'
        )
        sql, params = self._record_locked(ts, [id.canonical], sql, [id.canonical])
        rows, _ = self._run(sql, params, uow=uow, write=True)
        if not rows:
            return lua_tostring(float(target) - 0.0)
        return lua_tostring(float(rows[0][0]))

    # PredictionLedgerMixin -----------------------------------------------------

    def _ledger_exists(
        self, spec: ModelSpec, id: RecordId, *, uow: Optional[UnitOfWork] = None
    ) -> bool:
        """``EXISTS <record key>``, read inside ``uow`` when given: an
        expired ``Meta.ttl`` record does not exist (M5 TTL), so ``record`` /
        ``resolve`` raise ``TypeError`` and ``auto_resolve`` returns ``None``
        on it, as on Redis. This is the one ledger read that filters: the
        ledger rows themselves are keyed by class name, not by the record
        row, and outlive it on both legs (the ``$PL:`` keys carry no TTL)."""
        ts = self._table(spec)
        rows, _ = self._run(
            f'SELECT 1 FROM {ts.qualified} WHERE "_pk" = %s' + _and_live(ts),
            [id.canonical],
            uow=uow,
        )
        return bool(rows)

    def _ledger_record(
        self,
        spec: ModelSpec,
        id: RecordId,
        entry: dict[str, Any],
        *,
        uow: Optional[UnitOfWork] = None,
        lua_packed: bool = False,
    ) -> None:
        """``HSET $PL:{Class}:meta:{pk} {pk} <entry>``: the whole entry,
        replaced, behind the record's key lock (the ledger is that record's
        state)."""
        ts = self._table(spec, write=True)
        table = self._engine(LEDGER_TABLE)
        sql, params = self._record_locked(
            ts,
            [id.canonical],
            f"INSERT INTO {table} (model, member, entry, lua_packed) "
            "VALUES (%s, %s, %s, %s) ON CONFLICT (model, member) DO UPDATE "
            "SET entry = EXCLUDED.entry, lua_packed = EXCLUDED.lua_packed",
            [spec.name, id.canonical, _ledger_jsonb(entry), bool(lua_packed)],
        )
        self._run(sql, params, uow=uow, write=True)

    def _ledger_get(
        self,
        spec: ModelSpec,
        id: RecordId,
        *,
        uow: Optional[UnitOfWork] = None,
    ) -> Optional[dict[str, Any]]:
        """The entry as ``msgpack.unpackb(raw=False)`` returns it on Redis
        (``None`` when there is none): after a resolution, as the script's
        ``cmsgpack`` re-pack left it."""
        table = self._engine(LEDGER_TABLE)
        rows, _ = self._run(
            f"SELECT entry, lua_packed FROM {table} WHERE model = %s AND member = %s",
            [spec.name, id.canonical],
            uow=uow,
        )
        if not rows:
            return None
        return self._ledger_entry(rows[0][0], rows[0][1])

    @staticmethod
    def _ledger_entry(raw: Any, lua_packed: bool) -> Any:
        entry = _ledger_decode(raw)
        if lua_packed:
            entry = lua_repack(entry)
        _strict_keys(entry)
        return entry

    def _ledger_resolve(
        self,
        spec: ModelSpec,
        id: RecordId,
        *,
        part: str,
        error: float,
        mode: str,
        resolved_at: str,
        uow: Optional[UnitOfWork] = None,
    ) -> int:
        """``RESOLVE_PREDICTION_LUA`` as one statement: an entry not yet
        resolved -- Lua truthiness, so only an absent, ``nil`` or ``false``
        ``resolved`` -- is marked resolved with the error, mode and time,
        and the error sorted set gets ``|error|`` (``ZADD``). Returns ``1``,
        or ``0`` when there is no entry or it is resolved (or its
        ``cmsgpack.unpack`` would fail: a ``nil`` or ``NaN`` table key)."""
        if math.isnan(error):
            # The script's ZADD refuses a NaN score -- after its HSET, which
            # Redis does not roll back. Refused here before anything is
            # written (a documented divergence).
            raise ValueError("value is not a valid float (the prediction error is NaN)")
        ts = self._table(spec, write=True)
        ledger = self._engine(LEDGER_TABLE)
        errors = self._engine(ERROR_TABLE)
        current = self._ledger_raw(spec, id, uow=uow)
        if current is None:
            return 0
        try:
            _lua_value(_ledger_decode(current[0]))
        except _LuaUnpackError:
            return 0
        lua_error = lua_num(float(error))
        patch = {
            "resolved": True,
            "prediction_error": lua_error,
            "resolution_mode": mode,
            "resolved_at": resolved_at,
        }
        sql = (
            f"WITH r AS (UPDATE {ledger} SET entry = entry || %s::jsonb, "
            "lua_packed = true WHERE model = %s AND member = %s "
            "AND jsonb_typeof(entry) = 'object' AND NOT entry ? %s "
            "AND (entry->'resolved' IS NULL "
            "OR entry->'resolved' IN ('null'::jsonb, 'false'::jsonb)) RETURNING 1) "
            f"INSERT INTO {errors} (model, part, member, error) "
            "SELECT %s, %s, %s, %s FROM r ON CONFLICT (model, part, member) "
            "DO UPDATE SET error = EXCLUDED.error RETURNING 1"
        )
        params = [
            _ledger_jsonb(patch),
            spec.name,
            id.canonical,
            _MAP,
            spec.name,
            str(part),
            id.canonical,
            abs(float(error)),
        ]
        sql, params = self._record_locked(ts, [id.canonical], sql, params)
        rows, _ = self._run(sql, params, uow=uow, write=True)
        return 1 if rows else 0

    def _ledger_raw(
        self, spec: ModelSpec, id: RecordId, *, uow: Optional[UnitOfWork] = None
    ) -> Optional[tuple[Any, bool]]:
        table = self._engine(LEDGER_TABLE)
        rows, _ = self._run(
            f"SELECT entry, lua_packed FROM {table} WHERE model = %s AND member = %s",
            [spec.name, id.canonical],
            uow=uow,
        )
        return (rows[0][0], rows[0][1]) if rows else None

    def _ledger_highest(
        self,
        spec: ModelSpec,
        part: str,
        limit: int,
        *,
        uow: Optional[UnitOfWork] = None,
    ) -> list[tuple[str, float]]:
        """``ZREVRANGE errors 0 limit-1 WITHSCORES``: error descending, ties by
        member bytes descending, Redis's rank arithmetic (``limit <= 0``
        counts from the end)."""
        table = self._engine(ERROR_TABLE)
        sql = (
            f"SELECT member, error FROM {table} WHERE model = %s AND part = %s "
            'ORDER BY error DESC, member COLLATE "C" DESC'
        )
        params: list[Any] = [spec.name, str(part)]
        stop = int(limit) - 1
        if stop >= 0:
            sql += f" LIMIT {stop + 1}"
        rows, _ = self._run(sql, params, uow=uow)
        out = [(member, float(error)) for member, error in rows]
        if stop < 0:
            stop = len(out) + stop
            out = out[: stop + 1] if stop >= 0 else []
        return out

    def _ledger_rows(
        self,
        spec: ModelSpec,
        part: str,
        limit: int,
        *,
        uow: Optional[UnitOfWork] = None,
    ) -> list[tuple[str, float, Any]]:
        """``error_summary``'s reads: the top ``limit`` of the error set and
        each member's entry (``None`` when it has none; an entry that would
        not decode on Redis is skipped there, so it is reported as an
        exception object here for the caller to log)."""
        top = self._ledger_highest(spec, part, limit, uow=uow) if limit > 0 else []
        if not top:
            return []
        table = self._engine(LEDGER_TABLE)
        rows, _ = self._run(
            f"SELECT member, entry, lua_packed FROM {table} "
            "WHERE model = %s AND member = ANY(%s::text[])",
            [spec.name, [m for m, _ in top]],
            uow=uow,
        )
        entries = {member: (raw, packed) for member, raw, packed in rows}
        out: list[tuple[str, float, Any]] = []
        for member, score in top:
            found = entries.get(member)
            if found is None:
                out.append((member, score, None))
                continue
            try:
                out.append((member, score, self._ledger_entry(*found)))
            except Exception as exc:  # decode failure: reported, then skipped
                out.append((member, score, exc))
        return out

    def _ledger_import(
        self,
        spec: ModelSpec,
        id: RecordId,
        entry: dict[str, Any],
        part: Optional[str],
        *,
        uow: Optional[UnitOfWork] = None,
    ) -> None:
        """``import_state``: the entry written raw (Python msgpack on Redis,
        not the script's re-pack), and ``ZADD |prediction_error|`` when it is
        resolved."""
        self._ledger_record(spec, id, entry, uow=uow)
        error = entry.get("prediction_error")
        if entry.get("resolved") and error is not None:
            ts = self._table(spec, write=True)
            errors = self._engine(ERROR_TABLE)
            sql, params = self._record_locked(
                ts,
                [id.canonical],
                f"INSERT INTO {errors} (model, part, member, error) "
                "VALUES (%s, %s, %s, %s) ON CONFLICT (model, part, member) "
                "DO UPDATE SET error = EXCLUDED.error",
                [spec.name, str(part or "default"), id.canonical, abs(float(error))],
            )
            self._run(sql, params, uow=uow, write=True)

lua_tonumber(value)

Lua 5.1 tonumber of an ARGV string (str(value)), else nil (None): C strtod -- leading space, a sign, a decimal or C99 hex float ("0x10" is 16, "0x1p3" 8), inf/infinity/ nan (or nan(chars)) in any case, overflow to ±inf and underflow to ±0 -- with only trailing space after it, and nothing read past a NUL (Lua reads the C string). Checked case by case against Redis 8.10's tonumber (tests/test_backend_parity_longtail.py). Python's float() is looser (digit separators, non-ASCII digits) and refuses hex, so the shape is matched first.

Source code in src/popoto/backends/postgres/longtail.py
def lua_tonumber(value: Any) -> Optional[float]:
    """Lua 5.1 ``tonumber`` of an ``ARGV`` string (``str(value)``), else
    ``nil`` (``None``): C ``strtod`` -- leading space, a sign, a decimal or
    C99 hex float (``"0x10"`` is 16, ``"0x1p3"`` 8), ``inf``/``infinity``/
    ``nan`` (or ``nan(chars)``) in any case, overflow to ``±inf`` and
    underflow to ``±0`` -- with only trailing space after it, and nothing
    read past a NUL (Lua reads the C string). Checked case by case against Redis 8.10's
    ``tonumber`` (``tests/test_backend_parity_longtail.py``). Python's
    ``float()`` is looser (digit separators, non-ASCII digits) and refuses
    hex, so the shape is matched first."""
    text = str(value).split("\x00", 1)[0].strip(_C_SPACE)
    if _LUA_NAN.fullmatch(text):
        return math.nan
    if _LUA_DECIMAL.fullmatch(text) or _LUA_SPECIAL.fullmatch(text):
        return float(text)
    if _LUA_HEX.fullmatch(text):
        try:
            return float.fromhex(text)
        except OverflowError:
            return -math.inf if text.startswith("-") else math.inf
    return None

lua_num(value)

A Lua number as cmsgpack packs it and msgpack reads it back: an integer when it is integral and fits int64 (-0.0 -> 0), else the float (a float32 encoding, when exact, decodes to the same double).

Source code in src/popoto/backends/postgres/longtail.py
def lua_num(value: float) -> Any:
    """A Lua number as ``cmsgpack`` packs it and msgpack reads it back: an
    integer when it is integral and fits ``int64`` (``-0.0`` -> ``0``), else
    the ``float`` (a ``float32`` encoding, when exact, decodes to the same
    double)."""
    if isinstance(value, bool) or not isinstance(value, float):
        return value
    if math.isfinite(value) and value == int(value) and -_INT64 <= value < _INT64:
        return int(value)
    return value

lua_repack(value)

value after cmsgpack.unpack then cmsgpack.pack -- what a script that read-modify-writes a msgpack entry stores. Raises ValueError where the unpack itself would fail.

Source code in src/popoto/backends/postgres/longtail.py
def lua_repack(value: Any) -> Any:
    """``value`` after ``cmsgpack.unpack`` then ``cmsgpack.pack`` -- what a
    script that read-modify-writes a msgpack entry stores. Raises
    ``ValueError`` where the unpack itself would fail."""
    return _lua_pack(_lua_value(value), 0)

declared_cycles(cycles)

A field's cycles as the script receives them: each slot str()-ed into ARGV and tonumber-ed back (phase or 0).

Source code in src/popoto/backends/postgres/longtail.py
def declared_cycles(
    cycles: Sequence[Sequence[Any]],
) -> list[tuple[float, float, float]]:
    """A field's ``cycles`` as the script receives them: each slot
    ``str()``-ed into ``ARGV`` and ``tonumber``-ed back (phase ``or 0``)."""
    out = []
    for cycle in cycles:
        period = lua_tonumber(cycle[0])
        amp = lua_tonumber(cycle[1])
        phase = lua_tonumber(cycle[2] if len(cycle) > 2 else 0)
        if period is None or amp is None:
            raise ValueError(
                f"CyclicDecayField cycle {tuple(cycle)!r}: a non-numeric period or "
                "amplitude cannot be stored on Postgres"
            )
        out.append((period, amp, 0.0 if phase is None else phase))
    return out

merge_cycles(stored, declared)

CYCLES_MERGE_LUA's cycles half: (output, resets).

stored is [(period, amplitude, baseline)] (None = no entry). Declared cycles are matched to stored ones by period, FIFO within a period; a picked entry keeps its learned amplitude unless its recorded baseline differs from the declared amplitude (the developer edited the declaration: a reset). Output entries are (period, amplitude, phase, declared amplitude).

Source code in src/popoto/backends/postgres/longtail.py
def merge_cycles(
    stored: Optional[Sequence[tuple[float, float, Optional[float]]]],
    declared: Sequence[tuple[float, float, float]],
) -> tuple[
    list[tuple[float, float, float, float]], list[tuple[float, float, float, float]]
]:
    """``CYCLES_MERGE_LUA``'s cycles half: ``(output, resets)``.

    ``stored`` is ``[(period, amplitude, baseline)]`` (``None`` = no entry).
    Declared cycles are matched to stored ones by period, FIFO within a
    period; a picked entry keeps its learned amplitude unless its recorded
    baseline differs from the declared amplitude (the developer edited the
    declaration: a *reset*). Output entries are ``(period, amplitude, phase,
    declared amplitude)``."""
    buckets: dict[bytes, list[tuple[float, Optional[float]]]] = {}
    for period, amp, baseline in stored or ():
        buckets.setdefault(_bits(period), []).append((amp, baseline))
    output = []
    resets = []
    for period, declared_amp, phase in declared:
        amplitude = declared_amp
        bucket = buckets.get(_bits(period))
        if bucket:
            learned, baseline = bucket.pop(0)
            if baseline is None or (
                baseline == declared_amp and not math.isnan(baseline)
            ):
                amplitude = learned
            else:
                resets.append((period, baseline, declared_amp, learned))
        output.append((period, amplitude, phase, declared_amp))
    return output, resets

cyclic_columns(spec)

State columns of every CyclicDecayField (role "state").

Source code in src/popoto/backends/postgres/longtail.py
def cyclic_columns(spec: ModelSpec) -> list[Column]:
    """State columns of every ``CyclicDecayField`` (role ``"state"``)."""
    out: list[Column] = []
    for name in sorted(spec.fields):
        if spec.fields[name].kind != CYCLIC_KIND:
            continue
        out.extend(
            Column(name + suffix, "double precision[]", name, "state")
            for suffix in CYCLE_SUFFIXES
        )
        out.extend(
            Column(name + suffix, "double precision", name, "state")
            for suffix in PRESSURE_SUFFIXES
        )
    return out

safe_add(a, b)

a + b that saturates to ±inf where Postgres would raise.

Source code in src/popoto/backends/postgres/longtail.py
def safe_add(a: str, b: str) -> str:
    """``a + b`` that saturates to ``±inf`` where Postgres would raise."""
    return safe_sub(a, f"(-{b})")

safe_div(a, b)

a / b for b > 0 (or inf) that gives C's inf / 0 where Postgres would raise on overflow or underflow.

Source code in src/popoto/backends/postgres/longtail.py
def safe_div(a: str, b: str) -> str:
    """``a / b`` for ``b > 0`` (or ``inf``) that gives C's ``inf`` / ``0``
    where Postgres would raise on overflow or underflow."""
    neg = f"(({a} < 0) <> ({b} < 0))"
    logq = f"(ln(abs({a})) - ln(abs({b})))"
    return (
        f"(CASE WHEN {a} = {_ZERO} OR {_nonfinite(a)} OR {_nonfinite(b)}"
        f" THEN {a} / {b}"
        f" WHEN {logq} > 709.78"
        f" THEN (CASE WHEN {neg} THEN '-Infinity'::float8 ELSE {_INF} END)"
        f" WHEN {logq} < -745.13"
        f" THEN (CASE WHEN {neg} THEN (-0.0)::float8 ELSE {_ZERO} END)"
        f" ELSE {a} / {b} END)"
    )

cyclic_score_sql(ts, spec, field, *, now, rate, base_field, confidence_field, strength, confidence_partition=None)

The CYCLIC_DECAY_LUA score of one row of ts (aliased t): decayed + cyclic + pressure, evaluated in that order.

decayed is :func:~.memory.decay_score_sql -- the script's decay and modulation steps are DECAY_SCORE_LUA's, and its unsplit base * pow equals that script's sign * |base| * pow once + cyclic (at least 0) has turned a -0 into +0. There is no validity gate: the script has none (TestCyclicDecayGatingGap).

Source code in src/popoto/backends/postgres/longtail.py
def cyclic_score_sql(
    ts: TableSpec,
    spec: ModelSpec,
    field: str,
    *,
    now: float,
    rate: float,
    base_field: Optional[str],
    confidence_field: Optional[str],
    strength: float,
    confidence_partition: Any = None,
) -> str:
    """The ``CYCLIC_DECAY_LUA`` score of one row of ``ts`` (aliased ``t``):
    ``decayed + cyclic + pressure``, evaluated in that order.

    ``decayed`` is :func:`~.memory.decay_score_sql` -- the script's decay
    and modulation steps are ``DECAY_SCORE_LUA``'s, and its unsplit ``base *
    pow`` equals that script's ``sign * |base| * pow`` once ``+ cyclic``
    (at least ``0``) has turned a ``-0`` into ``+0``. There is no validity
    gate: the script has none (``TestCyclicDecayGatingGap``)."""
    decayed = decay_score_sql(
        ts,
        spec,
        field,
        now=now,
        rate=rate,
        base_field=base_field,
        confidence_field=confidence_field,
        strength=strength,
        confidence_partition=confidence_partition,
    )
    cycles = _cycles_sql(field, now)
    pressure = _pressure_sql(field, now)
    return (
        f"(SELECT {safe_add('y.dc', 'y.p')} FROM (SELECT "
        f"{safe_add('z.d', 'z.c')} AS dc, z.p FROM (SELECT {decayed} AS d, "
        f"{cycles} AS c, {pressure} AS p OFFSET 0) AS z OFFSET 0) AS y)"
    )

cyclic_save_parts(ts, spec, obj, names)

CYCLES_MERGE_LUA for each CyclicDecayField the save writes, as upsert parts: the new row's columns, and ON CONFLICT expressions that merge the declaration into the stored cycles -- period and phase from the declaration, amplitude learned unless the declaration was edited (#698), baseline = the declared amplitude -- and refresh the pressure rate, keeping last_resolved (now for a new entry). No declared cycles clears the cycles; pressure_rate <= 0 clears the pressure. None when the save writes no cyclic field.

Source code in src/popoto/backends/postgres/longtail.py
def cyclic_save_parts(
    ts: TableSpec, spec: ModelSpec, obj: Any, names: Sequence[str]
) -> Optional[CyclicSave]:
    """``CYCLES_MERGE_LUA`` for each ``CyclicDecayField`` the save writes, as
    upsert parts: the new row's columns, and ``ON CONFLICT`` expressions that
    merge the declaration into the stored cycles -- period and phase from the
    declaration, amplitude learned unless the declaration was edited (#698),
    baseline = the declared amplitude -- and refresh the pressure rate,
    keeping ``last_resolved`` (``now`` for a new entry). No declared cycles
    clears the cycles; ``pressure_rate <= 0`` clears the pressure. ``None``
    when the save writes no cyclic field."""
    fields = [
        n for n in names if n in spec.fields and spec.fields[n].kind == CYCLIC_KIND
    ]
    if not fields:
        return None
    out = CyclicSave()
    now = time.time()
    table = quote_ident(ts.table)
    for name in fields:
        live = obj._meta.fields[name]
        declared = declared_cycles(live.cycles)
        out.declared[name] = declared
        cp, ca, ch, cb = (quote_ident(name + s) for s in CYCLE_SUFFIXES)
        pr, pa = (quote_ident(name + s) for s in PRESSURE_SUFFIXES)
        names_ = [name + s for s in CYCLE_SUFFIXES]
        if declared:
            dp = [d[0] for d in declared]
            da = [d[1] for d in declared]
            dh = [d[2] for d in declared]
            out.cols.update(dict(zip(names_, (dp, da, dh, list(da)))))
            merged = (
                "(SELECT array_agg(CASE WHEN s.o IS NULL THEN d.a "
                "WHEN s.b IS NULL OR (s.b = d.a AND s.b <> 'NaN'::float8) THEN s.a "
                "ELSE d.a END ORDER BY d.o) FROM (SELECT x.p, x.a, x.o, "
                "row_number() OVER (PARTITION BY float8send(x.p) ORDER BY x.o) AS r "
                f"FROM unnest({_array_lit(dp)}, {_array_lit(da)}) "
                "WITH ORDINALITY AS x(p, a, o)) AS d LEFT JOIN (SELECT y.a, y.b, "
                "y.o, float8send(y.p) AS k, row_number() OVER (PARTITION BY "
                f"float8send(y.p) ORDER BY y.o) AS r FROM unnest({table}.{cp}, "
                f"{table}.{ca}, {table}.{cb}) WITH ORDINALITY AS y(p, a, b, o)) AS s "
                "ON s.k = float8send(d.p) AND s.r = d.r)"
            )
            out.overrides[name + CYCLE_SUFFIXES[1]] = merged
        else:
            out.cols.update(dict.fromkeys(names_))
        rate = lua_tonumber(live.pressure_rate)
        if rate is not None and rate > 0:
            out.cols[name + PRESSURE_SUFFIXES[0]] = rate
            out.cols[name + PRESSURE_SUFFIXES[1]] = now
            out.overrides[name + PRESSURE_SUFFIXES[1]] = (
                f"CASE WHEN {table}.{pr} IS NOT NULL THEN {table}.{pa} "
                f"ELSE EXCLUDED.{pa} END"
            )
        else:
            out.cols[name + PRESSURE_SUFFIXES[0]] = None
            out.cols[name + PRESSURE_SUFFIXES[1]] = None
        out.returning.extend(f"old.{c}" for c in (cp, ca, cb))
    return out