@hashgraph/solo
    Preparing search index...

    Interface Schema<T>

    Defines a schema which can be used to convert input data into a model instance.

    interface Schema<T> {
        classCtor: ClassConstructor<T>;
        migrations: SchemaMigration[];
        name: string;
        version: Version<number>;
        transform(data: object, sourceVersion?: Version<number>): Promise<T>;
        validateMigrations(): Promise<void>;
    }

    Type Parameters

    • T

    Implemented by

    Index

    Properties

    classCtor migrations name version

    Methods

    transform validateMigrations

    Properties

    classCtor: ClassConstructor<T>

    The class constructor for the model. This is used to create instances of the model from the input data.

    migrations: SchemaMigration[]

    The list of migrations which can be applied to the model data. Migrations are applied in order to bring the input data up to the current schema version.

    name: string

    The name of the schema. Schema name are unique and should be related to the specific configuration model which the schema represents.

    version: Version<number>

    The current version of the schema. This is used to determine if the input data needs to be migrated before being applied to a model.

    Methods

    • Transforms the plain javascript object into an instance of the model class. Applies any necessary migrations to the input data before creating the model instance.

      Parameters

      • data: object

        The plain javascript object to be transformed.

      • OptionalsourceVersion: Version<number>

        The version of the input data. If not provided, the version is introspected from or otherwise assumed based on the provided plain javascript object.

      Returns Promise<T>

      an instance of the model class.

    • Validates the migrations for the schema. This method should be called during the application startup to ensure that the migrations are correctly defined.

      Due to the risk imposed by performing migrations on production data, we cannot afford to allow production code to ever perform a partial migration. A partial migration is defined as a series of migrations which result in the final migrated data being a version that is less than the current schema version. Executing a partial migration may leave the data in a state in which future modifications result in a corrupted object.

      Therefore, we should always ensure the migrations are correctly defined and that the migration sequence is unbroken. All actual migrations of data should validate the resulting object has reached the current schema version.

      The intent of this method is to ensure that the migrations are correctly defined during application startup and unit testing.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods