db: add format major version for range keys

Introduce a new format major version for range keys, with associated table format `Pebble,v2`. When the DB is opened at this version, it is free to make use of range key features. Related to cockroachdb#1339.
nicktrav · Feb 4, 2022 · 9efd3a7 · 9efd3a7
1 parent 19e11cf
commit 9efd3a7
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 10 deletions.
diff --git a/format_major_version.go b/format_major_version.go
@@ -70,11 +70,13 @@ const (
 	// FormatBlockPropertyCollector is a format major version that introduces
 	// BlockPropertyCollectors.
 	FormatBlockPropertyCollector
+	// FormatRangeKeys is a format major version that introduces range keys.
+	FormatRangeKeys
 	// FormatNewest always contains the most recent format major version.
 	// NB: When adding new versions, the MaxTableFormat method should also be
 	// updated to return the maximum allowable version for the new
 	// FormatMajorVersion.
-	FormatNewest FormatMajorVersion = FormatBlockPropertyCollector
+	FormatNewest FormatMajorVersion = FormatRangeKeys
 )
 
 // MaxTableFormat returns the maximum sstable.TableFormat that can be used at
@@ -86,6 +88,8 @@ func (v FormatMajorVersion) MaxTableFormat() sstable.TableFormat {
 		return sstable.TableFormatRocksDBv2
 	case FormatBlockPropertyCollector:
 		return sstable.TableFormatPebblev1
+	case FormatRangeKeys:
+		return sstable.TableFormatPebblev2
 	default:
 		panic(fmt.Sprintf("pebble: unsupported format major version: %s", v))
 	}
@@ -167,6 +171,9 @@ var formatMajorVersionMigrations = map[FormatMajorVersion]func(*DB) error{
 	FormatBlockPropertyCollector: func(d *DB) error {
 		return d.finalizeFormatVersUpgrade(FormatBlockPropertyCollector)
 	},
+	FormatRangeKeys: func(d *DB) error {
+		return d.finalizeFormatVersUpgrade(FormatRangeKeys)
+	},
 }
 
 const formatVersionMarkerName = `format-version`

diff --git a/format_major_version_test.go b/format_major_version_test.go
@@ -36,6 +36,8 @@ func TestRatchetFormat(t *testing.T) {
 	require.Equal(t, FormatSetWithDelete, d.FormatMajorVersion())
 	require.NoError(t, d.RatchetFormatMajorVersion(FormatBlockPropertyCollector))
 	require.Equal(t, FormatBlockPropertyCollector, d.FormatMajorVersion())
+	require.NoError(t, d.RatchetFormatMajorVersion(FormatRangeKeys))
+	require.Equal(t, FormatRangeKeys, d.FormatMajorVersion())
 	require.NoError(t, d.Close())
 
 	// If we Open the database again, leaving the default format, the
@@ -189,6 +191,7 @@ func TestFormatMajorVersions_TableFormat(t *testing.T) {
 		FormatVersioned:               sstable.TableFormatRocksDBv2,
 		FormatSetWithDelete:           sstable.TableFormatRocksDBv2,
 		FormatBlockPropertyCollector:  sstable.TableFormatPebblev1,
+		FormatRangeKeys:               sstable.TableFormatPebblev2,
 	}
 
 	// Valid versions.

diff --git a/open_test.go b/open_test.go
@@ -101,7 +101,7 @@ func TestNewDBFilenames(t *testing.T) {
 			"LOCK",
 			"MANIFEST-000001",
 			"OPTIONS-000003",
-			"marker.format-version.000004.005",
+			"marker.format-version.000005.006",
 			"marker.manifest.000001.MANIFEST-000001",
 		},
 	}

diff --git a/testdata/checkpoint b/testdata/checkpoint
@@ -31,6 +31,9 @@ sync: db
 create: db/marker.format-version.000004.005
 close: db/marker.format-version.000004.005
 sync: db
+create: db/marker.format-version.000005.006
+close: db/marker.format-version.000005.006
+sync: db
 sync: db/MANIFEST-000001
 create: db/000002.log
 sync: db
@@ -96,9 +99,9 @@ close:
 open-dir: checkpoints/checkpoint1
 link: db/OPTIONS-000003 -> checkpoints/checkpoint1/OPTIONS-000003
 open-dir: checkpoints/checkpoint1
-create: checkpoints/checkpoint1/marker.format-version.000001.005
-sync: checkpoints/checkpoint1/marker.format-version.000001.005
-close: checkpoints/checkpoint1/marker.format-version.000001.005
+create: checkpoints/checkpoint1/marker.format-version.000001.006
+sync: checkpoints/checkpoint1/marker.format-version.000001.006
+close: checkpoints/checkpoint1/marker.format-version.000001.006
 sync: checkpoints/checkpoint1
 close: checkpoints/checkpoint1
 create: checkpoints/checkpoint1/MANIFEST-000001
@@ -153,7 +156,7 @@ CURRENT
 LOCK
 MANIFEST-000001
 OPTIONS-000003
-marker.format-version.000004.005
+marker.format-version.000005.006
 marker.manifest.000001.MANIFEST-000001
 
 list checkpoints/checkpoint1
@@ -163,7 +166,7 @@ list checkpoints/checkpoint1
 000007.sst
 MANIFEST-000001
 OPTIONS-000003
-marker.format-version.000001.005
+marker.format-version.000001.006
 marker.manifest.000001.MANIFEST-000001
 
 open checkpoints/checkpoint1 readonly

diff --git a/testdata/event_listener b/testdata/event_listener
@@ -38,6 +38,10 @@ create: db/marker.format-version.000004.005
 close: db/marker.format-version.000004.005
 sync: db
 upgraded to format version: 005
+create: db/marker.format-version.000005.006
+close: db/marker.format-version.000005.006
+sync: db
+upgraded to format version: 006
 create: db/MANIFEST-000003
 close: db/MANIFEST-000001
 sync: db/MANIFEST-000003
@@ -205,9 +209,9 @@ close:
 open-dir: checkpoint
 link: db/OPTIONS-000004 -> checkpoint/OPTIONS-000004
 open-dir: checkpoint
-create: checkpoint/marker.format-version.000001.005
-sync: checkpoint/marker.format-version.000001.005
-close: checkpoint/marker.format-version.000001.005
+create: checkpoint/marker.format-version.000001.006
+sync: checkpoint/marker.format-version.000001.006
+close: checkpoint/marker.format-version.000001.006
 sync: checkpoint
 close: checkpoint
 create: checkpoint/MANIFEST-000017