Lightweight::SqlAlterTableQueryBuilder Class Reference

Query builder for building ALTER TABLE queries. More...

#include <Migrate.hpp>

Public Member Functions
	SqlAlterTableQueryBuilder (SqlAlterTablePlan &plan)
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	RenameTo (std::string_view newTableName)
	Renames the table.
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	AddColumn (std::string columnName, SqlColumnTypeDefinition columnType)
	Adds a new column to the table that is non-nullable.
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	AddNotRequiredColumn (std::string columnName, SqlColumnTypeDefinition columnType)
	Adds a new column to the table that is nullable.
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	AlterColumn (std::string columnName, SqlColumnTypeDefinition columnType, SqlNullable nullable)
	Alters the column to have a new non-nullable type.
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	RenameColumn (std::string_view oldColumnName, std::string_view newColumnName)
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	DropColumn (std::string_view columnName)
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	AddIndex (std::string_view columnName)
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	AddUniqueIndex (std::string_view columnName)
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	DropIndex (std::string_view columnName)
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	AddForeignKey (std::string columnName, SqlForeignKeyReferenceDefinition referencedColumn)
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	AddForeignKeyColumn (std::string columnName, SqlColumnTypeDefinition columnType, SqlForeignKeyReferenceDefinition referencedColumn)
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	AddNotRequiredForeignKeyColumn (std::string columnName, SqlColumnTypeDefinition columnType, SqlForeignKeyReferenceDefinition referencedColumn)
LIGHTWEIGHT_API SqlAlterTableQueryBuilder &	DropForeignKey (std::string columnName)
	Drops a foreign key for the column columnName from the table.

Detailed Description

Query builder for building ALTER TABLE queries.

See also

SqlQueryBuilder

Definition at line 71 of file Migrate.hpp.

Constructor & Destructor Documentation

SqlAlterTableQueryBuilder()

Lightweight::SqlAlterTableQueryBuilder::SqlAlterTableQueryBuilder ( SqlAlterTablePlan &  plan )

inlineexplicit

Definition at line 74 of file Migrate.hpp.

Member Function Documentation

AlterColumn()

LIGHTWEIGHT_API SqlAlterTableQueryBuilder & Lightweight::SqlAlterTableQueryBuilder::AlterColumn	(	std::string	columnName,
		SqlColumnTypeDefinition	columnType,
		SqlNullable	nullable
	)

Alters the column to have a new non-nullable type.

Parameters

columnName	The name of the column to alter.
columnType	The new type of the column.
nullable	The new nullable state of the column.

Returns

The current query builder for chaining.

See also

SqlColumnTypeDefinition

auto stmt = SqlStatement();
auto sqlMigration = stmt.Migration()
                        .AlterTable("Table")
                        .AlterColumn("column", Integer {}, SqlNullable::NotNull)
                        .GetPlan().ToSql();
for (auto const& sql: sqlMigration)
    stmt.ExecuteDirect(sql);

RenameColumn()

LIGHTWEIGHT_API SqlAlterTableQueryBuilder & Lightweight::SqlAlterTableQueryBuilder::RenameColumn	(	std::string_view	oldColumnName,
		std::string_view	newColumnName
	)

Renames a column.

Parameters

oldColumnName	The old column name.
newColumnName	The new column name.

DropColumn()

LIGHTWEIGHT_API SqlAlterTableQueryBuilder & Lightweight::SqlAlterTableQueryBuilder::DropColumn

(

std::string_view

columnName

)

Drops a column from the table.

Parameters

columnName

The name of the column to drop.

AddIndex()

LIGHTWEIGHT_API SqlAlterTableQueryBuilder & Lightweight::SqlAlterTableQueryBuilder::AddIndex

(

std::string_view

columnName

)

Add an index to the table for the specified column.

Parameters

columnName

The name of the column to index.

SqlQueryBuilder q;
q.Migration().AlterTable("Table").AddIndex("column");
// Will execute CREATE INDEX "Table_column_index" ON "Table"("column");

AddUniqueIndex()

LIGHTWEIGHT_API SqlAlterTableQueryBuilder & Lightweight::SqlAlterTableQueryBuilder::AddUniqueIndex

(

std::string_view

columnName

)

Add an index to the table for the specified column that is unique.

Parameters

columnName

The name of the column to index.

SqlQueryBuilder q;
q.Migration().AlterTable("Table").AddUniqueIndex("column");
// Will execute CREATE UNIQUE INDEX "Table_column_index" ON "Table"("column");

DropIndex()

LIGHTWEIGHT_API SqlAlterTableQueryBuilder & Lightweight::SqlAlterTableQueryBuilder::DropIndex

(

std::string_view

columnName

)

Drop an index from the table for the specified column.

Parameters

columnName

The name of the column to drop the index from.

SqlQueryBuilder q;
q.Migration().AlterTable("Table").DropIndex("column");
// Will execute DROP INDEX "Table_column_index";

AddForeignKey()

LIGHTWEIGHT_API SqlAlterTableQueryBuilder & Lightweight::SqlAlterTableQueryBuilder::AddForeignKey	(	std::string	columnName,
		SqlForeignKeyReferenceDefinition	referencedColumn
	)

Adds a foreign key column columnName to referencedColumn to an existing column.

Parameters

columnName	The name of the column to add.
referencedColumn	The column to reference.

AddForeignKeyColumn()

LIGHTWEIGHT_API SqlAlterTableQueryBuilder & Lightweight::SqlAlterTableQueryBuilder::AddForeignKeyColumn	(	std::string	columnName,
		SqlColumnTypeDefinition	columnType,
		SqlForeignKeyReferenceDefinition	referencedColumn
	)

Adds a foreign key column columnName of type columnType to referencedColumn.

Parameters

columnName	The name of the column to add.
columnType	The type of the column to add.
referencedColumn	The column to reference.

AddNotRequiredForeignKeyColumn()

LIGHTWEIGHT_API SqlAlterTableQueryBuilder & Lightweight::SqlAlterTableQueryBuilder::AddNotRequiredForeignKeyColumn	(	std::string	columnName,
		SqlColumnTypeDefinition	columnType,
		SqlForeignKeyReferenceDefinition	referencedColumn
	)

Adds a nullable foreign key column columnName of type columnType to referencedColumn.

Parameters

columnName	The name of the column to add.
columnType	The type of the column to add.
referencedColumn	The column to reference.

---

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

• Lightweight/SqlQuery/Migrate.hpp