bw2io.migrations#

Module Contents#

Classes#

Migration

A migration is a set of data that can be used to modify a database.

_Migrations

Functions#

create_core_migrations()

Add pre-defined core migrations data files.

Attributes#

migrations

class bw2io.migrations.Migration(*args, **kwargs)[source]#

Bases: bw2data.data_store.DataStore

Inheritance diagram of bw2io.migrations.Migration

A migration is a set of data that can be used to modify a database.

Migrations are stored in the migrations directory of the project. They are stored as JSON files, and are registered in the migrations.json file.

Methods#

write(data, description)

Write migration data. Requires a description.

load()

Load migration data.

validate()

Validate migration data.

property description[source]#
_metadata[source]#
load()[source]#
validate(*args, **kwargs)[source]#
write(data, description)[source]#

Write migration data. Requires a description.

Parameters#
datadict

Migration data.

descriptionstr

Description of the migration.

class bw2io.migrations._Migrations[source]#

Bases: bw2data.serialization.SerializedDict

Inheritance diagram of bw2io.migrations._Migrations
filename = 'migrations.json'[source]#
bw2io.migrations.create_core_migrations()[source]#

Add pre-defined core migrations data files.

bw2io.migrations.migrations[source]#