-
Notifications
You must be signed in to change notification settings - Fork 267
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement support for metadata associated with read-write transactions
This will allow callers of APIs such as WriteRelationships and DeleteRelationships to assign metadata to the transaction that will be mirrored back out in the Watch API, to provide a means for correlating updates
- Loading branch information
1 parent
7f6f270
commit a6f4020
Showing
29 changed files
with
610 additions
and
71 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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
92 changes: 92 additions & 0 deletions
92
internal/datastore/crdb/migrations/zz_migration.0008_add_transaction_metadata_table.go
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| package migrations | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "regexp" | ||
|
|
||
| "github.com/Masterminds/semver" | ||
| "github.com/jackc/pgx/v5" | ||
| ) | ||
|
|
||
| const ( | ||
| // ttl_expiration_expression support was added in CRDB v22.2, but the E2E tests | ||
| // use v21.2. | ||
| addTransactionMetadataTableQueryWithBasicTTL = ` | ||
| CREATE TABLE transaction_metadata ( | ||
| key UUID PRIMARY KEY DEFAULT gen_random_uuid(), | ||
| expires_at TIMESTAMPTZ, | ||
| metadata JSONB | ||
| ) WITH (ttl_expire_after = '1d'); | ||
| ` | ||
|
|
||
| addTransactionMetadataTableQuery = ` | ||
| CREATE TABLE transaction_metadata ( | ||
| key UUID PRIMARY KEY DEFAULT gen_random_uuid(), | ||
| expires_at TIMESTAMPTZ, | ||
| metadata JSONB | ||
| ) WITH (ttl_expiration_expression = 'expires_at', ttl_job_cron = '@daily'); | ||
| ` | ||
|
|
||
| // See: https://www.cockroachlabs.com/docs/stable/changefeed-messages#prevent-changefeeds-from-emitting-row-level-ttl-deletes | ||
| // for why we set ttl_disable_changefeed_replication = 'true'. This isn't stricly necessary as the Watch API will ignore the | ||
| // deletions of these metadata rows, but no reason to even have it in the changefeed. | ||
| // NOTE: This only applies on CRDB v24 and later. | ||
| addTransactionMetadataTableQueryWithTTLIgnore = ` | ||
| CREATE TABLE transaction_metadata ( | ||
| key UUID PRIMARY KEY DEFAULT gen_random_uuid(), | ||
| expires_at TIMESTAMPTZ, | ||
| metadata JSONB | ||
| ) WITH (ttl_expiration_expression = 'expires_at', ttl_job_cron = '@daily', ttl_disable_changefeed_replication = 'true'); | ||
| ` | ||
| ) | ||
|
|
||
| func init() { | ||
| err := CRDBMigrations.Register("add-transaction-metadata-table", "add-integrity-relationtuple-table", addTransactionMetadataTable, noAtomicMigration) | ||
| if err != nil { | ||
| panic("failed to register migration: " + err.Error()) | ||
| } | ||
| } | ||
|
|
||
| func addTransactionMetadataTable(ctx context.Context, conn *pgx.Conn) error { | ||
| row := conn.QueryRow(ctx, "select version()") | ||
| var fullVersionString string | ||
| if err := row.Scan(&fullVersionString); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| re, err := regexp.Compile(semver.SemVerRegex) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to compile regex: %w", err) | ||
| } | ||
|
|
||
| version := re.FindString(fullVersionString) | ||
| v, err := semver.NewVersion(version) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to parse version %q: %w", version, err) | ||
| } | ||
|
|
||
| if v.Major() < 22 { | ||
| return fmt.Errorf("unsupported version %q", version) | ||
| } | ||
|
|
||
| // v22.1 doesn't support `ttl_expiration_expression`; it was added in v22.2. | ||
| if v.Major() == 22 && v.Minor() == 1 { | ||
| if _, err := conn.Exec(ctx, addTransactionMetadataTableQueryWithBasicTTL); err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // `ttl_disable_changefeed_replication` was added in v24. | ||
| if v.Major() < 24 { | ||
| if _, err := conn.Exec(ctx, addTransactionMetadataTableQuery); err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // v24 and later | ||
| _, err = conn.Exec(ctx, addTransactionMetadataTableQueryWithTTLIgnore) | ||
| return err | ||
| } |
Oops, something went wrong.