Represents a SQL column declaration. More...

#include <MigrationPlan.hpp>

Public Attributes
std::string	name
	The name of the column.

SqlColumnTypeDefinition	type
	The type of the column.

SqlPrimaryKeyType	primaryKey { SqlPrimaryKeyType::NONE }
	The primary key type of the column.

std::optional< SqlForeignKeyReferenceDefinition >	foreignKey {}
	The foreign key reference definition of the column.

bool	required { false }
	Indicates if the column is required (non-nullable).

bool	unique { false }
	Indicates if the column is unique.

std::string	defaultValue {}
	The default value of the column.

bool	index { false }
	Indicates if the column is indexed.

uint16_t	primaryKeyIndex { 0 }
	The 1-based index in the primary key (0 if not part of a specific order).

Detailed Description

Represents a SQL column declaration.

Definition at line 216 of file MigrationPlan.hpp.

Member Data Documentation

◆ name

std::string Lightweight::SqlColumnDeclaration::name

The name of the column.

Definition at line 219 of file MigrationPlan.hpp.

◆ type

SqlColumnTypeDefinition Lightweight::SqlColumnDeclaration::type

The type of the column.

Definition at line 222 of file MigrationPlan.hpp.

◆ primaryKey

SqlPrimaryKeyType Lightweight::SqlColumnDeclaration::primaryKey { SqlPrimaryKeyType::NONE }

The primary key type of the column.

Definition at line 225 of file MigrationPlan.hpp.

◆ foreignKey

std::optional<SqlForeignKeyReferenceDefinition> Lightweight::SqlColumnDeclaration::foreignKey {}

The foreign key reference definition of the column.

Definition at line 228 of file MigrationPlan.hpp.

◆ required

bool Lightweight::SqlColumnDeclaration::required { false }

Indicates if the column is required (non-nullable).

Definition at line 231 of file MigrationPlan.hpp.

◆ unique

bool Lightweight::SqlColumnDeclaration::unique { false }

Indicates if the column is unique.

Definition at line 234 of file MigrationPlan.hpp.

◆ defaultValue

std::string Lightweight::SqlColumnDeclaration::defaultValue {}

The default value of the column.

Definition at line 237 of file MigrationPlan.hpp.

◆ index

bool Lightweight::SqlColumnDeclaration::index { false }

Indicates if the column is indexed.

Definition at line 240 of file MigrationPlan.hpp.

◆ primaryKeyIndex

uint16_t Lightweight::SqlColumnDeclaration::primaryKeyIndex { 0 }

The 1-based index in the primary key (0 if not part of a specific order).

Definition at line 243 of file MigrationPlan.hpp.

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

Lightweight/SqlQuery/MigrationPlan.hpp

Public Attributes