|
| 1 | +// Copyright 2025 The Cockroach Authors. |
| 2 | +// |
| 3 | +// Use of this software is governed by the CockroachDB Software License |
| 4 | +// included in the /LICENSE file. |
| 5 | + |
| 6 | +package logical |
| 7 | + |
| 8 | +import ( |
| 9 | + "context" |
| 10 | + |
| 11 | + "github.com/cockroachdb/cockroach/pkg/sql/catalog" |
| 12 | + "github.com/cockroachdb/cockroach/pkg/sql/isql" |
| 13 | + "github.com/cockroachdb/cockroach/pkg/sql/parser/statements" |
| 14 | + "github.com/cockroachdb/cockroach/pkg/sql/sem/tree" |
| 15 | + "github.com/cockroachdb/cockroach/pkg/sql/sessiondata" |
| 16 | + "github.com/cockroachdb/cockroach/pkg/util/hlc" |
| 17 | + "github.com/cockroachdb/errors" |
| 18 | +) |
| 19 | + |
| 20 | +// errStalePreviousValue is returned if the row supplied to UpdateRow, |
| 21 | +// UpdateTombstone, or DeleteRow does not match the value in the local |
| 22 | +// database. |
| 23 | +var errStalePreviousValue = errors.New("stale previous value") |
| 24 | + |
| 25 | +// sqlRowWriter is configured to write rows to a specific table and descriptor |
| 26 | +// version. |
| 27 | +type sqlRowWriter struct { |
| 28 | + insert statements.Statement[tree.Statement] |
| 29 | + update statements.Statement[tree.Statement] |
| 30 | + delete statements.Statement[tree.Statement] |
| 31 | + |
| 32 | + scratchDatums []any |
| 33 | + columns []string |
| 34 | +} |
| 35 | + |
| 36 | +func (s *sqlRowWriter) getExecutorOverride( |
| 37 | + originTimestamp hlc.Timestamp, |
| 38 | +) sessiondata.InternalExecutorOverride { |
| 39 | + session := ieOverrideBase |
| 40 | + session.OriginTimestampForLogicalDataReplication = originTimestamp |
| 41 | + return session |
| 42 | +} |
| 43 | + |
| 44 | +// DeleteRow deletes a row from the table. It returns errStalePreviousValue |
| 45 | +// if the oldRow argument does not match the value in the local database. |
| 46 | +func (s *sqlRowWriter) DeleteRow( |
| 47 | + ctx context.Context, txn isql.Txn, originTimestamp hlc.Timestamp, oldRow tree.Datums, |
| 48 | +) error { |
| 49 | + s.scratchDatums = s.scratchDatums[:0] |
| 50 | + |
| 51 | + for _, d := range oldRow { |
| 52 | + s.scratchDatums = append(s.scratchDatums, d) |
| 53 | + } |
| 54 | + |
| 55 | + rowsAffected, err := txn.ExecParsed(ctx, "replicated-delete", txn.KV(), |
| 56 | + s.getExecutorOverride(originTimestamp), |
| 57 | + s.delete, |
| 58 | + s.scratchDatums..., |
| 59 | + ) |
| 60 | + if err != nil { |
| 61 | + return err |
| 62 | + } |
| 63 | + if rowsAffected != 1 { |
| 64 | + return errStalePreviousValue |
| 65 | + } |
| 66 | + return nil |
| 67 | +} |
| 68 | + |
| 69 | +// InsertRow inserts a row into the table. It will return an error if the row |
| 70 | +// already exists. |
| 71 | +func (s *sqlRowWriter) InsertRow( |
| 72 | + ctx context.Context, txn isql.Txn, originTimestamp hlc.Timestamp, row tree.Datums, |
| 73 | +) error { |
| 74 | + s.scratchDatums = s.scratchDatums[:0] |
| 75 | + for _, d := range row { |
| 76 | + s.scratchDatums = append(s.scratchDatums, d) |
| 77 | + } |
| 78 | + rowsImpacted, err := txn.ExecParsed(ctx, "replicated-insert", txn.KV(), |
| 79 | + s.getExecutorOverride(originTimestamp), |
| 80 | + s.insert, |
| 81 | + s.scratchDatums..., |
| 82 | + ) |
| 83 | + if err != nil { |
| 84 | + return err |
| 85 | + } |
| 86 | + if rowsImpacted != 1 { |
| 87 | + return errors.AssertionFailedf("expected 1 row impacted, got %d", rowsImpacted) |
| 88 | + } |
| 89 | + return nil |
| 90 | +} |
| 91 | + |
| 92 | +// UpdateRow updates a row in the table. It returns errStalePreviousValue |
| 93 | +// if the oldRow argument does not match the value in the local database. |
| 94 | +func (s *sqlRowWriter) UpdateRow( |
| 95 | + ctx context.Context, |
| 96 | + txn isql.Txn, |
| 97 | + originTimestamp hlc.Timestamp, |
| 98 | + oldRow tree.Datums, |
| 99 | + newRow tree.Datums, |
| 100 | +) error { |
| 101 | + s.scratchDatums = s.scratchDatums[:0] |
| 102 | + |
| 103 | + for _, d := range oldRow { |
| 104 | + s.scratchDatums = append(s.scratchDatums, d) |
| 105 | + } |
| 106 | + for _, d := range newRow { |
| 107 | + s.scratchDatums = append(s.scratchDatums, d) |
| 108 | + } |
| 109 | + |
| 110 | + rowsAffected, err := txn.ExecParsed(ctx, "replicated-update", txn.KV(), |
| 111 | + s.getExecutorOverride(originTimestamp), |
| 112 | + s.update, |
| 113 | + s.scratchDatums..., |
| 114 | + ) |
| 115 | + if err != nil { |
| 116 | + return err |
| 117 | + } |
| 118 | + if rowsAffected != 1 { |
| 119 | + return errStalePreviousValue |
| 120 | + } |
| 121 | + return err |
| 122 | +} |
| 123 | + |
| 124 | +func newSQLRowWriter(table catalog.TableDescriptor) (*sqlRowWriter, error) { |
| 125 | + physicalColumns := getPhysicalColumns(table) |
| 126 | + columns := make([]string, len(physicalColumns)) |
| 127 | + for i, col := range physicalColumns { |
| 128 | + columns[i] = col.GetName() |
| 129 | + } |
| 130 | + |
| 131 | + // TODO(jeffswenson): figure out how to manage prepared statements and |
| 132 | + // transactions in an internal executor. The original plan was to prepare |
| 133 | + // statements on initialization then reuse them, but the internal executor |
| 134 | + // is scoped to a single transaction and I couldn't figure out how to |
| 135 | + // maintain prepared statements across different instances of the internal |
| 136 | + // executor. |
| 137 | + |
| 138 | + insert, err := newInsertStatement(table) |
| 139 | + if err != nil { |
| 140 | + return nil, err |
| 141 | + } |
| 142 | + |
| 143 | + update, err := newUpdateStatement(table) |
| 144 | + if err != nil { |
| 145 | + return nil, err |
| 146 | + } |
| 147 | + |
| 148 | + delete, err := newDeleteStatement(table) |
| 149 | + if err != nil { |
| 150 | + return nil, err |
| 151 | + } |
| 152 | + |
| 153 | + return &sqlRowWriter{ |
| 154 | + insert: insert, |
| 155 | + update: update, |
| 156 | + delete: delete, |
| 157 | + columns: columns, |
| 158 | + }, nil |
| 159 | +} |
![craig[bot]](https://github.githubassets.com/images/gravatars/gravatar-user-420.png?size=40){kind=avatar}
0 commit comments