UT_ORMMigration.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_ORMMigration.h
 *
 * COMMENTS:
 *
 */

#ifndef __UT_ORMMIGRATION_H__
#define __UT_ORMMIGRATION_H__

#include "UT_API.h"

#include "UT_Array.h"
#include "UT_ORMOperation.h"
#include "UT_StringHolder.h"
#include "UT_UniquePtr.h"

class UT_ORMMigrationState;
class UT_ORMSchemaEditor;

class UT_API UT_ORMMigration
{
public:
    explicit UT_ORMMigration(
            const UT_StringHolder& model_name,
            const UT_StringHolder& name)
        : myModelName(model_name), myName(name)
    {
        myHistoryId.format("{}.{}", myModelName, myName);
    }
    ~UT_ORMMigration() = default;
    UT_NON_COPYABLE(UT_ORMMigration);

    void mutateState(UT_ORMMigrationState& state, UT_ErrorCode& ec) const;
    UT_ORMMigrationState apply(
            UT_ORMMigrationState& project_state,
            UT_IORMSchemaEditor& schema_editor,
            UT_ErrorCode& ec);

    UT_ORMCreateTableOperation& createModel(const UT_StringHolder& table_name);
    UT_ORMDropTableOperation& dropModel(const UT_StringHolder& table_name);
    UT_ORMAddFieldOperation& addField(
            const UT_StringHolder& model_name,
            UT_ORMModelStateField&& col);
    UT_ORMRenameFieldOperation& renameField(
            const UT_StringHolder& model_name,
            const UT_StringHolder& cur_name,
            const UT_StringHolder& new_name);
    UT_ORMRemoveFieldOperation& removeField(
            const UT_StringHolder& model_name,
            const UT_StringHolder& name);
    UT_ORMUniqueConstraint& addUniqueConstraint(
            const UT_StringHolder& model_name,
            const UT_StringHolder& name,
            const std::initializer_list<UT_StringHolder>& fields,
            const UT_StringHolder& condition = UT_StringHolder::theEmptyString);

    void addDependency(const UT_StringHolder& mig_name)
    {
        myDependencies.emplace_back(mig_name);
    }
    const UT_StringArray& dependencies() const { return myDependencies; }

    const UT_StringHolder& historyId() const { return myHistoryId; }

    const UT_StringHolder myModelName;
    const UT_StringHolder myName;

protected:
    UT_StringHolder myHistoryId;
    UT_StringArray myDependencies;
    UT_Array<UT_UniquePtr<UT_IORMOperation>> myOperations;
};

#endif // __UT_ORMMIGRATION_H__