MysqlSqlUtil.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// @file MysqlSqlUtil.qm Qore user module for working with MySQL SQL data

/*  MysqlSqlUtil.qm Copyright 2013 - 2016 Qore Technologies, sro

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/

// minimum required Qore version

// requires the SqlUtil module

// don't use "$" signs for variables and class members, assume local variable scope

// require type definitions everywhere

// enable all warnings


namespace MysqlSqlUtil {
     MysqlTable get_table(AbstractDatasource nds, string nname, *hash opts);


     MysqlDatabase get_database(AbstractDatasource nds, *hash opts);


    parse_schema_name(string nname, reference schema, reference name);


class MysqlIndex : public SqlUtil::AbstractIndex {

public:
        public :
            string type;

public:

        constructor(string n_name, bool n_unique, hash n_cols, string n_type = "BTREE") ;


        string getCreateSql(string table_name, *hash opt);


        private bool equalImpl(AbstractIndex ix);


        string getRenameSql(string table_name, string new_name);


        string getDropSql(string table_name);

    };

class MysqlForeignConstraint : public SqlUtil::AbstractForeignConstraint {

public:
        constructor(string n, Columns c, ForeignConstraintTarget t) ;


        string getCreateSql(string table_name, *hash opt);


        softlist getRenameSql(string table_name, string new_name);


        string getCreateSql(string name, string table_name, *hash opt);


        string getAddSql(string name, string table_name, *hash opt);


        string getDropSql(string table_name);

    };

class MysqlColumn : public SqlUtil::AbstractColumn {

public:
        public :
            int byte_size;

public:

        constructor(string n, string nt, *string qt, int sz, bool nul, *string dv, *string cm, softint bs) ;



        softlist getAddColumnSql(AbstractTable t);


        string getCreateSql(AbstractTable t);



        softlist getModifySqlImpl(AbstractTable t, AbstractColumn col, *hash opt);



        string getRenameSql(AbstractTable t, string new_name);


        private bool equalImpl(AbstractColumn c);

    };

class MysqlNumericColumn : public MysqlColumn,public  SqlUtil::NumericColumnInfo {

public:
        public :
            bool unsigned;
            bool auto_increment;
            // auto-incrememnt columns must be either "unique" or "primary key" in mysql
            bool pk = False;

public:

        constructor(string n, string nt, *string qt, int sz, bool nul, *string dv, *string cm, softint bs, softint n_scale, bool n_unsigned = False, bool n_auto_increment = False, bool n_pk = False) ;


        string getNativeTypeString();


        private bool equalImpl(AbstractColumn c);

    };

class MysqlUniqueConstraintCommon : public SqlUtil::AbstractUniqueConstraint {

public:
        constructor();


        bool setIndexBase(string ix);


        clearIndex();


        abstract AbstractIterator keyIterator();

        getIndexSql(reference sql, string name, *hash opts);

    };

class MysqlUniqueConstraint : public SqlUtil::AbstractUniqueConstraint,public  MysqlUniqueConstraintCommon {

public:
        constructor(string n, hash n_cols) ;



        MysqlColumn memberGate(string k);


        string getCreateSql(string table_name, *hash opts);


        list getRenameSql(string table_name, string new_name);


        string getCreateSql(string name, string table_name, *hash opts);


        string getDropSql(string table_name);

    };

class MysqlPrimaryKey : public SqlUtil::AbstractPrimaryKey,public  MysqlUniqueConstraintCommon {

public:
        constructor();


        constructor(*hash c) ;



        MysqlColumn memberGate(string k);


        string getCreateSql(string table_name, *hash opts);


        softlist getRenameSql(string table_name, string new_name);


        string getDropSql(string table_name);


        bool supportsName();

    };

class MysqlTrigger : public SqlUtil::AbstractTrigger {

public:
        constructor(string n, string n_src) ;


        softlist getCreateSql(string table_name, *hash opt);


        softlist getDropSql(string table_name);


        private bool equalImpl(AbstractFunctionBase t);


        softlist getRenameSql(string table_name, string new_name);

    };

class MysqlFunction : public SqlUtil::AbstractFunction {

public:
        constructor(string n, string n_src) ;


        softlist getCreateSql(*hash opt);


        string getDropSql();


        private bool equalImpl(AbstractFunctionBase t);


        softlist getRenameSql(string new_name);

    };

class MysqlSequence : public SqlUtil::AbstractSequence {

public:
        private :
            string table_name;

public:

        constructor(string n_table_name, string n_name, number n_start = 1, number n_increment = 1, *softnumber n_end) ;


        string getCreateSql(*hash opt);


        string getRenameSql(string new_name);


        string getDropSql();

    };

class MysqlView : public SqlUtil::AbstractView {

public:

        public :
            *string tablecatalog;
            *string checkoption;
            *string definer;
            *string securitytype;

public:

        constructor(string n_name, string n_src, *string n_tablecatalog,
                    *string n_schema,
                    *string n_checkoption, *string n_definer,
                    *string n_securitytype, bool n_updatable)
 ;


        string getCreateSql(*hash opt);


        softlist getRenameSql(string new_name);

    };

class MysqlDatabase : public SqlUtil::AbstractDatabase {

public:
        public :
            const MysqlOptions = (
                "sequence_table": Type::String,
                "sequence_function": Type::String,
                );

            const MysqlSchemaDescriptionOptions = AbstractDatabase::SchemaDescriptionOptions + MysqlOptions;

            const MysqlDatabaseOptions = AbstractDatabase::DatabaseOptions + MysqlOptions;

            const MysqlSequenceTable = (
                "columns": (
                    "name": (
                        "qore_type": SqlUtil::VARCHAR,
                        "size": 40,
                        "notnull": True,
                    ),
                    "id": (
                        "qore_type": Type::Number,
                        "size": 14,
                        "notnull": True,
                    ),
                ),
                );

            const MyusqlCreationOptions = AbstractDatabase::CreationOptions;

            const MysqlSequenceFunction = "%s(seq_name varchar(40)) returns decimal(14)
begin
  update %s set id = last_insert_id(id + 1) where name = seq_name;
  return last_insert_id();
end";

            const MysqlComputeStatisticsOptions = ComputeStatisticsOptions + (
                "no-binlog"         : Type::Boolean,
                );

            const MysqlReclaimSpaceOptions = ReclaimSpaceOptions + (
                "no-binlog"         : Type::Boolean,
                );

public:

        private :
            string schema;

            Datasource seqds;

            string sequence_table = "sqlutil_sequences";
            string sequence_function = "sqlutil_nextval";

public:

        constructor(AbstractDatasource nds, *hash opts) ;


        private list featuresImpl();


        string getSchemaName();


        private AbstractSequence makeSequenceImpl(string name, number start = 1, number increment = 1, *softnumber end, *hash opts);


        private *AbstractSequence getSequenceImpl(string name);


        private *AbstractView getViewImpl(string name);


        private MysqlFunction makeFunctionImpl(string name, string src, *hash opts);


        private MysqlFunction makeProcedureImpl(string name, string src, *hash opts);


        private *AbstractFunction getFunctionImpl(string name);



private:
          static string makeParameter(hash row);
public:


        private AbstractFunction getProcedureImpl(string name);


        private list getDropSchemaSqlImpl(hash schema_hash, *hash opt);


        private list getAlignSqlImpl(hash schema_hash, *hash opt);


        private list listTablesImpl();



        private list listFunctionsImpl();



        private list listProceduresImpl();


        private list listSequencesImpl();


        private list listViewsImpl();


        private string getCreateSqlImpl(list l);


          static string getCreateSql(list l);

        private hash getDatabaseOptions();


        private hash getSchemaDescriptionOptions();


        private hash getComputeStatisticsOptions();


        private hash getReclaimSpaceOptions();


        private softint getNextSequenceValueImpl(string name);


        private softint getCurrentSequenceValueImpl(string name);


        private bool supportsSequencesImpl();


        private bool supportsTypesImpl();


        private bool supportsPackagesImpl();


        private bool rebuildIndexImpl(string name, *hash options);


        private computeStatisticsImpl(*hash options);


        private reclaimSpaceImpl(*hash options);

    };

class MysqlTable : public SqlUtil::AbstractTable {

public:
        public :
            const MysqlTypeMap = (
                "decimal": ("qore": Type::Number, "size": SZ_NUM,),
                "tinyint": ("qore": Type::Int, "ai": True,),
                "smallint": ("qore": Type::Int, "ai": True,),
                "mediumint": ("qore": Type::Int, "ai": True,),
                "int": ("qore": Type::Int, "ai": True,),
                "bigint": ("qore": Type::Int, "ai": True,),
                "float": ("qore": Type::Float, "ai": True,),
                "double": ("qore": Type::Float, "ai": True,),

                "date": ("qore": Type::Date,),
                "datetime": ("qore": Type::Date,),
                "timestamp": ("qore": Type::Date, "size": SZ_OPT, "size_range": (0, 6),"default_size": 6,),
                "time": ("qore": Type::Date, "size": SZ_OPT, "size_range": (0, 6),"default_size": 6,),
                "year": ("qore": Type::Int,),

                "char": ("qore": Type::String, "size": SZ_OPT, "size_range": (0, 255)),
                "varchar": ("qore": Type::String, "size": SZ_MAND, "size_range": (0, 65535)),

                "binary": ("qore": Type::Binary, "size": SZ_OPT, "size_range": (0, 255)),
                "varbinary": ("qore": Type::Binary, "size": SZ_MAND, "size_range": (0, 65535)),

                "tinytext": ("qore": Type::String,),
                "text": ("qore": Type::String,),
                "mediumtext": ("qore": Type::String,),
                "longtext": ("qore": Type::String,),

                "tinyblob": ("qore": Type::Binary,),
                "blob": ("qore": Type::Binary,),
                "mediumblob": ("qore": Type::Binary,),
                "longblob": ("qore": Type::Binary,),

                "bit": ("qore": Type::Int,),
                );

            const QoreTypeMap = (
                "integer": "bigint",
                "float": "double",
                "number": "decimal",
                "string": "varchar",
                "date": "datetime",
                "binary": "varbinary",
                "bool": "tinyint",
                SqlUtil::CHAR: "char",
                SqlUtil::CLOB: "mediumtext",
                SqlUtil::BLOB: "mediumblob",
                );

            const MysqlTableDescriptionHashOptions = AbstractTable::TableDescriptionHashOptions + (
                "engine": Type::String,
                );


            const MysqlColumnDescOptions = AbstractTable::ColumnDescOptions + (
                "unsigned": Type::Boolean,
                "auto_increment": Type::Boolean,
                "pk": Type::Boolean,
                );

            const MysqlIndexOptions = AbstractTable::IndexOptions;

            const MysqlConstraintOptions = AbstractTable::ConstraintOptions + MysqlIndexOptions + (
                "index": Type::String,
                );

            const MysqlTableCreationOptions = AbstractTable::TableCreationOptions + MysqlConstraintOptions;

            const MysqlAlignTableOptions = AbstractTable::AlignTableOptions + MysqlTableCreationOptions;

            const MysqlCopMap = DefaultCopMap + (
                COP_CAST: (
                    "code": string (string cve, list args) {
                        string name = QoreTypeMap{args[0]} ?? args[0];
                        if (name == "varchar") name = "char"; // NOTE: due to current MariaSQL issue ("ERROR 1064 (42000)")
                        hash desc = MysqlTypeMap{name};
                        string sql = sprintf ("cast(%s as %s", cve, name);
                        switch (name);

                        sql += ")";
                        return sql;
                    },
                ),
                COP_PREPEND: (
                    "arg": Type::String,
                    "sqlvalue": True,
                    "code": string (string cve, string arg) {
                        return sprintf("concat(%s,%s)", arg, cve);
                    },
                ),
                COP_APPEND: (
                    "arg": Type::String,
                    "sqlvalue": True,
                    "code": string (string cve, string arg) {
                        return sprintf("concat(%s,%s)", cve, arg);
                    },
                ),
                COP_YEAR: (
                    "code": string (string arg1, any arg) {
                        return sprintf("date_format(%s, '%%Y')", arg1);
                    }
                ),
                COP_YEAR_MONTH: (
                    "code": string (string arg1, any arg) {
                        return sprintf("date_format(%s, '%%Y-%%m')", arg1);
                    }
                ),
                COP_YEAR_DAY: (
                    "code": string (string arg1, any arg) {
                        return sprintf("date_format(%s, '%%Y-%%m-%%e')", arg1);
                    }
                ),
                COP_YEAR_HOUR: (
                    "code": string (string arg1, any arg) {
                        return sprintf("date_format(%s, '%%Y-%%m-%%e %%k')", arg1);
                    }
                ),
                );

public:

        private :
            string schema;
            string engine = "innodb";

public:

        constructor(AbstractDatasource nds, string nname, *hash opts) ;


        string getSqlName();


        private hash getTableCreationOptions();


        private hash getTableDescriptionHashOptions();


        private hash getColumnDescOptions();


        private hash getIndexOptions();


        private hash getConstraintOptions();


        private hash getAlignTableOptions();


        private hash getColumnOperatorMap();


        private bool checkExistenceImpl();


        private Columns describeImpl();


        private *string getCreatePrimaryKeySqlUnlocked(*hash opt, bool cache = True);


        private MysqlPrimaryKey getPrimaryKeyImpl();


        private Indexes getIndexesImpl();


        private ForeignConstraints getForeignConstraintsImpl(*hash opts);


        private Constraints getConstraintsImpl();


        private Triggers getTriggersImpl();


        string getCreateTableSqlImpl(*hash opt);


        bool hasArrayBind();


        private *list getCreateMiscSqlImpl(*hash opt, bool cache);


        private *list getAlignSqlImpl(AbstractTable table, *hash opt);


        private string getCreateSqlImpl(list l);


        private string getRenameSqlImpl(string new_name);


        private AbstractColumn addColumnImpl(string cname, hash opt, bool nullable = True);


        private setPrimaryKeyUnlocked(AbstractPrimaryKey pk);


        private addColumnToTableUnlocked(AbstractColumn c);


        private AbstractPrimaryKey addPrimaryKeyImpl(string cname, hash ch, *hash opt);


        private AbstractIndex addIndexImpl(string iname, bool enabled, hash ch, *hash opt);


        private AbstractForeignConstraint addForeignConstraintImpl(string cname, hash ch, string table, hash tch, *hash opt);


        private AbstractCheckConstraint addCheckConstraintImpl(string cname, string src, *hash opt);


        private AbstractUniqueConstraint addUniqueConstraintImpl(string cname, hash ch, *hash opt);


        private AbstractTrigger addTriggerImpl(string tname, string src, *hash opt);


        private bool tryInsertImpl(string sql, hash row);


        private hash getQoreTypeMapImpl();


        private hash getTypeMapImpl();


        private *string getSqlValueImpl(any v);



private:
          static *string getSqlValueIntern(any v);
public:



          static *string getSqlValue(any v);

        private bool emptyImpl();


        private preSetupTableImpl(reference desc, *hash opt);


        private setupTableImpl(hash desc, *hash opt);


        private bool constraintsLinkedToIndexesImpl();


        private bool uniqueIndexCreatesConstraintImpl();


        private bool supportsTablespacesImpl();


        private doSelectLimitOnlyUnlockedImpl(reference sql, reference args, *hash qh);


        private doSelectOrderByWithOffsetSqlUnlockedImpl(reference sql, reference args, *hash qh, *hash jch, *hash ch, *hash psch, list coll);


        private bool asteriskRequiresPrefix();


        private *hash doReturningImpl(hash opt, reference sql, list args);


        private list getGroupOrderByListUnlocked(string key, hash qh, *hash jch, *hash ch, *hash psch, list coll);


        bool hasReturningImpl();


        private copyImpl(AbstractTable old);

    };
};