-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
storage.engine: add version file to store directory
This adds a new file VERSION to all store directories. This has a tiny bit of future proofing to allow us to have multiple databases with different data versions as well as a minimum value we support. When needed, having this file will allow us to automatically perform migrations during the call to rocksDB.Open(). Fixes #2718.
- Loading branch information
1 parent
5ba490a
commit 892a4ed
Showing
5 changed files
with
249 additions
and
2 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
// Copyright 2016 The Cockroach Authors. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
// implied. See the License for the specific language governing | ||
// permissions and limitations under the License. | ||
|
||
package engine | ||
|
||
import ( | ||
"encoding/json" | ||
"fmt" | ||
"io/ioutil" | ||
"os" | ||
"path/filepath" | ||
) | ||
|
||
const ( | ||
versionFilename = "VERSION" | ||
versionNoFile = -1 | ||
versionRocksDBCurrent = 1 | ||
versionRocksDBMinimum = 1 | ||
) | ||
|
||
// Version stores all the version information for all stores which is used as | ||
// the format for the version file. | ||
type Version struct { | ||
RocksDBData int `json:"RocksDBData"` | ||
} | ||
|
||
// currentVersions returns a Version struct with the most recent versions. | ||
var currentVersions = Version{ | ||
RocksDBData: versionRocksDBCurrent, | ||
} | ||
|
||
// noVersionFile is a copy of Version in which all values are set to blank | ||
var noVersionFile = Version{ | ||
RocksDBData: versionNoFile, | ||
} | ||
|
||
// getVersionFilename returns the filename for the version file stored in the | ||
// data directory. | ||
func getVersionFilename(dir string) string { | ||
return filepath.Clean(dir + "/" + versionFilename) | ||
} | ||
|
||
// getVersions returns the current on disk cockroach versions from the version | ||
// file for the passed in directory. If there is no version file yet, it | ||
// returns a versionNoFile for each version. | ||
func getVersions(dir string) (Version, error) { | ||
filename := getVersionFilename(dir) | ||
b, err := ioutil.ReadFile(filename) | ||
if err != nil { | ||
if os.IsNotExist(err) { | ||
return noVersionFile, nil | ||
} | ||
return Version{}, err | ||
} | ||
var ver Version | ||
if err := json.Unmarshal(b, &ver); err != nil { | ||
return Version{}, fmt.Errorf("version file %s is not formatted correctly; %s", filename, err) | ||
} | ||
return ver, nil | ||
} | ||
|
||
// writeVersionFile overwrites the version file to contain the latest versions. | ||
func writeVersionFile(dir string) error { | ||
filename := getVersionFilename(dir) | ||
if len(filename) == 0 { | ||
return nil | ||
} | ||
if err := os.Remove(filename); err != nil && !os.IsNotExist(err) { | ||
return err | ||
} | ||
b, err := json.Marshal(currentVersions) | ||
if err != nil { | ||
return err | ||
} | ||
return ioutil.WriteFile(filename, b, 0644) | ||
} |
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,75 @@ | ||
// Copyright 2016 The Cockroach Authors. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
// implied. See the License for the specific language governing | ||
// permissions and limitations under the License. | ||
|
||
package engine | ||
|
||
import ( | ||
"io/ioutil" | ||
"os" | ||
"reflect" | ||
"testing" | ||
|
||
"github.com/cockroachdb/cockroach/testutils" | ||
"github.com/cockroachdb/cockroach/util/leaktest" | ||
) | ||
|
||
// TestVersions verifies that both getVersions() and writeVersionFile work | ||
// correctly. | ||
func TestVersions(t *testing.T) { | ||
defer leaktest.AfterTest(t)() | ||
|
||
dir, err := ioutil.TempDir("", "testing") | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
defer func() { | ||
if err := os.RemoveAll(dir); err != nil { | ||
t.Fatal(err) | ||
} | ||
}() | ||
|
||
// First test when no file exists yet. | ||
ver, err := getVersions(dir) | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
if !reflect.DeepEqual(ver, noVersionFile) { | ||
t.Errorf("no file versions do not match, expected %+v got %+v", ver, noVersionFile) | ||
} | ||
|
||
// Write the current versions to the file. | ||
if err := writeVersionFile(dir); err != nil { | ||
t.Fatal(err) | ||
} | ||
ver, err = getVersions(dir) | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
if !reflect.DeepEqual(ver, currentVersions) { | ||
t.Errorf("current versions do not match, expected %+v got %+v", ver, currentVersions) | ||
} | ||
|
||
// Write gibberish to the file. | ||
filename := getVersionFilename(dir) | ||
if err := os.Remove(filename); err != nil { | ||
t.Fatal(err) | ||
} | ||
if err := ioutil.WriteFile(filename, []byte("cause an error please"), 0644); err != nil { | ||
t.Fatal(err) | ||
} | ||
if _, err = getVersions(dir); !testutils.IsError(err, | ||
"is not formatted correctly") { | ||
t.Errorf("expected error contains '%s', got '%s'", "is not formatted correctly", err) | ||
} | ||
} |