Skip to content

Commit

Permalink
update function docs to match code
Browse files Browse the repository at this point in the history
  • Loading branch information
magnetised committed Nov 9, 2023
1 parent 8722438 commit 6628142
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions clients/typescript/src/migrators/triggers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,9 @@ export function generateOplogTriggers(
/**
* Generates triggers for compensations for all foreign keys in the provided table.
*
* Compensation is recorded as a specially-formatted update. It acts as a no-op, with
* previous value set to NULL, and it's on the server to figure out that this is a no-op
* compensation operation (usually `UPDATE` would have previous row state known). The entire
* reason for it existing is to maybe revive the row if it has been deleted, so we need correct tags.
* Compensation is recorded as a SatOpCompensation messaage. The entire reason
* for it existing is to maybe revive the row if it has been deleted, so we need
* correct tags.
*
* The compensation update contains _just_ the primary keys, no other columns are present.
*
Expand Down

0 comments on commit 6628142

Please sign in to comment.