UT_ORMSchemaEditor.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_ORMSchemaEditor.h
 *
 * COMMENTS:
 *
 *
 */

#ifndef __UT_ORMSCHEMAEDITOR_H__
#define __UT_ORMSCHEMAEDITOR_H__

#include "UT_API.h"

#include "UT_Map.h"
#include "UT_ORMDDLReference.h"
#include "UT_ORMModelState.h"
#include "UT_SQL.h"

class UT_SqlOrm;
class UT_IORMConstraint;

class UT_IORMSchemaEditor
{
public:
    virtual ~UT_IORMSchemaEditor();
    UT_NON_COPYABLE(UT_IORMSchemaEditor);

    virtual void deleteModel(
            const UT_ORMModelState& model,
            bool handle_autom2m = true);
    virtual void createModel(const UT_ORMModelState& model);
    virtual void addField(
            const UT_ORMModelState& model,
            const UT_ORMModelStateField& field);
    virtual void removeField(
            const UT_ORMModelState& model,
            const UT_ORMModelStateField& field);
    virtual void renameField(
            const UT_ORMModelState& model,
            const UT_ORMModelStateField& from_field,
            const UT_ORMModelStateField& to_field);
    virtual void addConstraint(
            const UT_ORMModelState& model,
            UT_IORMConstraint* constraint);
    virtual void alterDBTable(
            const UT_ORMModelState& old_model,
            const UT_ORMModelState& new_model);
    virtual void alterField(
            const UT_ORMModelState& model,
            const UT_ORMModelStateField& old_field,
            const UT_ORMModelStateField& new_field);

    UT_StringHolder uniqueSql(
            const UT_ORMModelState& model,
            const UT_StringArray& fields,
            const UT_StringHolder& name,
            const UT_StringHolder& condition);
    UT_UniquePtr<UT_ORMDDLStatement> createUniqueSql(
            const UT_ORMModelState& model,
            const UT_StringArray& fields,
            const UT_StringHolder& name,
            const UT_StringHolder& condition) const;
    UT_UniquePtr<UT_ORMDDLStatement> deleteUniqueSql(
            const UT_ORMModelState& model,
            const UT_StringHolder& name,
            const UT_StringHolder& condition) const;

    const UT_StringArray& collectedSql() const { return myCollectedSql; }

    UT_ErrorCode error() const;

    UT_SqlDatabase& connection();
protected:
    UT_IORMSchemaEditor(UT_SqlOrm& orm, bool collect_sql = false);

    UT_StringHolder columnSql(
            const UT_ORMModelState& model,
            const UT_ORMModelStateField& field);
    void execute(const UT_StringHolder& sql);
    UT_StringHolder tableSql(const UT_ORMModelState& model);
    UT_StringHolder typeString_(UT_ORMColumnType col_type) const;

    UT_SqlOrm& myORM;

    UT_StringHolder mySqlDeleteTable;

    UT_Map<UT_ORMColumnType, UT_StringHolder> myColumnTypeToDBType;

    UT_Array<UT_UniquePtr<UT_IORMDDLReference>> myDeferredSql;

    UT_ErrorCode myErrorCode;

    UT_StringArray myCollectedSql;
    bool myCollectSql = false;

    UT_UniquePtr<UT_AutoSqlTransaction> myTransaction;
};

class UT_ORMSqliteSchemaEditor : public UT_IORMSchemaEditor
{
public:
    UT_ORMSqliteSchemaEditor(UT_SqlOrm& orm, bool collect_sql);
    void addConstraint(
            const UT_ORMModelState& state,
            UT_IORMConstraint* constraint) override;
    void addField(
            const UT_ORMModelState& model,
            const UT_ORMModelStateField& field) override;
    void alterDBTable(
            const UT_ORMModelState& old_model,
            const UT_ORMModelState& new_model) override;
    void removeField(
            const UT_ORMModelState& model,
            const UT_ORMModelStateField& field) override;
    void alterField(
            const UT_ORMModelState& model,
            const UT_ORMModelStateField& old_field,
            const UT_ORMModelStateField& new_field) override;

private:
    void remakeTable_(
            const UT_ORMModelState& model,
            const UT_ORMModelStateField* create_field,
            const UT_ORMModelStateField* delete_field,
            const std::pair<
                    const UT_ORMModelStateField*,
                    const UT_ORMModelStateField*> alter_field
            = {nullptr, nullptr});
};

#endif // __UT_ORMSCHEMAEDITOR_H__