データパッケージのバージョン
非公式翻訳 (Unofficial translation). これはデータパッケージスタンダードの有志による日本語訳です。 正典は英語原典 datapackage.org 。未訳の箇所は英語の原文を参照してください。
| Authors | Rufus Pollock |
|---|
仕様
データパッケージのバージョン形式は、Semantic Versioning 仕様の形式 MAJOR.MINOR.PATCH に従う。
バージョン番号、およびその変化のしかたは、データパッケージがあるバージョンから次のバージョンへどのように変更されたかについての意味を伝える。
データパッケージのバージョン番号 MAJOR.MINOR.PATCH に対して、以下の場合にそれぞれを増分する。
互換性のない変更を行う場合は MAJOR バージョン。例:
- データパッケージ、リソース、またはフィールドの
nameやidentifierを変更する - フィールドを追加・削除・並べ替えする
- フィールドの
typeやformatを変更する - フィールドの
constraintをより制限的なものに変更する - 別のデータリソースから参照されているデータを結合・分割・削除する、またはその意味を変更する
後方互換性を保ちながらデータを追加したりメタデータを変更したりする場合は MINOR バージョン。例:
- データパッケージに新しいデータリソースを追加する
- 既存のデータリソースに新しいデータを追加する
- フィールドの
constraintをより制限の緩いものに変更する - 別のデータリソースへの参照を更新する
- 参照先データの変更を反映してデータを変更する
後方互換性を保ちながら修正を行う場合は PATCH バージョン。例:
- 既存データの誤りを訂正する
- 説明的なメタデータのプロパティを変更する
シナリオ
- 公開協議を通じてデータを開発している。最初のデータリリースは 0.1.0 から始める
- データを初めてリリースする。バージョン 1.0.0 を使用する
- 既存のリリースに先月分のデータを追加する。MINOR バージョン番号を増分する
- データに列を追加する。MAJOR バージョン番号を増分する
- データを新しい
URLやpathに移動する。バージョン番号は変更しない title、description、その他の説明的なメタデータを変更する。PATCH バージョンを増分する- 値を修正してデータ入力の誤りを訂正する。PATCH バージョンを増分する
- 外部キーの参照テーブルにおいてデータの行を分割する。MAJOR バージョン番号を増分する
- 外部キーの参照テーブルの新しいバージョンを参照するようにデータとスキーマを更新する。MINOR バージョン番号を増分する