PgsqlSqlUtilBase.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  PgsqlSqlUtilBase.qm Copyright (C) 2013 - 2024 Qore Technologies, s.r.o.
 
    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
 
 
// version history is included below in the docs
 
namespace PgsqlSqlUtilBase {
     PgsqlTable get_table(AbstractDatasource nds, string nname, *hash<auto> opts);
 
 
     PgsqlDatabase get_database(AbstractDatasource nds, *hash<auto> opts);
 
 
class PgsqlNumberDataType : public SqlUtil::AbstractNumericDataType {
 
public:
        constructor(string native_type, bool nullable, *hash<auto> options) ;
 
    };
 
    parse_schema_name(string nname, reference<string> schema, reference<string> name);
 
 
class PgsqlSavepointHelper : public AbstractSavepointHelper {
 
public:
        constructor(AbstractDatasource ds, *string savepoint) ;
 
 
protected:
         createSavepointImpl();
public:
 
 
protected:
         rollbackImpl();
public:
 
 
protected:
         deleteSavepointImpl();
public:
 
    };
 
class PgsqlType : public Qore::Serializable {
 
public:
            string name;
 
            string src;
 
        constructor(string n_name, string n_src);
 
 
        list<hash<auto>> getTypeList();
 
 
        list<string> getModifySql(PgsqlType old, *hash opt);
 
 
        string getCreateSql(*hash opt);
 
 
 
        string getDropSql(*hash opt);
 
 
 
        string getRenameSql(string new_name, *hash opt);
 
 
        bool equal(PgsqlType type);
 
    };
 
class PgsqlIndex : public SqlUtil::AbstractIndex {
 
public:
            *string tablespace;
 
        constructor(string n_name, bool n_unique, hash n_cols, *string n_tablespace) ;
 
 
        string getCreateSql(string table_name, *hash opt);
 
 
        string getDropSql(string table_name);
 
 
protected:
         bool equalImpl(AbstractIndex ix);
public:
 
 
        string getRenameSql(string table_name, string new_name);
 
 
    };
 
class PgsqlForeignConstraint : public SqlUtil::AbstractForeignConstraint {
 
public:
        constructor(string n, Columns c, ForeignConstraintTarget t) ;
 
 
        string getCreateSql(string table_name, *hash opt);
 
 
        string getDropSql(string table_name);
 
 
        softlist getRenameSql(string table_name, string new_name);
 
 
        string getCreateSql(string name, string table_name, *hash<auto> opt);
 
    };
 
class PgsqlCheckConstraint : public SqlUtil::AbstractCheckConstraint {
 
public:
        constructor(string n, string n_src) ;
 
 
        string getDropSql(string table_name);
 
 
        string getCreateSql(string table_name, *hash opt);
 
 
        list getRenameSql(string table_name, string new_name);
 
 
        string getCreateSql(string name, string table_name, *hash opt);
 
    };
 
class PgsqlColumn : public SqlUtil::AbstractColumn {
 
public:
            int byte_size;
 
protected:
         constructor();
public:
 
 
        constructor(string n, string nt, *string qt, int sz, bool nul, *string dv, *string cm, softint bs, *int scale) ;
 
 
        string getNativeTypeString();
 
 
 
        list getAddColumnSql(AbstractTable t);
 
 
 
        list getModifySqlImpl(AbstractTable t, AbstractColumn col, *hash opt);
 
 
 
        string getRenameSql(AbstractTable t, string new_name);
 
 
 
        string getDdlName(string name);
 
 
protected:
         bool equalImpl(AbstractColumn c);
public:
 
    };
 
class PgsqlNumericColumn : public PgsqlColumn {
 
public:
        constructor(string n, string nt, *string qt, int sz, bool nul, *string dv, *string cm, softint bs, softint scale) ;
 
 
        string getNativeTypeString();
 
    };
 
class PgsqlUniqueConstraintCommon : public SqlUtil::AbstractUniqueConstraint {
 
public:
protected:
            *string tablespace;
 
public:
 
        constructor(*string ts);
 
 
        *string getTablespace();
 
 
        setTablespace(*string ts);
 
 
        bool setIndexBase(string ix);
 
 
        clearIndex();
 
 
        getIndexSql(reference<string> sql, string name, *hash opts);
 
 
        string getDropSql(string table_name);
 
    };
 
class PgsqlUniqueConstraint : public SqlUtil::AbstractUniqueConstraint, public PgsqlUniqueConstraintCommon {
 
public:
protected:
            bool enabled;
 
public:
 
 
        constructor(string n, hash n_cols, bool e = True, *string ts) ;
 
 
 
        PgsqlColumn memberGate(string k);
 
 
        string getCreateSql(string table_name, *hash opts);
 
 
        list<auto> getRenameSql(string table_name, string new_name);
 
 
        string getCreateSql(string name, string table_name, *hash<auto> opts);
 
 
        string getDropSql(string table_name);
 
 
        bool isEnabled();
 
    };
 
class PgsqlPrimaryKey : public SqlUtil::AbstractPrimaryKey, public PgsqlUniqueConstraintCommon {
 
public:
        constructor();
 
 
 
        constructor(string n, *hash c, *string ts) ;
 
 
 
        PgsqlColumn memberGate(string k);
 
 
        string getCreateSql(string table_name, *hash<auto> opts);
 
 
        softlist getRenameSql(string table_name, string new_name);
 
 
        string getDropSql(string table_name);
 
    };
 
class PgsqlSequence : public SqlUtil::AbstractSequence {
 
public:
        constructor(string n_name, number n_start = 1, number n_increment = 1, *softnumber n_end) ;
 
 
        string getCreateSql(*hash opt);
 
 
 
        softlist getRenameSql(string new_name, *hash opt);
 
    };
 
class PgsqlView : public SqlUtil::AbstractView {
 
public:
            *string viewowner;
 
        constructor(string n_name, string n_src, *string n_schemaname, *string n_viewowner)
 ;
 
 
        string getCreateSql(*hash opt);
 
 
 
        softlist getRenameSql(string new_name, *hash opt);
 
    };
 
class PgsqlTrigger : public SqlUtil::AbstractTrigger {
 
public:
        constructor(string n, string n_src) ;
 
 
        softlist<string> getCreateSql(string table_name, *hash opt);
 
 
        softlist<string> getDropSql(string table_name);
 
 
protected:
         bool equalImpl(AbstractFunctionBase t);
public:
 
 
        softlist<string> getRenameSql(string table_name, string new_name);
 
 
        string getNormalizedSource(string src);
 
    };
 
class PgsqlFunction : public SqlUtil::AbstractFunction {
 
public:
            *string args;
 
        constructor(string n, string n_src, *string a) ;
 
 
        softlist<string> getCreateSql(*hash opt);
 
 
 
        string getDropSql(*hash opt);
 
 
protected:
         bool equalImpl(AbstractFunctionBase t);
public:
 
 
 
        softlist<string> getRenameSql(string new_name, *hash opt);
 
 
        setName(string new_name);
 
    };
 
class PgsqlTriggerFunction : public PgsqlFunction {
 
public:
            string trigger;
 
        constructor(string n, string n_src, string n_trigger) ;
 
    };
 
class PgsqlDatabase : public SqlUtil::AbstractDatabase {
 
public:
            const PgsqlSchemaDescriptionOptions = ...;
 
 
            const PGSQL_TempSavepoint = "qore_pgsql_tmp_savepoint";
 
            const PgsqlReclaimSpaceOptions = ...;
 
 
            const PgsqlReservedWords = ...;
 
 
        constructor(AbstractDatasource nds, *hash opts) ;
 
 
protected:
         list<string> featuresImpl();
public:
 
 
        PgsqlType makeType(string name, string src, *hash opts);
 
 
        *PgsqlType getType(string name);
 
 
protected:
         PgsqlSequence makeSequenceImpl(string name, number start = 1, number increment = 1, *softnumber end, *hash opts);
public:
 
 
protected:
         *AbstractSequence getSequenceImpl(string name);
public:
 
 
protected:
         *AbstractView getViewImpl(string name);
public:
 
 
protected:
         PgsqlFunction makeFunctionImpl(string name, string src, *hash opts);
public:
 
 
protected:
         PgsqlFunction makeProcedureImpl(string name, string src, *hash opts);
public:
 
 
protected:
         *AbstractFunction getFunctionImpl(string name);
public:
 
 
protected:
         AbstractFunction getProcedureImpl(string name);
public:
 
 
          static *string getFunctionArgs(string err, reference<string> src);
 
          static PgsqlFunction processFunction(hash<auto> row, bool native_case);
 
protected:
         list getDropSchemaSqlImpl(hash schema_hash, *hash opt);
public:
 
 
protected:
         list getAlignSqlImpl(hash schema_hash, *hash opt);
public:
 
 
protected:
         list<string> listTablesImpl();
public:
 
 
 
protected:
         list<string> listFunctionsImpl();
public:
 
 
 
protected:
         list<string> listProceduresImpl();
public:
 
 
protected:
         list<string> listSequencesImpl();
public:
 
 
protected:
         list<string> listViewsImpl();
public:
 
 
        list<string> listMaterializedViews();
 
 
        ListIterator materializedViewIterator();
 
 
        list<string> listTypes();
 
 
        ListIterator typeIterator();
 
 
protected:
         string getCreateSqlImpl(list l);
public:
 
 
          static string getCreateSql(list l);
 
protected:
         hash getSchemaDescriptionOptions();
public:
 
 
protected:
         hash getReclaimSpaceOptions();
public:
 
 
protected:
         softint getNextSequenceValueImpl(string name);
public:
 
 
protected:
         softint getCurrentSequenceValueImpl(string name);
public:
 
 
protected:
         bool supportsSequencesImpl();
public:
 
 
protected:
         bool supportsTypesImpl();
public:
 
 
protected:
         bool supportsPackagesImpl();
public:
 
 
protected:
         bool rebuildIndexImpl(string name, *hash options);
public:
 
 
protected:
         computeStatisticsImpl(*hash options);
public:
 
 
protected:
         reclaimSpaceImpl(*hash options);
public:
 
 
protected:
         *string getDbName();
public:
 
 
protected:
         int getPhysicalSizeImpl();
public:
 
 
protected:
         auto tryExecArgsImpl(string sql, *softlist<auto> args);
public:
 
 
protected:
         auto tryExecRawImpl(string sql, *softlist<auto> args);
public:
 
 
          static auto tryExecArgs(AbstractDatasource ds, string sql, *softlist<auto> args);
 
          static auto tryExecRaw(AbstractDatasource ds, string sql);
    };
 
class PgsqlTable : public SqlUtil::AbstractTable {
 
public:
            const PgsqlTypeMap = ...;
 
 
            const PgsqlNameMap = ...;
 
 
            const QoreTypeMap = ...;
 
 
 
            const PgsqlTableDescriptionHashOptions = ...;
 
 
            const PgsqlColumnDescOptions = AbstractTable::ColumnDescOptions;
 
            const PgsqlIndexOptions = AbstractTable::IndexOptions;
 
            const PgsqlConstraintOptions = ...;
 
 
            const PgsqlTableCreationOptions = ...;
 
 
            const PgsqlAlignTableOptions = AbstractTable::AlignTableOptions + PgsqlTableCreationOptions;
 
            const PgsqlExpressionMap = ...;
 
 
            const PgsqlCopMap = ...;
 
 
            const PgsqlTruncDate = ...;
 
 
            const PgsqlIopMap = ...;
 
 
            const PgsqlUopMap = ...;
 
 
protected:
            *string tablespace;
 
            string schema;
 
            Functions triggerFunctions;
 
            bool has_atomic_merge;
 
            int server_version;
 
            int server_version_major;
 
            int server_version_minor;
 
            int server_version_sub;
 
            transient Mutex pg_state();
 
public:
 
        constructor(AbstractDatasource nds, string nname, *hash opts) ;
 
 
        string getSchemaName();
 
 
        *string getTablespaceName();
 
 
        PgsqlFunction addTriggerFunction(string tfname, string src, string trigger);
 
 
        bool hasArrayBind();
 
 
        string getColumnSqlName(string col);
 
 
 
        list<auto> getColumnSqlNames(softlist<auto> cols);
 
 
 
        code getUpsertClosure(hash<auto> row, int upsert_strategy = UpsertAuto, *hash<auto> opt);
 
 
        bool hasAtomicUpsert();
 
 
protected:
         getServerVersion();
public:
 
 
protected:
         code getUpsertAuto(Columns cols, hash<auto> row, *hash<auto> opt);
public:
 
 
protected:
         PgsqlFunction addTriggerFunctionUnlocked(string tfname, string src, string trigger);
public:
 
 
        string getSqlName();
 
 
protected:
         hash getTableCreationOptions();
public:
 
 
protected:
         hash getTableDescriptionHashOptions();
public:
 
 
protected:
         hash getColumnDescOptions();
public:
 
 
protected:
         hash getIndexOptions();
public:
 
 
protected:
         hash getConstraintOptions();
public:
 
 
protected:
         hash getAlignTableOptions();
public:
 
 
protected:
         hash getColumnOperatorMapImpl();
public:
 
 
protected:
         hash getInsertOperatorMap();
public:
 
 
protected:
         hash getRawUpdateOperatorMap();
public:
 
 
        hash<auto> getExpressionMap();
 
 
protected:
         bool checkExistenceImpl();
public:
 
 
protected:
         Columns describeImpl();
public:
 
 
protected:
         PgsqlPrimaryKey getPrimaryKeyImpl();
public:
 
 
protected:
         Indexes getIndexesImpl();
public:
 
 
protected:
         ForeignConstraints getForeignConstraintsImpl(*hash<auto> opts);
public:
 
 
protected:
         Constraints getConstraintsImpl();
public:
 
 
protected:
         Triggers getTriggersImpl();
public:
 
 
protected:
         string getCreateTableSqlImpl(*hash opt);
public:
 
 
protected:
         *list getCreateMiscSqlImpl(*hash opt, bool cache);
public:
 
 
protected:
         *list getAlignSqlImpl(AbstractTable table, *hash<auto> opt);
public:
 
 
protected:
         string getCreateSqlImpl(list l);
public:
 
 
protected:
         string getRenameSqlImpl(string new_name);
public:
 
 
protected:
         AbstractColumn addColumnImpl(string cname, hash opt, bool nullable = True);
public:
 
 
protected:
         AbstractPrimaryKey addPrimaryKeyImpl(string cname, hash ch, *hash opt);
public:
 
 
protected:
         AbstractIndex addIndexImpl(string iname, bool enabled, hash ch, *hash opt);
public:
 
 
protected:
         AbstractForeignConstraint addForeignConstraintImpl(string cname, hash<auto> ch, string table, hash<auto> tch, *hash<auto> opt);
public:
 
 
protected:
         AbstractCheckConstraint addCheckConstraintImpl(string cname, string src, *hash opt);
public:
 
 
protected:
         AbstractUniqueConstraint addUniqueConstraintImpl(string cname, hash ch, *hash opt);
public:
 
 
protected:
         AbstractTrigger addTriggerImpl(string tname, string src, *hash opt);
public:
 
 
protected:
         bool tryInsertImpl(string sql, hash<auto> row);
public:
 
 
 
protected:
         bool isDuplicateRowErrorImpl(hash<ExceptionInfo> ex);
public:
 
 
protected:
         hash<auto> getQoreTypeMapImpl();
public:
 
 
protected:
         hash<auto> getTypeMapImpl();
public:
 
 
 
protected:
         *string getSqlValueImpl(auto v);
public:
 
 
protected:
         bool emptyImpl();
public:
 
 
protected:
         clearImpl();
public:
 
 
protected:
         softlist getDropSqlImpl();
public:
 
 
protected:
         setupTableImpl(hash<auto> desc, *hash<auto> opt);
public:
 
 
protected:
         bool constraintsLinkedToIndexesImpl();
public:
 
 
protected:
         bool uniqueIndexCreatesConstraintImpl();
public:
 
 
protected:
         bool supportsTablespacesImpl();
public:
 
 
protected:
         doSelectLimitOnlyInternImpl(reference<hash<QueryInfo>> info, reference<string> sql);
public:
 
 
protected:
         doSelectOrderByWithOffsetSqlInternImpl(reference<hash<QueryInfo>> info, reference<string> sql, list<auto> coll);
public:
 
 
protected:
         auto tryExecArgsImpl(string sql, *softlist<auto> args);
public:
 
 
protected:
         auto tryExecRawImpl(string sql, *softlist<auto> args);
public:
 
 
protected:
         copyImpl(AbstractTable old);
public:
 
 
protected:
         *hash<auto> doReturningImpl(hash<auto> opt, reference<string> sql, list<auto> args);
public:
 
 
protected:
         list<auto> getGroupOrderByListUnlocked(hash<QueryInfo> info, string key, list<auto> coll);
public:
 
 
protected:
         AbstractDataProviderType getNumericTypeImpl(string native_type, bool nullable, *hash<auto> options);
public:
 
 
 
protected:
         AbstractSavepointHelper getSavepointHelperImpl(*string savepoint);
public:
 
    };
};