Lightweight 0.1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
SqlMigrationQueryBuilder Class Referencefinal
Query Builder

Query builder for building SQL migration queries. More...

#include <Migrate.hpp>

Public Member Functions

 SqlMigrationQueryBuilder (SqlQueryFormatter const &formatter)
 
LIGHTWEIGHT_API SqlMigrationQueryBuilder & CreateDatabase (std::string_view databaseName)
 Creates a new database.
 
LIGHTWEIGHT_API SqlMigrationQueryBuilder & DropDatabase (std::string_view databaseName)
 Drops a database.
 
LIGHTWEIGHT_API SqlCreateTableQueryBuilder CreateTable (std::string_view tableName)
 Creates a new table.
 
LIGHTWEIGHT_API SqlAlterTableQueryBuilder AlterTable (std::string_view tableName)
 Alters an existing table.
 
LIGHTWEIGHT_API SqlMigrationQueryBuilder & DropTable (std::string_view tableName)
 Drops a table.
 
LIGHTWEIGHT_API SqlMigrationQueryBuilder & RawSql (std::string_view sql)
 Executes raw SQL.
 
LIGHTWEIGHT_API SqlMigrationQueryBuilder & Native (std::function< std::string(SqlConnection &)> callback)
 Executes SQL interactively via a callback.
 
LIGHTWEIGHT_API SqlMigrationQueryBuilder & BeginTransaction ()
 Starts a transaction.
 
LIGHTWEIGHT_API SqlMigrationQueryBuilder & CommitTransaction ()
 Commits a transaction.
 
LIGHTWEIGHT_API SqlMigrationPlan const & GetPlan () const &
 Gets the migration plan.
 
LIGHTWEIGHT_API SqlMigrationPlan GetPlan () &&
 

Detailed Description

Query builder for building SQL migration queries.

Definition at line 183 of file Migrate.hpp.

Constructor & Destructor Documentation

◆ SqlMigrationQueryBuilder()

SqlMigrationQueryBuilder::SqlMigrationQueryBuilder ( SqlQueryFormatter const &  formatter)
inlineexplicit

Definition at line 186 of file Migrate.hpp.

Member Function Documentation

◆ GetPlan()

LIGHTWEIGHT_API SqlMigrationPlan SqlMigrationQueryBuilder::GetPlan ( ) &&

Gets the migration plan.

Note
This method is destructive and will invalidate the current builder.
The documentation for this class was generated from the following file: