Represents a SQL CREATE INDEX plan for migrations. More...

#include <MigrationPlan.hpp>

Public Attributes
std::string	schemaName
	The schema name of the table to create the index on.

std::string	indexName
	The name of the index to create.

std::string	tableName
	The name of the table to create the index on.

std::vector< std::string >	columns
	The columns to include in the index.

bool	unique { false }
	If true, creates a UNIQUE index.

bool	ifNotExists { false }
	If true, generates CREATE INDEX IF NOT EXISTS.

std::string	whereExpression {}

Detailed Description

Represents a SQL CREATE INDEX plan for migrations.

This structure represents a CREATE INDEX statement for a migration plan.

Definition at line 528 of file MigrationPlan.hpp.

Member Data Documentation

◆ schemaName

std::string Lightweight::SqlCreateIndexPlan::schemaName

The schema name of the table to create the index on.

Definition at line 531 of file MigrationPlan.hpp.

◆ indexName

std::string Lightweight::SqlCreateIndexPlan::indexName

The name of the index to create.

Definition at line 534 of file MigrationPlan.hpp.

◆ tableName

std::string Lightweight::SqlCreateIndexPlan::tableName

The name of the table to create the index on.

Definition at line 537 of file MigrationPlan.hpp.

◆ columns

std::vector<std::string> Lightweight::SqlCreateIndexPlan::columns

The columns to include in the index.

Definition at line 540 of file MigrationPlan.hpp.

◆ unique

bool Lightweight::SqlCreateIndexPlan::unique { false }

If true, creates a UNIQUE index.

Definition at line 543 of file MigrationPlan.hpp.

◆ ifNotExists

bool Lightweight::SqlCreateIndexPlan::ifNotExists { false }

If true, generates CREATE INDEX IF NOT EXISTS.

Definition at line 546 of file MigrationPlan.hpp.

◆ whereExpression

std::string Lightweight::SqlCreateIndexPlan::whereExpression {}

Pre-rendered predicate body of a partial (PostgreSQL / SQLite) or filtered (SQL Server) index, without the leading WHERE. Empty means the index covers every row. Emitted verbatim after the column list as WHERE <expression>; the caller is responsible for dialect-safe quoting. Mirrors SqlUpdateDataPlan::whereExpression.

Definition at line 553 of file MigrationPlan.hpp.

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

Lightweight/SqlQuery/MigrationPlan.hpp

Public Attributes