Lightweight::SqlCreateIndexPlan Struct Reference

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.

Detailed Description

Represents a SQL CREATE INDEX plan for migrations.

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

Definition at line 490 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 493 of file MigrationPlan.hpp.

indexName

std::string Lightweight::SqlCreateIndexPlan::indexName

The name of the index to create.

Definition at line 496 of file MigrationPlan.hpp.

tableName

std::string Lightweight::SqlCreateIndexPlan::tableName

The name of the table to create the index on.

Definition at line 499 of file MigrationPlan.hpp.

columns

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

The columns to include in the index.

Definition at line 502 of file MigrationPlan.hpp.

unique

bool Lightweight::SqlCreateIndexPlan::unique { false }

If true, creates a UNIQUE index.

Definition at line 505 of file MigrationPlan.hpp.

ifNotExists

bool Lightweight::SqlCreateIndexPlan::ifNotExists { false }

If true, generates CREATE INDEX IF NOT EXISTS.

Definition at line 508 of file MigrationPlan.hpp.

---

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

• Lightweight/SqlQuery/MigrationPlan.hpp