# SchemaMigration.hpp

This File On Github
Ask A Question

API: latest
module: oatpp
#include "oatpp/orm/SchemaMigration.hpp"

# SchemaMigration

Database schema migration helper.

namespace oatpp { namespace orm { 
  class SchemaMigration {}
}}

# Methods

Return Type Name Summary
[none] SchemaMigration Constructor.
[none] ~SchemaMigration Default virtual destructor.
void addText Add migration script as text.
void addFile Add migration script file.
void migrate Run database schema migration.

# SchemaMigration::SchemaMigration

Constructor.

SchemaMigration(const base::ObjectHandle<Executor>& executor, const oatpp::String& suffix = nullptr)

# SchemaMigration::~SchemaMigration

Default virtual destructor.

virtual ~SchemaMigration() = default

# SchemaMigration::addText

Add migration script as text.

  • @param version - schema version corresponding to this script.
  • @param script - script text.

void addText(v_int64 version, const oatpp::String& script)

# SchemaMigration::addFile

Add migration script file.

  • @param version - schema version corresponding to this script.
  • @param script - path to script file.

void addFile(v_int64 version, const oatpp::String& filename)

# SchemaMigration::migrate

Run database schema migration.

void migrate()