Public Attributes
std::vector< MigrationTimestamp >	dependencies {}
	Migrations that must be applied before this one.

std::string_view	author {}
	Author of the migration. Recorded in schema_migrations when the migration is applied.

std::string_view	description {}
	Long-form description. Recorded in schema_migrations when the migration is applied.

bool	requiresBackup = false
	Whether running the migration requires a backup; see `MigrationBase::RequiresBackup`.

Detailed Description

Represents a single unique SQL migration.

This class is a convenience class that can be used to create a migration.

Optional metadata attached to a Migration at construction time.

All fields are optional. Unset fields behave as if the feature were not used (e.g. empty dependencies preserves timestamp order).

Definition at line 1429 of file SqlMigration.hpp.

Member Data Documentation

std::vector<MigrationTimestamp> Lightweight::SqlMigration::MigrationMetadata::dependencies {}

Migrations that must be applied before this one.

Definition at line 1432 of file SqlMigration.hpp.

std::string_view Lightweight::SqlMigration::MigrationMetadata::author {}

Author of the migration. Recorded in schema_migrations when the migration is applied.

Definition at line 1434 of file SqlMigration.hpp.

std::string_view Lightweight::SqlMigration::MigrationMetadata::description {}

Long-form description. Recorded in schema_migrations when the migration is applied.

Definition at line 1436 of file SqlMigration.hpp.

bool Lightweight::SqlMigration::MigrationMetadata::requiresBackup = false

Whether running the migration requires a backup; see MigrationBase::RequiresBackup.

Definition at line 1438 of file SqlMigration.hpp.

The documentation for this struct was generated from the following file: