UT_ORMMigrationBuilder.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_ORMMigrationBuilder.h
 *
 * COMMENTS:
 *
 *      The UT_ORMMigrationBuilder is the object that defines all of the
 *      various migrations that are required given a set of model metas. The
 *      model metas are based on the currently registerd and yet to be built
 *      models in the UT_SQLORM object. This means during the lifetime of a
 *      program multiple builders could be generated each defining a subset of
 *      all model meta objects of a program.
 *
 *      The migration builder also tries to verify the various operations make
 *      sense for a given model. For example, trying to drop a column that
 *      doesnt exist given the current steps of the migration for a model. The
 *      migration also tries to verify that the final result of the migration
 *      matches the current table as defined in the build step. These all help
 *      to ensure that the database and the current program are in sync with
 *      each other.
 *
 *      See UT_SQLORM for detailed information on the entire system.
 */

#ifndef __UT_ORMMIGRATIONBUILDER_H__
#define __UT_ORMMIGRATIONBUILDER_H__

#include "UT_API.h"

#include "UT_StringHolder.h"
#include "UT_Array.h"
#include "UT_UniquePtr.h"
#include "UT_Map.h"
#include "UT_NonCopyable.h"
#include "UT_ORMColumn.h"
#include "UT_ErrorCode.h"
#include "UT_ORMMigration.h"

class UT_IORMOperation;
class UT_ORMCreateTableOperation;
class UT_ORMDropTableOperation;
class UT_ORMAddFieldOperation;
class UT_ORMRenameFieldOperation;
class UT_ORMRemoveFieldOperation;
class UT_ORMMigrationBuilder;
class UT_ORMModelMeta;
class UT_ORMMigrationResult;

class UT_API UT_ORMMigrationBuilder
{
public:
    UT_ORMMigrationBuilder() = default;
    UT_NON_COPYABLE(UT_ORMMigrationBuilder);
    ~UT_ORMMigrationBuilder();

    UT_ORMMigration& addMigration(
            const UT_StringHolder& model_mig_name,
            const UT_StringHolder& mig_name);

    const UT_Array<UT_SharedPtr<UT_ORMMigration>>& migrations() const
    {
        return myMigrations;
    }

    const UT_StringHolder& errorMessage() const { return myErrorMessage; }
    const UT_ErrorCode& errorCode() const { return myErrorCode; }

private: 
    UT_Array<UT_SharedPtr<UT_ORMMigration>> myMigrations;
    UT_StringHolder myErrorMessage;
    UT_ErrorCode myErrorCode;
};

#endif // __UT_ORMMIGRATIONBUILDER_H__