UT_ORMMigrationState.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_ORMMigrationState.h
 *
 * COMMENTS:
 *
 *
 */

#ifndef __UT_ORMMIGRATIONSTATE_H__
#define __UT_ORMMIGRATIONSTATE_H__

#include "UT_API.h"

#include "UT_ArrayStringMap.h"
#include "UT_COWValue.h"
#include "UT_ErrorCode.h"
#include "UT_Function.h"
#include "UT_ORMModelState.h"

class UT_ORMModelMeta;

class UT_API UT_ORMMigrationState
{
public:
    using update_func_t = UT_Function<void(UT_ORMModelState&)>;
    using model_t = UT_COWValue<UT_ORMModelState>;

    bool addModel(UT_ORMModelState&& model);
    bool deleteModel(const UT_StringRef& name);
    void updateModel(const UT_StringRef& name, const update_func_t& update);
    const model_t& findModel(const UT_StringRef& name) const;
    bool renameModel(
            const UT_StringRef& old_model,
            const UT_StringHolder& new_model);

    bool matchesForMeta(
            const UT_ORMModelMeta& meta,
            UT_StringHolder& message,
            UT_ErrorCode& ec) const;

private:
    UT_ArrayStringMap<model_t> myModels;
};

#endif // __UT_ORMMIGRATIONSTATE_H__