Qore SqlUtil Module Reference  1.3.3
 All Classes Namespaces Functions Variables Groups Pages
SqlUtil::AbstractTable Class Referenceabstract

the base abstract class for the table implementation More...

Inheritance diagram for SqlUtil::AbstractTable:

Public Member Functions

AbstractCheckConstraint addCheckConstraint (string cname, string src, *hash opt, *reference sql)
 adds a check constraint to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example More...
 
AbstractColumn addColumn (string cname, hash opt, bool nullable=True, *reference lsql)
 adds a column to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example More...
 
AbstractForeignConstraint addForeignConstraint (string cname, softlist cols, string table, *softlist tcols, *hash opt, *reference sql)
 adds a foreign constraint to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example More...
 
AbstractIndex addIndex (string iname, bool unique, softlist cols, *hash opt, *reference sql)
 adds an index to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example More...
 
AbstractPrimaryKey addPrimaryKey (string pkname, softlist cols, *hash opt, *reference sql)
 adds a primary key to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example More...
 
AbstractTrigger addTrigger (string tname, string src, *hash opt, *reference lsql)
 adds a trigger to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example More...
 
AbstractUniqueConstraint addUniqueConstraint (string cname, softlist cols, *hash opt, *reference sql)
 adds a unique constraint to the table; if the table is known to be in the database already, then the constraint is added to the database also immediately; otherwise it is only added internally and can be created when create() is called for example More...
 
private bool asteriskRequiresPrefix ()
 returns True if the database requires a wildcard "*" to be prefixed with the table name when it appears with other column arguments in a select statement
 
bool bindEmptyStringsAsNull ()
 returns True if the DB treats empty strings as NULL, False if not; by default this method returns False More...
 
 cache (*hash opts)
 reads in all attributes of the table from the database More...
 
bool checkExistence ()
 returns True if the table exists in the database, False if not More...
 
abstract private bool checkExistenceImpl ()
 returns True if the table exists in the DB, False if not More...
 
 clear ()
 purges the current table definition More...
 
private clearImpl ()
 clears any driver-specific table information
 
 commit ()
 commits the current transaction on the underlying Qore::SQL::AbstractDatasource
 
abstract private bool constraintsLinkedToIndexesImpl ()
 returns True if the database links constraints to indexes (ie dropping the constraint drops the index, etc)
 
private constructor (AbstractDatasource nds, string nname, *hash nopts)
 creates the object; private constructor More...
 
 copy (AbstractTable old)
 copies the object
 
abstract private copyImpl (AbstractTable old)
 db-specific copy actions
 
 create (*hash opt)
 creates the table with all associated properties (indexes, constraints, etc) without any transaction management More...
 
 createCommit (*hash opt)
 creates the table in the database; releases the transaction lock after creating the table More...
 
deprecated createNoCommit (*hash opt)
 A legacy wrapper for create()
 
int del (hash cond, reference sql, hash opt)
 deletes rows in the table matching the condition and returns the count of rows deleted; no transaction management is performed with this method More...
 
int del (hash cond, hash opt)
 SqlUtil::AbstractTable::del() variant
 
int del (hash cond, reference sql)
 SqlUtil::AbstractTable::del() variant
 
int del (hash cond)
 SqlUtil::AbstractTable::del() variant
 
int del ()
 SqlUtil::AbstractTable::del() variant
 
int delCommit (hash cond, reference sql, hash opt)
 deletes rows in the table matching the condition and returns the count of rows deleted; the transaction is committed if successful, if an error occurs then it is rolled back More...
 
int delCommit (hash cond, hash opt)
 SqlUtil::AbstractTable::delCommit() variant
 
int delCommit (hash cond, reference sql)
 SqlUtil::AbstractTable::delCommit() variant
 
int delCommit (hash cond)
 SqlUtil::AbstractTable::delCommit() variant
 
int delCommit ()
 SqlUtil::AbstractTable::delCommit() variant
 
deprecated int delNoCommit (*hash cond, *reference sql)
 A legacy SqlUtil::AbstractTable::del() wrapper.
 
Columns describe ()
 returns an object of class Columns describing the table More...
 
abstract private doSelectLimitOnlyUnlockedImpl (reference sql, reference args, *hash qh)
 processes a string for use in SQL select statements when there is a "limit" argument, but no "orderby" or "offset" arguments
 
abstract private doSelectOrderByWithOffsetSqlUnlockedImpl (reference sql, reference args, *hash qh, *hash jch, *hash ch, *hash psch, list coll)
 processes a string for use in SQL select statements when there is an "order by" and "offset" argument
 
 drop (*hash opt)
 drops the table from the database without any transaction management More...
 
AbstractColumn dropColumn (string cname, *reference lsql)
 drops a column from the table More...
 
 dropCommit (*hash opt)
 drops the table from the database; releases the transaction lock after dropping the table More...
 
AbstractConstraint dropConstraint (string cname, *reference sql)
 drops a constraint from the table; this can be any constraint on the table, a primary key, a foreign key constraint, or a generic constraint; if the table is known to be in the database already, then it is also dropped from the database immediately; otherwise it is only removed internally More...
 
AbstractForeignConstraint dropForeignConstraint (string cname, *reference sql)
 drops a foreign constraint from the table; if the table is known to be in the database already, then it is also dropped from the database immediately; otherwise it is only removed internally More...
 
AbstractIndex dropIndex (string iname, *reference sql)
 drops the given index from the table; if the table is known to be in the database already, then it is also dropped from the database immediately; otherwise it is only removed internally More...
 
deprecated dropNoCommit (*hash opt)
 A legacy wrapper for drop()
 
AbstractPrimaryKey dropPrimaryKey (*reference lsql)
 drops the primary key from the table; if the table is known to be in the database already, then it is also dropped from the database immediately; otherwise it is only removed internally More...
 
AbstractTrigger dropTrigger (string tname, *reference sql)
 drops the given trigger from the table; if the table is known to be in the database already, then it is also dropped from the database immediately; otherwise it is only removed internally More...
 
bool empty ()
 returns True if the table has no definitions, False if not More...
 
bool emptyData ()
 returns True if the table has no data rows, False if not More...
 
*hash find (any id)
 finds a row in the table with the given primary key value; if no row matches the primary key value passed then NOTHING is returned More...
 
*list find (list ids)
 finds rows in the table with the given primary key values; if no row matches any primary key value passed then NOTHING is returned More...
 
*hash find (hash row)
 finds a row in the table with the given primary key value given as a hash; if no row matches the primary key value passed then NOTHING is returned More...
 
*list findAll (*hash cond)
 finds all rows in the table with the given column values; a list of hashes is returned representing the rows returned More...
 
*hash findSingle (*hash cond)
 finds a single row in the table that match the row condition passed; multiple rows may match, but only one row will be returned from the database; if no row matches the condition hash passed then NOTHING is returned More...
 
*AbstractUniqueConstraint findUniqueConstraint (string name)
 returns the given AbstractUniqueConstraint object if defined for the table (also includes the primary key) More...
 
string getAddCheckConstraintSql (string cname, string src, *hash copt, *hash opt)
 returns an SQL string that can be used to add a check constraint to the table More...
 
list getAddColumnSql (string cname, hash copt, bool nullable=True, *hash opt)
 returns a list of SQL strings that can be use to add a column to the table More...
 
string getAddForeignConstraintSql (string cname, softlist cols, string table, *softlist tcols, *hash fkopt, *hash opt)
 returns an SQL string that can be used to add a foreign constraint to the table More...
 
string getAddIndexSql (string iname, bool unique, softlist cols, *hash ixopt, *hash opt)
 returns an SQL string that can be used to add an index to the table More...
 
string getAddPrimaryKeySql (string pkname, softlist cols, *hash pkopt, *hash opt)
 returns the SQL that can be used to add a primary key to the table More...
 
list getAddTriggerSql (string tname, string src, *hash topt, *hash opt)
 returns a list of SQL strings that can be used to add a trigger to the table More...
 
string getAddUniqueConstraintSql (string cname, softlist cols, *hash ukopt, *hash opt)
 returns an SQL string that can be used to add a unique constraint to the table More...
 
list getAlignSql (AbstractTable t, *hash opt)
 accepts an AbstractTable argument and returns a list of SQL strings required to align the structure and configuration of the current table with that of the argument; if the tables are identical then an empty list is returned More...
 
string getAlignSqlString (AbstractTable t, *hash opt)
 accepts an AbstractTable argument and returns an SQL string that could be executed to align the structure and configuration of the current table with that of the argument; if the tables are identical then an empty string is returned More...
 
private hash getAlignTableOptions ()
 returns the align table options for this driver More...
 
string getBaseType ()
 returns the base type of the underlying object (normally "table", some DB-specific implementations may support others like "view")
 
code getBulkUpsertClosure (hash example_row, int upsert_strategy=AbstractTable::UpsertAuto, *hash opt)
 returns a closure that can be executed given a hash argument representing either a single row or a set of rows (where each key value is a list of column values) that will be updated or inserted in the database with the given upsert strategy; the table must have a unique key to do this; the closure returned does not check the input hash for validity More...
 
private hash getCacheOptions ()
 returns the cache options for this driver More...
 
private hash getColumnDescOptions ()
 returns the column description options for this driver More...
 
private hash getColumnOperatorMap ()
 returns the column operator map for this object More...
 
private hash getColumnOptions ()
 returns the column options for this driver More...
 
string getColumnSqlName (string col)
 returns the column name for use in SQL strings; subclasses can return a special string in case the column name is a reserved word
 
list getColumnSqlNames (softlist cols)
 returns a list of column names for use in SQL strings; subclasses can process the argument list in case a column name is a reserved word
 
private hash getConstraintOptions ()
 returns the constraint options for this driver More...
 
Constraints getConstraints ()
 returns a Constraints object describing the non-foreign constraints on the table
 
*list getCreateConstraintsSql (*hash opt, bool cache=True)
 returns a list of SQL strings that could be used to create non-foreign constraints on the table or NOTHING if there are no non-foreign constraints on the table More...
 
*list getCreateForeignConstraintsSql (*hash opt, bool cache=True)
 returns a list of SQL strings that could be used to create foreign constraints on the table or NOTHING if there are no foreign constraints on the table More...
 
*list getCreateIndexesSql (*hash opt, bool cache=True)
 returns a list of SQL strings that could be used to create indexes on the table or NOTHING if there are no indexes on the table More...
 
*list getCreateMiscSql (*hash opt, bool cache=True)
 returns a list of SQL strings that could be used to create other table attributes (such as comments, if supported and present) or NOTHING if there are none More...
 
*string getCreatePrimaryKeySql (*hash opt, bool cache=True)
 returns an SQL string that could be used to create the primary key on the table More...
 
list getCreateSql (*hash opt)
 returns a list of SQL strings that could be used to create the table and all known properties of the table More...
 
string getCreateSqlString (*hash opt)
 returns an SQL string that could be used to create the table and all known properties of the table More...
 
string getCreateTableSql (*hash opt)
 returns an SQL string that could be used to create the basic table structure without indexes and constraints More...
 
*list getCreateTriggersSql (*hash opt, bool cache=True)
 returns a list of SQL strings that could be used to create triggers on the table or NOTHING if there are no triggers on the table More...
 
string getDesc ()
 returns a descriptive string of the datasource (without the password) and the table name (with a possible qualifier for schema, etc) More...
 
list getDropAllConstraintsAndIndexesOnColumnSql (string cname, *hash opt)
 gets a list of SQL strings to drop all constraints and indexes with the given column name; if the column does not exist then an empty list is returned More...
 
list getDropColumnSql (string cname, *hash opt)
 returns the SQL that can be used to drop a column from the table More...
 
*string getDropConstraintIfExistsSql (string cname, *hash opt, *reference cref)
 gets the SQL that can be used to drop a constraint from the table if it exists, otherwise returns NOTHING; this can be any constraint on the table, a primary key, a foreign key constraint, or a generic constraint More...
 
string getDropConstraintSql (string cname, *hash opt)
 gets the SQL that can be used to drop a constraint from the table; this can be any constraint on the table, a primary key, a foreign key constraint, or a generic constraint More...
 
string getDropIndexSql (string iname, *hash opt)
 gets the SQL that can be used to drop an index from the table More...
 
list getDropPrimaryKeySql (*hash opt)
 gets a list of SQL strings that can be used to drop the primary key from the table More...
 
softlist getDropSql (*hash opt)
 returns the sql required to drop the table; reimplement in subclasses if necessary More...
 
list getDropTriggerSql (string tname, *hash opt)
 returns SQL that can be used to drop the given trigger from the table More...
 
private hash getForeignConstraintOptions ()
 return the foreign constraint options for this driver More...
 
ForeignConstraints getForeignConstraints (*hash opt)
 returns a ForeignConstraints object describing the foreign constraints that the table has on other tables
 
Indexes getIndexes ()
 returns an object of class Indexes describing the indexes on the table More...
 
private hash getIndexOptions ()
 returns the index options for this driver More...
 
private hash getInsertFromIteratorOptions ()
 returns the insert from iterator options for this driver More...
 
private hash getInsertOperatorMap ()
 returns the insert operator map for this object More...
 
private hash getInsertOptions ()
 returns the insert options for this driver More...
 
list getModifyColumnSql (string cname, hash copt, bool nullable=True, *hash opt)
 gets a list of SQL strings that can be used to modify an existing column in the table More...
 
string getName ()
 returns the name of the table
 
AbstractPrimaryKey getPrimaryKey ()
 returns an object of class AbstractPrimaryKey describing the primary key of the table More...
 
private *hash getPseudoColumnHash ()
 returns a hash of valid pseudocolumns More...
 
abstract private hash getQoreTypeMapImpl ()
 returns the qore type -> column type map
 
private hash getRawUpdateOperatorMap ()
 returns the raw (default) update operator map for this object More...
 
string getRenameColumnSql (string old_name, string new_name, *hash opt)
 gets an SQL string that can be used to rename an existing column in the table More...
 
string getRenameSql (string new_name, *hash opt)
 returns an SQL string that could be used to rename the table in the database More...
 
Qore::SQL::SQLStatement getRowIterator (*hash sh, *reference sql, *hash opt)
 returns an SQLStatement object that will iterate the results of a select statement matching the arguments More...
 
Qore::SQL::SQLStatement getRowIterator (*hash sh, *hash opt)
 returns an SQLStatement object that will iterate the results of a select statement matching the arguments More...
 
private hash getSelectOptions ()
 returns the select options for this driver More...
 
string getSelectSql (*hash sh, *reference args)
 returns the SQL string to be executed corresponding to the argument hash with an output parameter for the select bind arguments More...
 
private hash getSqlDataCallbackOptions ()
 returns the sql data operation callback options for this driver More...
 
string getSqlFromList (list l)
 returns an SQL string corresponding to the list of commands in the argument More...
 
string getSqlName ()
 returns the name of the table to be used in SQL (with a possible qualifier for schema, etc)
 
string getSqlValue (any v)
 returns a string for use in SQL queries representing the DB-specific value of the argument More...
 
abstract private *string getSqlValueImpl (any v)
 returns a string for use in SQL queries representing the DB-specific value of the argument; returns NOTHING if the type cannot be converted to an SQL string
 
private hash getTableColumnDescOptions ()
 returns the table column description options for this driver More...
 
private hash getTableCreationOptions ()
 returns the table creation options for this driver More...
 
private hash getTableDescriptionHashOptions ()
 returns the table description hash options for this driver More...
 
private hash getTableOptions ()
 returns the table options for this driver More...
 
private hash getTriggerOptions ()
 returns the trigger options for this driver More...
 
Triggers getTriggers ()
 returns an object of class Triggers describing the triggers on the table More...
 
string getTruncateSql (*hash opt)
 gets the SQL that can be used to truncate the table More...
 
abstract private hash getTypeMapImpl ()
 returns the type name -> type description hash
 
Qore::AbstractIterator getUniqueConstraintIterator ()
 returns an iterator for all unique constraints on the table (including the primary key if any) More...
 
private hash getUpdateOperatorMap ()
 returns the update operator map for this object More...
 
code getUpsertClosure (hash row, int upsert_strategy=UpsertAuto, *hash opt)
 returns a closure that can be executed given a hash argument representing a single row that will be updated or inserted in the database with the given upsert strategy; the table must have a unique key to do this; the closure returned does not check the input hash for validity More...
 
code getUpsertClosureWithValidation (hash example_row, int upsert_strategy=UpsertAuto, *hash opt)
 returns a closure that can be executed given a hash argument representing a single row that will be updated or inserted in the database with the given upsert strategy; the table must have a unique key to do this; the closure returned checks the input hash for validity More...
 
private hash getUpsertOptions ()
 returns the upsert options for this driver More...
 
private hash getWhereOperatorMap ()
 returns the "where" operator map for this object More...
 
abstract bool hasArrayBind ()
 returns True if the underlying DB driver supports bulk DML operations
 
bool hasReturning ()
 returns True if the current database driver supports the "returning" clause in insert statements, False if not More...
 
private bool hasReturningImpl ()
 returns True if the current database driver supports the "returning" clause in insert statements, False if not
 
bool inDb ()
 returns True if the table has been read from or created in the database, False if not More...
 
*hash insert (hash row)
 inserts a row into the table without any transaction management; a transaction will be in progress after this method is successfully executed More...
 
*hash insert (hash row, reference sql)
 SqlUtil::AbstractTable::insert() variant
 
*hash insert (hash row, hash opt)
 SqlUtil::AbstractTable::insert() variant
 
*hash insert (hash row, reference sql, hash opt)
 SqlUtil::AbstractTable::insert() variant
 
*hash insertCommit (hash row)
 inserts a row into the table; the transaction is committed if successful, if an error occurs, it is rolled back More...
 
*hash insertCommit (hash row, reference sql)
 SqlUtil::AbstractTable::insertCommit() variant
 
*hash insertCommit (hash row, hash opt)
 SqlUtil::AbstractTable::insertCommit() variant
 
*hash insertCommit (hash row, reference sql, hash opt)
 SqlUtil::AbstractTable::insertCommit() variant
 
int insertFromIterator (Qore::AbstractIterator i, *hash opt)
 this method inserts data from the given iterator argument (whose getValue() method must return a hash giving row values) into the current table; no transaction management is performed with this method More...
 
int insertFromIteratorCommit (Qore::AbstractIterator i, *hash opt)
 this method inserts data from the given iterator argument (whose getValue() method must return a hash giving row values) into the current table; the transaction is committed if successful, if an error occurs then it is rolled back More...
 
deprecated int insertFromIteratorNoCommit (Qore::AbstractIterator i, *hash opt)
 A legacy SqlUtil::AbstractTable::insertFromIterator() wrapper.
 
int insertFromSelect (list cols, AbstractTable source, hash sh, reference sql, hash opt)
 inserts rows into a table based on a select statement from another table (which must be using the same datasource as the current table); a transaction will be in progress after this method is successfully executed More...
 
int insertFromSelect (list cols, AbstractTable source)
 SqlUtil::AbstractTable::insertFromSelectCommit() variant
 
int insertFromSelect (list cols, AbstractTable source, hash sh)
 SqlUtil::AbstractTable::insertFromSelectCommit() variant
 
int insertFromSelect (list cols, AbstractTable source, hash sh, reference sql)
 SqlUtil::AbstractTable::insertFromSelectCommit() variant
 
int insertFromSelect (list cols, AbstractTable source, hash sh, hash opt)
 SqlUtil::AbstractTable::insertFromSelectCommit() variant
 
int insertFromSelectCommit (list cols, AbstractTable source, hash sh, reference sql, hash opt)
 inserts rows into a table based on a select statement from another table (which must be using the same datasource as the current table); the transaction is committed if successful, if an error occurs, it is rolled back More...
 
int insertFromSelectCommit (list cols, AbstractTable source)
 SqlUtil::AbstractTable::insertFromSelectCommit() variant
 
int insertFromSelectCommit (list cols, AbstractTable source, hash sh)
 SqlUtil::AbstractTable::insertFromSelectCommit() variant
 
int insertFromSelectCommit (list cols, AbstractTable source, hash sh, reference sql)
 SqlUtil::AbstractTable::insertFromSelectCommit() variant
 
int insertFromSelectCommit (list cols, AbstractTable source, hash sh, hash opt)
 SqlUtil::AbstractTable::insertFromSelectCommit() variant
 
deprecated int insertFromSelectNoCommit (list cols, AbstractTable source, *hash sh, *reference sql, *hash opt)
 A legacy SqlUtil::AbstractTable::insertFromSelect() wrapper.
 
deprecated *hash insertNoCommit (hash row, *reference sql, *hash opt)
 A legacy wrapper for SqlUtil::AbstractTable::insert()
 
deprecated *hash insertNoCommit (hash row, hash opt)
 A legacy wrapper for SqlUtil::AbstractTable::insert()
 
AbstractColumn modifyColumn (string cname, hash opt, bool nullable=True, *reference lsql)
 modifies an existing column in the table; if the table is already known to be in the database, then the changes are effected in the database also immediately; otherwise it is only updated internally and the new column definition will be created when create() is called for example More...
 
AbstractForeignConstraint removeForeignConstraint (string cname)
 removes the named foreign constraint from the table; no SQL is executed in any case, only the named foreign constraint is removed from the table definition More...
 
 rename (string new_name, *reference sql, *Tables table_cache)
 renames the table; if the table is already known to be in the database in the database, then the changes are effected in the database also immediately; otherwise it is only updated internally More...
 
AbstractColumn renameColumn (string old_name, string new_name, reference sql)
 renames an existing column; if the table is already known to be in the database, then the changes are effected in the database also immediately; otherwise it is only updated internally More...
 
AbstractConstraint renameConstraint (string old_name, string new_name, reference lsql)
 renames an existing constraint; this can be any constraint on the table, a primary key, a foreign key constraint, or a generic constraint; if the table is already known to be in the database, then the changes are effected in the database also immediately; otherwise it is only updated internally More...
 
AbstractIndex renameIndex (string old_name, string new_name, reference sql)
 renames an existing index; if the table is already known to be in the database, then the changes are effected in the database also immediately; otherwise it is only updated internally More...
 
 rollback ()
 rolls back the current transaction on the underlying Qore::SQL::AbstractDatasource
 
softint rowCount ()
 returns the number of rows in the table More...
 
*hash select (*hash sh, *reference sql, *hash opt)
 returns a hash of lists representing the columns and rows in the table that match the argument hahs More...
 
*hash select (*hash sh, *hash opt)
 returns a hash of lists representing the columns and rows in the table that match the argument hahs More...
 
*hash selectRow (*hash sh, *reference sql, *hash opt)
 returns a hash representing the row in the table that matches the argument hash; if more than one row would be returned an exception is raised More...
 
*hash selectRow (*hash sh, *hash opt)
 returns a hash representing the row in the table that matches the argument hash; if more than one row would be returned an exception is raised More...
 
*list selectRows (*hash sh, *reference sql, *hash opt)
 returns a list of hashes representing the rows in the table that match the argument hash More...
 
*list selectRows (*hash sh, *hash opt)
 returns a list of hashes representing the rows in the table that match the argument hash More...
 
 setDatasource (AbstractDatasource nds)
 changes the datasource for the table; if the inDb flag is True, then it is set to False by calling this method More...
 
 setupTable (hash desc, *hash opt)
 creates the object from a table description hash More...
 
abstract private bool supportsTablespacesImpl ()
 returns True if the database support tablespaces
 
 truncate ()
 truncates all the table data without any transaction management More...
 
 truncateCommit ()
 truncates all the table data; releases the transaction lock after executing More...
 
deprecated truncateNoCommit ()
 A legacy warpper for truncate()
 
any tryExec (string sql)
 executes some SQL with optional arguments so that if an error occurs the current transaction state is not lost More...
 
any tryExecArgs (string sql, *softlist args)
 executes some SQL with optional arguments so that if an error occurs the current transaction state is not lost More...
 
private any tryExecArgsImpl (string sql, *softlist args)
 tries to execute a command so that if an error occurs the current transaction status is not lost
 
any tryExecRaw (string sql)
 executes some SQL so that if an error occurs the current transaction state is not lost More...
 
private any tryExecRawImpl (string sql)
 tries to execute a command so that if an error occurs the current transaction status is not lost
 
abstract private bool tryInsertImpl (string sql, hash row)
 tries to insert a row, if there is a duplicate key, then it returns False, if successful, returns True
 
abstract private bool uniqueIndexCreatesConstraintImpl ()
 returns True if the database automatically creates a unique constraint when a unique index is created (ex: mysql)
 
int update (hash set, hash cond, reference sql, hash opt)
 updates rows in the table matching an optional condition and returns the count of rows updated; no transaction management is performed with this method More...
 
int update (hash set, hash cond, reference sql)
 A SqlUtil::AbstractTable::update() variant.
 
int update (hash set, hash cond, hash opt)
 A SqlUtil::AbstractTable::update() variant.
 
int update (hash set, hash cond)
 A SqlUtil::AbstractTable::update() variant.
 
int update (hash set)
 A SqlUtil::AbstractTable::update() variant.
 
int updateCommit (hash set, hash cond, reference sql, hash opt)
 updates rows in the table matching an optional condition and returns the count of rows updated; the transaction is committed if successful, if an error occurs then it is rolled back More...
 
int updateCommit (hash set, hash cond, reference sql)
 A SqlUtil::AbstractTable::updateCommit() variant.
 
int updateCommit (hash set, hash cond, hash opt)
 A SqlUtil::AbstractTable::updateCommit() variant.
 
int updateCommit (hash set, hash cond)
 A SqlUtil::AbstractTable::updateCommit() variant.
 
int updateCommit (hash set)
 A SqlUtil::AbstractTable::updateCommit() variant.
 
deprecated int updateNoCommit (hash set, *hash cond, *reference sql)
 A legacy SqlUtil::AbstractTable::update() wrapper.
 
deprecated int updateNoCommit (hash set, *hash cond, *hash opt)
 A legacy SqlUtil::AbstractTable::update() wrapper.
 
int upsert (hash row, int upsert_strategy=UpsertAuto, *hash opt)
 update or insert the data in the table according to the hash argument; the table must have a unique key to do this More...
 
int upsertCommit (hash row, int upsert_strategy=UpsertAuto, *hash opt)
 update or insert the data in the table according to the hash argument; the table must have a unique key to do this; the transaction is committed if successful, if an error occurs then it is rolled back More...
 
*hash upsertFromIterator (Qore::AbstractIterator i, int upsert_strategy=AbstractTable::UpsertAuto, *hash opt)
 this method upserts or merges data from the given iterator argument (whose getValue() method must return a hash giving row values) into the current table; no transaction management is performed with this method More...
 
*hash upsertFromIteratorCommit (Qore::AbstractIterator i, int upsert_strategy=AbstractTable::UpsertAuto, *hash opt)
 this method upserts or merges data from the given iterator argument (whose getValue() method must return a hash giving row values) into the current table; the transaction is committed if successful, if an error occurs then it is rolled back More...
 
deprecated *hash upsertFromIteratorNoCommit (Qore::AbstractIterator i, int upsert_strategy=AbstractTable::UpsertAuto, *hash opt)
 A legacy SqlUtik::AbstractTable::upsertFromIterator() wrapper.
 
*hash upsertFromSelect (AbstractTable t, *hash sh, int upsert_strategy=AbstractTable::UpsertAuto, *hash opt)
 this method upserts or merges data from the given foreign table and select option hash into the current table; no transaction management is performed with this method More...
 
deprecated *hash upsertFromSelect (Table t, *hash sh, int upsert_strategy=AbstractTable::UpsertAuto, *hash opt)
 SqlUtil::AbstractTable::upsertFromSelect() variant
 
*hash upsertFromSelectCommit (AbstractTable t, *hash sh, int upsert_strategy=AbstractTable::UpsertAuto, *hash opt)
 this method upserts or merges data from the given foreign table and select option hash into the current table; the transaction is committed if successful, if an error occurs then it is rolled back More...
 
*hash upsertFromSelectCommit (Table t, *hash sh, int upsert_strategy=AbstractTable::UpsertAuto, *hash opt)
 SqlUtil::AbstractTable::upsertFromSelectCommit() variant
 
deprecated *hash upsertFromSelectNoCommit (AbstractTable t, *hash sh, int upsert_strategy=AbstractTable::UpsertAuto, *hash opt)
 A legacy SqlUtil::AbstractTable::upsertFromSelect() wrapper.
 
deprecated *hash upsertFromSelectNoCommit (Table t, *hash sh, int upsert_strategy=AbstractTable::UpsertAuto, *hash opt)
 A legacy SqlUtil::AbstractTable::upsertFromSelect() wrapper.
 
deprecated int upsertNoCommit (hash row, int upsert_strategy=UpsertAuto)
 A legacy SqlUtil::AbstractTable::upsert() wrapper.
 
private validateColumnOptions (string cname, reference opt, bool nullable)
 validates column options
 
- Public Member Functions inherited from SqlUtil::AbstractSqlUtilBase
private constructor (AbstractDatasource nds, *hash nopts)
 creates the object; private constructor More...
 
Qore::SQL::AbstractDatasource getDatasource ()
 gets the underlying AbstractDatasource
 
string getDatasourceDesc ()
 returns a descriptive string for the datasource
 
string getDriverName ()
 returns the database driver name
 
private validateHashKeysForWhitespaces (any node)
 Check input node for all hash keys - if it contains a key with whitespace in the beginning or at the end -> error.
 

Public Attributes

const AdditionalColumnDescOptions
 additional column description keys valid when describing columns in a table description hash More...
 
const AlignTableOptions
 table alignment options More...
 
const CacheOptions
 default cache options
 
const ColumnDescOptions
 Column description options. More...
 
const ColumnOptions = {}
 Column options; this is currently empty and can be extended in database-specific modules.
 
const ConstraintOptions = IndexOptions
 default constraint options More...
 
const ForeignConstraintOptions
 default foreign constraint options More...
 
const IndexOptions
 default index options More...
 
const InsertFromIteratorOptions
 default insert option keys More...
 
const InsertOptions
 generic SQL insert options More...
 
const SelectOptions
 default select options More...
 
const SqlDataCallbackOptions
 generic SQL data operation callbacks More...
 
const TableCreationOptions
 table creation options More...
 
const TableDescriptionHashOptions
 Table description options. More...
 
const TableOmissionOptions
 alignment omission options
 
const TableOptions
 table options More...
 
const TriggerOptions = AbstractDatabase::CreationOptions
 default trigger options More...
 
const UpsertAuto = 4
 Upsert option: if the target table is empty, use UpsertInsertFirst, otherwise use UpsertUpdateFirst. More...
 
const UpsertInsertFirst = 1
 Upsert option: insert first, if the insert fails, then update. More...
 
const UpsertInsertOnly = 5
 Upsert option: insert if the row does not exist, otherwise ignore. More...
 
const UpsertOptions
 default upsert option keys More...
 
const UpsertResultDescriptionMap
 hash mapping upsert descriptions to codes More...
 
const UpsertResultLetterMap
 maps upsert result codes to single letter symbols
 
const UpsertResultMap
 hash mapping upsert results to a description More...
 
const UpsertSelectFirst = 3
 Upsert option: select first, if the row is unchanged, do nothing, if it doesn't exist, insert, otherwise update. More...
 
const UpsertStrategyDescriptionMap
 hash mapping upsert strategy descriptions to upsert strategy codes More...
 
const UpsertStrategyMap
 hash mapping upsert strategy codes to a text description More...
 
const UpsertUpdateFirst = 2
 Upsert option: update first, if the update fails, then insert. More...
 
const UpsertUpdateOnly = 6
 Upsert option: update if the row exists, otherwise ignore. More...
 
const UR_Deleted = 5
 row was deleted (only possible with batch upsert methods such as AbstractTable::upsertFromIterator() where upsert option delete_others is True)
 
const UR_Inserted = 1
 row was inserted
 
const UR_Unchanged = 4
 row was unchanged (only possible with UpsertSelectFirst, UpsertInsertOnly, and UpsertUpdateOnly)
 
const UR_Updated = 3
 row was updated because it was different (only possible with UpsertSelectFirst)
 
const UR_Verified = 2
 row was updated unconditionally (not returned with UpsertSelectFirst)
 

Private Attributes

Columns columns
 column description object
 
Constraints constraints
 constraint descriptions
 
ForeignConstraints foreignConstraints
 foreign constraints description
 
bool inDb = False
 in database
 
Indexes indexes
 index descriptions
 
bool manual = False
 manual edits
 
string name
 the table's name
 
bool native_case = False
 native case option
 
AbstractPrimaryKey primaryKey
 primary key description
 
Triggers triggers
 trigger descriptions
 

Detailed Description

the base abstract class for the table implementation

Use SqlUtil::Table if you need to construct table object directly

Member Function Documentation

AbstractCheckConstraint SqlUtil::AbstractTable::addCheckConstraint ( string  cname,
string  src,
*hash  opt,
*reference  sql 
)

adds a check constraint to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example

Example:
1 string sql;
2 AbstractCheckConstraint cc = table.addCheckConstraint("check_mytable_id", "id > 10", NOTHING, \sql);
3 printf("%s;\n", sql);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
cnamethe name of the new constraint
srcthe source of the constraint clause
opta hash of options for the new constraint; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::ConstraintOptions
sqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
an AbstractCheckConstraint object corresponding to the check constraint created
Exceptions
CHECK-CONSTRAINT-ERRORthe table already has a constraint with the given name or invalid columns or options were passed
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractColumn SqlUtil::AbstractTable::addColumn ( string  cname,
hash  opt,
bool  nullable = True,
*reference  lsql 
)

adds a column to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example

Example:
1 table.addColumn("name", ("qore_type": Type::String, "size": 50), False);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
cnamethe name of the column
opta hash describing the column; the following keys are permitted (other column options may be supported depending on the underlying AbstractTable implementation):
  • qore_type: a qore type string that will be converted to a native DB type with some default conversion;
  • native_type: the native database column type; if both native_type and qore_type are given then native_type is used
  • size: for data types requiring a size component, the size; for numeric columns this represents the precision for example
  • scale: for numeric data types, this value gives the scale
  • default_value: the default value for the column
  • default_value_native: a boolean flag to say if a default_value should be validated against table column type (False) or used as it is (True) to allow to use DBMS native functions or features. Defaults to False. It is strongly recommended to use default_value_native for default_value in driver specific sub-hash to avoid non-portable schema hashes
nullableif True then the column can hold NULL values; note that primary key columns cannot be nullable
lsqlan optional reference to a list of strings to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Exceptions
COLUMN-ERRORno native_type or qore_type keys in column option hash, column already exists, invalid column data
Note
make sure and add a default_value value when adding a column with a "not null" constraint with existing data
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractForeignConstraint SqlUtil::AbstractTable::addForeignConstraint ( string  cname,
softlist  cols,
string  table,
*softlist  tcols,
*hash  opt,
*reference  sql 
)

adds a foreign constraint to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example

Example:
1 string sql;
2 AbstractForeignConstraint fc = table.addForeignConstraint("fk_mytable_other_table", ("name", "version"), "other_table", NOTHING, \sql);
3 printf("%s;\n", sql);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
cnamethe name of the new foreign constraint
colsa single column name or a list of columns in the local table that make up the foreign constraint
tablethe name of the other table that the constraint targets
tcolsa single column name or a list of columns in the foreign table or NOTHING meaning that the column names are the same as in the local table; if column names are given the same number of columns must be given in the local and foreign tables
opta hash of options for the new foreign constraint; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::ForeignConstraintOptions
sqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
an AbstractForeignConstraint object corresponding to the foreign constraint created
Exceptions
FOREIGN-CONSTRAINT-ERRORthe table already has a constraint with the given name or invalid columns or options were passed
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractIndex SqlUtil::AbstractTable::addIndex ( string  iname,
bool  unique,
softlist  cols,
*hash  opt,
*reference  sql 
)

adds an index to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example

Example:
1 string sql;
2 AbstractIndex ix = table.addIndex("uk_mytable_name", True, "name", ("index_tablespace": "index1"), \sql);
3 printf("%s;\n", sql);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
inamethe name of the new index
uniquea flag to tell if the new index should be unique or not
colsa single column name or a list of columns that make up the index
opta hash of options for the new index; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::IndexOptions
sqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
an AbstractIndex object corresponding to the index created
Exceptions
INDEX-ERRORthe table already has an index with the given name or invalid columns or options were passed
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractPrimaryKey SqlUtil::AbstractTable::addPrimaryKey ( string  pkname,
softlist  cols,
*hash  opt,
*reference  sql 
)

adds a primary key to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example

Example:
1 string sql;
2 AbstractPrimaryKey pk = table.addPrimaryKey("pk_mytable", "id", ("index_tablespace": "index1"), \sql);
3 printf("%s;\n", sql);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
pknamethe name of the new primary key constraint
colsa single column name or a list of columns that make up the primary key
opta hash of options for the new primary key; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::ConstraintOptions
sqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
an AbstractPrimaryKey object corresponding to the primary key created
Exceptions
PRIMARY-KEY-ERRORthe table already has a primary key or invalid columns or options passed
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractTrigger SqlUtil::AbstractTable::addTrigger ( string  tname,
string  src,
*hash  opt,
*reference  lsql 
)

adds a trigger to the table; if the table is already known to be in the database, then it is added in the database also immediately; otherwise it is only added internally and can be created when create() is called for example

Example:
1 string sql;
2 AbstractTrigger trig = table.addTrigger("trig_mytable", "", NOTHING, \sql);
3 printf("%s;\n", sql);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
tnamethe name of the new trigger
srcthe source of the trigger
opta hash of options for the new trigger; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::TriggerOptions
lsqlan optional reference to a list of strings to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
an AbstractTrigger object corresponding to the trigger created
Exceptions
TRIGGER-ERRORthe table already has a trigger with the given name or invalid options were passed
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractUniqueConstraint SqlUtil::AbstractTable::addUniqueConstraint ( string  cname,
softlist  cols,
*hash  opt,
*reference  sql 
)

adds a unique constraint to the table; if the table is known to be in the database already, then the constraint is added to the database also immediately; otherwise it is only added internally and can be created when create() is called for example

Example:
1 string sql;
2 AbstractUniqueConstraint c = table.addUniqueConstraint("uk_mytable", "name", ("index_tablespace": "index1"), \sql);
3 printf("%s;\n", sql);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
cnamethe name of the new unique constraint
colsa single column name or a list of columns that make up the unique constraint
opta hash of options for the new unique constraint; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::ConstraintOptions
sqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
an AbstractUniqueConstraint object corresponding to the unique constraint created
Exceptions
UNIQUE-CONSTRAINT-ERRORthe table already has a constraint with the given name or invalid columns passed
OPTION-ERRORinvalid or unsupported option passed
See Also
inDb() for a method that tells if the table is already in the database or not
bool SqlUtil::AbstractTable::bindEmptyStringsAsNull ( )

returns True if the DB treats empty strings as NULL, False if not; by default this method returns False

Since
SqlUtil 1.3
SqlUtil::AbstractTable::cache ( *hash  opts)

reads in all attributes of the table from the database

Example:
1 table.cache();
Parameters
optscache options; see SqlUtil::AbstractTable::CacheOptions for common options; each driver can support additional driver-specific options
bool SqlUtil::AbstractTable::checkExistence ( )

returns True if the table exists in the database, False if not

this method will actively check the database if the table is defined there in case no configuration from the database has already been cached for the object

See Also
AbstractTable::inDb()
abstract private bool SqlUtil::AbstractTable::checkExistenceImpl ( )
pure virtual

returns True if the table exists in the DB, False if not

this method will only be called if inDb is False and should set inDb = True if it returns True

SqlUtil::AbstractTable::clear ( )

purges the current table definition

Example:
1 table.clear();
private SqlUtil::AbstractTable::constructor ( AbstractDatasource  nds,
string  nname,
*hash  nopts 
)

creates the object; private constructor

Parameters
ndsthe AbstractDatasource for the connection to the database
nnamethe name of the table
noptsan optional hash of options for the table creation string; see SqlUtil::AbstractTable::TableOptions for common options; each driver can support additional driver-specific options
Exceptions
OPTION-ERRORinvalid or unsupported option passed
SqlUtil::AbstractTable::create ( *hash  opt)

creates the table with all associated properties (indexes, constraints, etc) without any transaction management

Example:
1 table.create();
Parameters
opta hash of options for the SQL creation strings
Note
Transaction management is normally not performed when creating tables, however this method uses the Qore::SQL::AbstractDatasource::exec() method, which normally participates in acquiring a transaction lock for the underlying datasource object; therefore after this method executes normally the transaction lock will be dedicated to the calling thread.
Exceptions
CREATE-TABLE-ERRORtable has already been read from or created in the database
SqlUtil::AbstractTable::createCommit ( *hash  opt)

creates the table in the database; releases the transaction lock after creating the table

Example:
1 table.createCommit();
Parameters
opta hash of options for the SQL creation strings
Note
The transaction is committed if successful or rolled back if an exception occurs; use create() to execute without any transaction management
int SqlUtil::AbstractTable::del ( hash  cond,
reference  sql,
hash  opt 
)

deletes rows in the table matching the condition and returns the count of rows deleted; no transaction management is performed with this method

Example:
1 int dcnt = table.del(("name": name));
Parameters
conda hash of conditions for the where clause; see Where Clauses for more information
sqlan optional reference to a string to return the SQL generated for the select statement
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
the count of rows deleted
Exceptions
WHERE-ERRORunknown operator or invalid arguments given in the cond hash for the where clause
See Also
delCommit(*hash)
int SqlUtil::AbstractTable::delCommit ( hash  cond,
reference  sql,
hash  opt 
)

deletes rows in the table matching the condition and returns the count of rows deleted; the transaction is committed if successful, if an error occurs then it is rolled back

Example:
1 int dcnt = table.delCommit(("name": name));
Parameters
conda hash of conditions for the where clause; see Where Clauses for more information
sqlan optional reference to a string to return the SQL generated for the select statement
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
the count of rows deleted
Exceptions
WHERE-ERRORunknown operator or invalid arguments given in the cond hash for the where clause
See Also
delete(*hash)
Columns SqlUtil::AbstractTable::describe ( )

returns an object of class Columns describing the table

Example:
1 Columns cols = table.describe();
Returns
an object of class Columns describing the table
SqlUtil::AbstractTable::drop ( *hash  opt)

drops the table from the database without any transaction management

Example:
1 table.drop();
Parameters
optoptional callback options; see AbstractDatabase::CallbackOptions for more info
Exceptions
OPTION-ERRORinvalid or unknown callback option
Note
Transaction management is normally not performed when dropping tables, however this method uses the Qore::SQL::AbstractDatasource::exec() method, which normally participates in acquiring a transaction lock for the underlying datasource object; therefore after this method executes normally the transaction lock will be dedicated to the calling thread.
AbstractColumn SqlUtil::AbstractTable::dropColumn ( string  cname,
*reference  lsql 
)

drops a column from the table

Example:
1 table.dropColumn("notes_2");

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
cnamethe name of the column to drop
lsqlan optional reference to a list of strings to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
the AbstractColumn object representing the column dropped from the table
Exceptions
COLUMN-ERRORthe named column is not present in the table
Note
this method retrieves the table definition from the database if none has already been defined
See Also
inDb() for a method that tells if the table is already in the database or not
SqlUtil::AbstractTable::dropCommit ( *hash  opt)

drops the table from the database; releases the transaction lock after dropping the table

Example:
1 table.dropCommit();
Parameters
optoptional callback options; see AbstractDatabase::CallbackOptions for more info
Exceptions
OPTION-ERRORinvalid or unknown callback option
Note
The transaction is committed if successful or rolled back if an exception occurs; use drop() to execute without any transaction management
AbstractConstraint SqlUtil::AbstractTable::dropConstraint ( string  cname,
*reference  sql 
)

drops a constraint from the table; this can be any constraint on the table, a primary key, a foreign key constraint, or a generic constraint; if the table is known to be in the database already, then it is also dropped from the database immediately; otherwise it is only removed internally

Example:
1 table.dropConstraint("uk_mytable_name");

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
cnamethe name of the constraint to drop
sqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
the constraint dropped from the table
Exceptions
CONSTRAINT-ERRORthe given constraint does not exist in the table
Note
this method retrieves current constraint definitions from the database if not already loaded or defined
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractForeignConstraint SqlUtil::AbstractTable::dropForeignConstraint ( string  cname,
*reference  sql 
)

drops a foreign constraint from the table; if the table is known to be in the database already, then it is also dropped from the database immediately; otherwise it is only removed internally

Example:
1 table.dropForeignConstraint("uk_mytable_name");

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
cnamethe name of the foreign constraint to drop
sqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
the foreign constraint dropped from the table
Exceptions
FOREIGN-CONSTRAINT-ERRORthe given constraint does not exist
Note
this method retrieves all current foreign constraint definitions from the database if none have already been defined
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractIndex SqlUtil::AbstractTable::dropIndex ( string  iname,
*reference  sql 
)

drops the given index from the table; if the table is known to be in the database already, then it is also dropped from the database immediately; otherwise it is only removed internally

Example:
1 table.dropIndex("uk_mytable_name");

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
inamethe name of the index to drop
sqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
the index dropped from the table
Exceptions
INDEX-ERRORthe given index does not exist
Note
this method retrieves all current index definitions from the database if none have already been defined
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractPrimaryKey SqlUtil::AbstractTable::dropPrimaryKey ( *reference  lsql)

drops the primary key from the table; if the table is known to be in the database already, then it is also dropped from the database immediately; otherwise it is only removed internally

Example:
1 table.dropPrimaryKey();

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
lsqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
the primary key dropped from the table
Exceptions
PRIMARY-KEY-ERRORno primary key exists
Note
  • this method retrieves the primary key definition from the database if none has already been defined
  • if there are known foreign contraints on the primary key, SQL for dropping those constraints is also included
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractTrigger SqlUtil::AbstractTable::dropTrigger ( string  tname,
*reference  sql 
)

drops the given trigger from the table; if the table is known to be in the database already, then it is also dropped from the database immediately; otherwise it is only removed internally

Example:
1 table.dropTrigger("trig_mytable");

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
tnamethe name of the trigger to drop
sqlan optional reference to a string to retrieve the SQL used to modify the database (only executed if the table is already in the database)
Returns
the trigger dropped from the table
Exceptions
TRIGGER-ERRORthe given trigger does not exist
Note
this method retrieves all current trigger definitions from the database if none have already been defined
See Also
inDb() for a method that tells if the table is already in the database or not
bool SqlUtil::AbstractTable::empty ( )

returns True if the table has no definitions, False if not

Example:
1 bool b = table.empty();
Returns
True if the table has no definitions, False if not
See Also
emptyData()
bool SqlUtil::AbstractTable::emptyData ( )

returns True if the table has no data rows, False if not

Example:
1 bool b = table.emptyData();
Returns
True if the table has no data rows, False if not
See Also
*hash SqlUtil::AbstractTable::find ( any  id)

finds a row in the table with the given primary key value; if no row matches the primary key value passed then NOTHING is returned

Example:
1 *hash row = table.find(id);
Exceptions
PRIMARY-KEY-ERRORthe table has no primary key or the primary key has more than one column
*list SqlUtil::AbstractTable::find ( list  ids)

finds rows in the table with the given primary key values; if no row matches any primary key value passed then NOTHING is returned

Example:
1 *list rows = table.find(list);
Parameters
idsthe list of primary key IDs to find; if the list is empty then NOTHING is returned
Returns
a list of hashes of rows matching the primary key IDs passed or NOTHING if no row matches any primary key value passed
Exceptions
PRIMARY-KEY-ERRORthe table has no primary key or the primary key has more than one column
*hash SqlUtil::AbstractTable::find ( hash  row)

finds a row in the table with the given primary key value given as a hash; if no row matches the primary key value passed then NOTHING is returned

Example:
1 *hash row = table.find(("account_type": type, "name": name));
Parameters
rowa hash giving the primary key value to find; other columns may also appear in the hash, however at least all columns of the primary key must be present
Returns
a hash of the row value matching the primary key value passed or NOTHING if no row matches the primary key value passed
Exceptions
PRIMARY-KEY-ERRORthe table has no primary key or the the hash passed does not contain all columns of the primary key
Note
a table with a primary key with a single column can also be used with this method; just pass a hash with one key
*list SqlUtil::AbstractTable::findAll ( *hash  cond)

finds all rows in the table with the given column values; a list of hashes is returned representing the rows returned

Example:
1 *list rows = table.findAll(h);
Parameters
conda hash giving the column values to find; see Where Clauses for the format of this argument
Returns
a list of hashes is returned representing the rows returned
Exceptions
WHERE-ERRORunknown operator or invalid arguments given in the cond hash for the where clause
Note
this is equivalent to calling selectRows() with where = cond
*hash SqlUtil::AbstractTable::findSingle ( *hash  cond)

finds a single row in the table that match the row condition passed; multiple rows may match, but only one row will be returned from the database; if no row matches the condition hash passed then NOTHING is returned

Example:
1 *hash row = table.findSingle(h);
Parameters
conda hash giving the column values to find; see Where Clauses for the format of this argument
Returns
a hash representing a single row in the table with the given column values; multiple rows may match, but only one row will be returned from the database; if no row matches the condition hash passed then NOTHING is returned
Exceptions
WHERE-ERRORunknown operator or invalid arguments given in the cond hash for the where clause
Note
this is equivalent to calling selectRow() with where = cond and limit = 1
*AbstractUniqueConstraint SqlUtil::AbstractTable::findUniqueConstraint ( string  name)

returns the given AbstractUniqueConstraint object if defined for the table (also includes the primary key)

Example:
1 my *AbstractUniqueConstraint uk = table.findUniqueConstraint("uk_table2");
Parameters
namethe name of the unique constraint to find
Returns
the given AbstractUniqueConstraint object if defined for the table (also includes the primary key)
string SqlUtil::AbstractTable::getAddCheckConstraintSql ( string  cname,
string  src,
*hash  copt,
*hash  opt 
)

returns an SQL string that can be used to add a check constraint to the table

Example:
1 string sql = table.getAddCheckConstraintSql("check_mytable_id", "id > 10");
2 printf("%s;\n", sql);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
cnamethe name of the new constraint
srcthe source of the constraint clause
copta hash of options for the new constraint; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::ConstraintOptions
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
an SQL string that can be used to add a check constraint to the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
CHECK-CONSTRAINT-ERRORthe table already has a constraint with the given name or invalid columns or options were passed
See Also
inDb() for a method that tells if the table is already in the database or not
Note
if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
list SqlUtil::AbstractTable::getAddColumnSql ( string  cname,
hash  copt,
bool  nullable = True,
*hash  opt 
)

returns a list of SQL strings that can be use to add a column to the table

Example:
1 list l = table.getAddColumnSql("name", ("qore_type": Type::String, "size": 50), False);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
cnamethe name of the column
copta hash describing the column; the following keys are permitted (other column options may be supported depending on the underlying AbstractTable implementation):
  • qore_type: a qore type string that will be converted to a native DB type with some default conversion;
  • native_type: the native database column type; if both native_type and qore_type are given then native_type is used
  • size: for data types requiring a size component, the size; for numeric columns this represents the precision for example
  • scale: for numeric data types, this value gives the scale
  • default_value: the default value for the column
  • default_value_native: a boolean flag to say if a default_value should be validated against table column type (False) or used as it is (True) to allow to use DBMS native functions or features. Defaults to False. It is strongly recommended to use default_value_native for default_value in driver specific sub-hash to avoid non-portable schema hashes
nullableif True then the column can hold NULL values; note that primary key columns cannot be nullable
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
a list of SQL strings that can be use to add a column to the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
COLUMN-ERRORno native_type or qore_type keys in column option hash, column already exists, invalid column data
Note
  • make sure and add a default_value value when adding a column with a "not null" constraint with existing data
  • if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
See Also
inDb() for a method that tells if the table is already in the database or not
string SqlUtil::AbstractTable::getAddForeignConstraintSql ( string  cname,
softlist  cols,
string  table,
*softlist  tcols,
*hash  fkopt,
*hash  opt 
)

returns an SQL string that can be used to add a foreign constraint to the table

Example:
1 string sql = table.getAddForeignConstraintSql("fk_mytable_other_table", ("name", "version"), "other_table");
2 printf("%s;\n", sql);
Parameters
cnamethe name of the new foreign constraint
colsa single column name or a list of columns in the local table that make up the foreign constraint
tablethe name of the other table that the constraint targets
tcolsa single column name or a list of columns in the foreign table or NOTHING meaning that the column names are the same as in the local table; if column names are given the same number of columns must be given in the local and foreign tables
fkopta hash of options for the new foreign constraint; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::ForeignConstraintOptions
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
an SQL string that can be used to add a foreign constraint to the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
FOREIGN-CONSTRAINT-ERRORthe table already has a constraint with the given name or invalid columns or options were passed
See Also
inDb() for a method that tells if the table is already in the database or not
Note
if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
string SqlUtil::AbstractTable::getAddIndexSql ( string  iname,
bool  unique,
softlist  cols,
*hash  ixopt,
*hash  opt 
)

returns an SQL string that can be used to add an index to the table

Example:
1 string sql = table.getAddIndexSql("uk_mytable_name", True, "name", ("index_tablespace": "index1"));
2 printf("%s;\n", sql);
Parameters
inamethe name of the new index
uniquea flag to tell if the new index should be unique or not
colsa single column name or a list of columns that make up the index
ixopta hash of options for the new index; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::IndexOptions
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
an SQL string that can be used to add an index to the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
INDEX-ERRORthe table already has an index with the given name or invalid columns or options were passed
See Also
inDb() for a method that tells if the table is already in the database or not
Note
if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
string SqlUtil::AbstractTable::getAddPrimaryKeySql ( string  pkname,
softlist  cols,
*hash  pkopt,
*hash  opt 
)

returns the SQL that can be used to add a primary key to the table

Example:
1 string sql = table.getAddPrimaryKeySql("pk_mytable", "id", ("index_tablespace": "index1"), opt);
2 printf("%s;\n", sql);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
pknamethe name of the new primary key constraint
colsa single column name or a list of columns that make up the primary key
pkopta hash of options for the new primary key; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::ConstraintOptions
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
the SQL that can be used to add a primary key to the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
PRIMARY-KEY-ERRORthe table already has a primary key or invalid columns or options passed
See Also
inDb() for a method that tells if the table is already in the database or not
Note
if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
list SqlUtil::AbstractTable::getAddTriggerSql ( string  tname,
string  src,
*hash  topt,
*hash  opt 
)

returns a list of SQL strings that can be used to add a trigger to the table

Example:
1 string sql = table.getAddTriggerSql("trig_mytable", trigger_src);
2 printf("%s;\n", sql);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
tnamethe name of the new trigger
srcthe source of the trigger
topta hash of options for the new trigger; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::TriggerOptions
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
a list of SQL strings that can be used to add a trigger to the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
TRIGGER-ERRORthe table already has a trigger with the given name or invalid options were passed
See Also
inDb() for a method that tells if the table is already in the database or not
Note
if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
string SqlUtil::AbstractTable::getAddUniqueConstraintSql ( string  cname,
softlist  cols,
*hash  ukopt,
*hash  opt 
)

returns an SQL string that can be used to add a unique constraint to the table

Example:
1 string sql = table.getAddUniqueConstraintSql("uk_mytable", "name", ("index_tablespace": "index1"));
2 printf("%s;\n", sql);
Parameters
cnamethe name of the new unique constraint
colsa single column name or a list of columns that make up the unique constraint
ukopta hash of options for the new unique constraint; each driver may implement its own options; for common options, see SqlUtil::AbstractTable::ConstraintOptions
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
an SQL string that can be used to add a unique constraint to the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
UNIQUE-CONSTRAINT-ERRORthe table already has a constraint with the given name or invalid columns passed
See Also
inDb() for a method that tells if the table is already in the database or not
Note
if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
list SqlUtil::AbstractTable::getAlignSql ( AbstractTable  t,
*hash  opt 
)

accepts an AbstractTable argument and returns a list of SQL strings required to align the structure and configuration of the current table with that of the argument; if the tables are identical then an empty list is returned

Example:
1 list l = table.getAlignSql(table2);
Parameters
tthe template table that the current table will be compared to
opta hash of options for the SQL creation string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
a list of SQL strings required to align the structure and configuration of the current table with that of the AbstractTable argument; if the tables are identical then an empty list is returned
Exceptions
ALIGN-TABLE-ERRORthe argument must be of the same class as the current object; template table has no columns
OPTION-ERRORinvalid or unsupported option passed
Note
if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
string SqlUtil::AbstractTable::getAlignSqlString ( AbstractTable  t,
*hash  opt 
)

accepts an AbstractTable argument and returns an SQL string that could be executed to align the structure and configuration of the current table with that of the argument; if the tables are identical then an empty string is returned

Example:
1 string sql = table.getAlignSqlString(table2);
Parameters
tthe template table that the current table will be compared to
opta hash of options for the SQL creation string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
an SQL string that could be executed to align the structure and configuration of the current table with that of the argument; if the tables are identical then an empty string is returned
Exceptions
ALIGN-TABLE-ERRORthe argument must be of the same class as the current object; template table has no columns
OPTION-ERRORinvalid or unsupported option passed
private hash SqlUtil::AbstractTable::getAlignTableOptions ( )

returns the align table options for this driver

override in subclasses to return driver-specific options

code SqlUtil::AbstractTable::getBulkUpsertClosure ( hash  example_row,
int  upsert_strategy = AbstractTable::UpsertAuto,
*hash  opt 
)

returns a closure that can be executed given a hash argument representing either a single row or a set of rows (where each key value is a list of column values) that will be updated or inserted in the database with the given upsert strategy; the table must have a unique key to do this; the closure returned does not check the input hash for validity

Example:
1 Datasource ds("pgsql:user/pass@db%localhost");
2 Table table(ds, "table_name");
3 code upsert = table.getBulkUpsertClosure(row, AbstractTable::UpsertSelectFirst);
4 on_success ds.commit();
5 on_error ds.rollback();
6 upsert(row_hash);
Parameters
example_rowa hash representing an example row to insert or update; every hash passed to the upsert closure returned must have the same keys in the same order
upsert_strategysee Upsert Strategy Codes for possible values for the upsert strategy
opta hash of options for the upsert operation; see SqlUtil::AbstractTable::UpsertOptions for common options; each driver can support additional driver-specific options
Returns
a closure that can be executed given a hash argument representing either a single row or a set of rows (where each key value is a list of column values) that will be updated or inserted in the database with the given upsert strategy; the closure returned does not check the input hash for validity; the closure has the following signature:
1 int sub upsert(hash row) {}
The return value of the closure is always SqlUtil::AbstractTable::UR_Verified; see Upsert Result Codes for more information
Exceptions
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
UPSERT-ERRORno primary key, unique constraint, or unique index for upsert; not all columns of the unique constraint/index are used in the upsert statement
Note
the row values passed to the closure for upserting are not checked if they match the example row passed to the getUpsertClosure() method; passing non-conforming data will cause errors; see SqlUtil::AbstractTable::getUpsertClosureWithValidation() for a similar method that returns a validating closure; the closure returned by this method is faster than the one returned by SqlUtil::AbstractTable::getUpsertClosure() since there is no validation
See Also
private hash SqlUtil::AbstractTable::getCacheOptions ( )

returns the cache options for this driver

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getColumnDescOptions ( )

returns the column description options for this driver

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getColumnOperatorMap ( )

returns the column operator map for this object

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getColumnOptions ( )

returns the column options for this driver

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getConstraintOptions ( )

returns the constraint options for this driver

override in subclasses to return driver-specific options

*list SqlUtil::AbstractTable::getCreateConstraintsSql ( *hash  opt,
bool  cache = True 
)

returns a list of SQL strings that could be used to create non-foreign constraints on the table or NOTHING if there are no non-foreign constraints on the table

Example:
1 *list l = table.getCreateConstraintsSql();
Parameters
opta hash of options for the non-foreign constraint creation string; see SqlUtil::AbstractTable::ConstraintOptions for common options; each driver can support additional driver-specific options
cacheread in data from the database for uncached properties of the table
Returns
a list of SQL strings that could be used to create non-foreign constraints on the table or NOTHING if there are no non-foreign constraints on the table
See Also
getCreateForeignConstraintsSql()
Exceptions
OPTION-ERRORinvalid or unsupported option passed
*list SqlUtil::AbstractTable::getCreateForeignConstraintsSql ( *hash  opt,
bool  cache = True 
)

returns a list of SQL strings that could be used to create foreign constraints on the table or NOTHING if there are no foreign constraints on the table

Example:
1 *list l = table.getCreateForeignConstraintsSql();
Parameters
opta hash of options for the foreign constraint creation string; see SqlUtil::AbstractTable::ForeignConstraintOptions for common options; each driver can support additional driver-specific options
cacheread in data from the database for uncached properties of the table
Returns
a list of SQL strings that could be used to create foreign constraints on the table or NOTHING if there are no foreign constraints on the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
*list SqlUtil::AbstractTable::getCreateIndexesSql ( *hash  opt,
bool  cache = True 
)

returns a list of SQL strings that could be used to create indexes on the table or NOTHING if there are no indexes on the table

Example:
1 *list l = table.getCreateIndexesSql();
Parameters
opta hash of options for the index creation string; see SqlUtil::AbstractTable::IndexOptions for common options; each driver can support additional driver-specific options
cacheread in data from the database for uncached properties of the table
Returns
a list of SQL strings that could be used to create indexes on the table or NOTHING if there are no indexes on the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
*list SqlUtil::AbstractTable::getCreateMiscSql ( *hash  opt,
bool  cache = True 
)

returns a list of SQL strings that could be used to create other table attributes (such as comments, if supported and present) or NOTHING if there are none

Example:
1 *list l = table.getCreateMiscSql();
Parameters
opta hash of options for the SQL creation string; see TableCreationOptions for common options; each driver can support additional driver-specific options
cacheread in data from the database for uncached properties of the table
Returns
a list of SQL strings that could be used to create other table attributes (such as comments, if supported and present) or NOTHING if there are none
Exceptions
OPTION-ERRORinvalid or unsupported option passed
*string SqlUtil::AbstractTable::getCreatePrimaryKeySql ( *hash  opt,
bool  cache = True 
)

returns an SQL string that could be used to create the primary key on the table

Example:
1 *string sql = table.getCreatePrimaryKeySql();
Parameters
opta hash of options for the primary key creation string; see SqlUtil::AbstractTable::ConstraintOptions for common options; each driver can support additional driver-specific options
cacheread in data from the database for uncached properties of the table
Returns
an SQL string that could be used to create the primary key on the table or NOTHING if there is no primary key on the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
list SqlUtil::AbstractTable::getCreateSql ( *hash  opt)

returns a list of SQL strings that could be used to create the table and all known properties of the table

Example:
1 map printf("$1;\n", $1), table.getCreateSql();
Parameters
opta hash of options for the table, index, and constraint creation strings; see TableCreationOptions for common options; each driver can support additional driver-specific options
Returns
a list of SQL strings that could be used to create the table and all known properties of the table
string SqlUtil::AbstractTable::getCreateSqlString ( *hash  opt)

returns an SQL string that could be used to create the table and all known properties of the table

Example:
1 printf("%s\n", table.getCreateSql());
Parameters
opta hash of options for the SQL creation string
Returns
an SQL string that could be used to create the table and all known properties of the table
string SqlUtil::AbstractTable::getCreateTableSql ( *hash  opt)

returns an SQL string that could be used to create the basic table structure without indexes and constraints

Example:
1 string sql = table.getCreateTableSql();
Parameters
opta hash of options for the table creation string; see TableCreationOptions for common options; each driver can support additional driver-specific options
Returns
an SQL string that could be used to create the basic table structure without indexes and constraints
Exceptions
OPTION-ERRORinvalid or unsupported option passed
*list SqlUtil::AbstractTable::getCreateTriggersSql ( *hash  opt,
bool  cache = True 
)

returns a list of SQL strings that could be used to create triggers on the table or NOTHING if there are no triggers on the table

Example:
1 *list l = table.getCreateTriggersSql();
Parameters
opta hash of options for the trigger creation strings; see TableCreationOptions for common options; each driver can support additional driver-specific options
cacheread in data from the database for uncached properties of the table
Returns
a list of SQL strings that could be used to create triggers on the table or NOTHING if there are no triggers on the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
See Also
getCreateTriggersSql()
string SqlUtil::AbstractTable::getDesc ( )

returns a descriptive string of the datasource (without the password) and the table name (with a possible qualifier for schema, etc)

Used in exception descriptions

Since
SqlUtil 1.3
list SqlUtil::AbstractTable::getDropAllConstraintsAndIndexesOnColumnSql ( string  cname,
*hash  opt 
)

gets a list of SQL strings to drop all constraints and indexes with the given column name; if the column does not exist then an empty list is returned

Example:
1 list l = table.getDropAllConstraintsAndIndexesOnColumnSql("status");
Parameters
cnamethe name of the column
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Exceptions
OPTION-ERRORinvalid or unsupported option passed
Note
  • this method retrieves current primary key definition from the database if not already loaded or defined
  • if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
See Also
inDb() for a method that tells if the table is already in the database or not
list SqlUtil::AbstractTable::getDropColumnSql ( string  cname,
*hash  opt 
)

returns the SQL that can be used to drop a column from the table

Example:
1 string sql = table.getDropColumnSql("notes_2");
Parameters
cnamethe name of the column to drop
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
the SQL that can be used to drop a column from the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
COLUMN-ERRORthe named column is not present in the table
Note
See Also
inDb() for a method that tells if the table is already in the database or not
*string SqlUtil::AbstractTable::getDropConstraintIfExistsSql ( string  cname,
*hash  opt,
*reference  cref 
)

gets the SQL that can be used to drop a constraint from the table if it exists, otherwise returns NOTHING; this can be any constraint on the table, a primary key, a foreign key constraint, or a generic constraint

Example:
1 *string sql = table.getDropConstraintIfExistsSql("uk_mytable_name");
Parameters
cnamethe name of the constraint to drop
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
crefan optional reference to an AbstractConstraint object that will return the constraint dropped
Returns
the SQL that can be used to drop a constraint from the table if it exists, otherwise returns NOTHING; this can be any constraint on the table, a primary key, a foreign key constraint, or a generic constraint
Exceptions
OPTION-ERRORinvalid or unsupported option passed
Note
  • this method retrieves current constraint definitions from the database if not already loaded or defined
  • if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
See Also
inDb() for a method that tells if the table is already in the database or not
string SqlUtil::AbstractTable::getDropConstraintSql ( string  cname,
*hash  opt 
)

gets the SQL that can be used to drop a constraint from the table; this can be any constraint on the table, a primary key, a foreign key constraint, or a generic constraint

Example:
1 string sql = table.getDropConstraintSql("uk_mytable_name");
Parameters
cnamethe name of the constraint to drop
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
the SQL that can be used to drop a constraint from the table; this can be any constraint on the table, a primary key, a foreign key constraint, or a generic constraint
Exceptions
OPTION-ERRORinvalid or unsupported option passed
CONSTRAINT-ERRORthe given constraint does not exist in the table
Note
  • this method retrieves current constraint definitions from the database if not already loaded or defined
  • if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
See Also
inDb() for a method that tells if the table is already in the database or not
string SqlUtil::AbstractTable::getDropIndexSql ( string  iname,
*hash  opt 
)

gets the SQL that can be used to drop an index from the table

Example:
1 string sql = table.getDropIndexSql("uk_mytable_name");
Parameters
inamethe name of the index to drop
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
the SQL that can be used to drop an index from the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
INDEX-ERRORthe given index does not exist in the table
Note
  • this method retrieves current index definitions from the database if not already loaded or defined
  • if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
See Also
inDb() for a method that tells if the table is already in the database or not
list SqlUtil::AbstractTable::getDropPrimaryKeySql ( *hash  opt)

gets a list of SQL strings that can be used to drop the primary key from the table

Example:
1 list l = table.getDropPrimaryKeySql();
Parameters
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
a list of SQL strings that can be used to drop the primary key from the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
PRIMARY-KEY-ERRORthe table has no primary key
Note
  • this method retrieves current primary key definition from the database if not already loaded or defined
  • if there are known foreign contraints on the primary key, SQL for dropping those constraints is also returned
  • if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
See Also
inDb() for a method that tells if the table is already in the database or not
softlist SqlUtil::AbstractTable::getDropSql ( *hash  opt)

returns the sql required to drop the table; reimplement in subclasses if necessary

Example:
1 list l = table.getDropSql();
Parameters
optoptional callback options; see AbstractDatabase::CallbackOptions for more info
Returns
a list of strings that can be used to drop the table and any other objects assocatied with the table (for example: PostgreSQL table trigger function(s))
Exceptions
OPTION-ERRORinvalid or unknown callback option
list SqlUtil::AbstractTable::getDropTriggerSql ( string  tname,
*hash  opt 
)

returns SQL that can be used to drop the given trigger from the table

Example:
1 string sql = table.getDropTriggerSql("trig_mytable");
Parameters
tnamethe name of the trigger to drop
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
the SQL that can be used to drop the given trigger from the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
TRIGGER-ERRORthe given trigger does not exist
Note
  • this method retrieves all current trigger definitions from the database if none have already been defined
  • if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
See Also
inDb() for a method that tells if the table is already in the database or not
private hash SqlUtil::AbstractTable::getForeignConstraintOptions ( )

return the foreign constraint options for this driver

override in subclasses to return driver-specific options

Indexes SqlUtil::AbstractTable::getIndexes ( )

returns an object of class Indexes describing the indexes on the table

If there are no indexes on the table then the object returned will be empty (see SqlUtil::Indexes::empty())

Example:
1 Indexes ix = table.getIndexes();
Returns
an object of class Indexes describing the indexes on the table
private hash SqlUtil::AbstractTable::getIndexOptions ( )

returns the index options for this driver

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getInsertFromIteratorOptions ( )

returns the insert from iterator options for this driver

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getInsertOperatorMap ( )

returns the insert operator map for this object

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getInsertOptions ( )

returns the insert options for this driver

override in subclasses to return driver-specific options

list SqlUtil::AbstractTable::getModifyColumnSql ( string  cname,
hash  copt,
bool  nullable = True,
*hash  opt 
)

gets a list of SQL strings that can be used to modify an existing column in the table

Example:
1 list l = table.getModifyColumnSql("name", ("qore_type": Type::String, "size": 240), False);
Parameters
cnamethe name of the column
copta hash describing the column; the following keys are permitted (other column options may be supported depending on the underlying AbstractTable implementation):
  • qore_type: a qore type string that will be converted to a native DB type with some default conversion;
  • native_type: the native database column type; if both native_type and qore_type are given then native_type is used
  • size: for data types requiring a size component, the size; for numeric columns this represents the precision for example
  • scale: for numeric data types, this value gives the scale
  • default_value: the default value for the column
  • default_value_native: a boolean flag to say if a default_value should be validated against table column type (False) or used as it is (True) to allow to use DBMS native functions or features. Defaults to False. It is strongly recommended to use default_value_native for default_value in driver specific sub-hash to avoid non-portable schema hashes
nullableif True then the column can hold NULL values; note that primary key columns cannot be nullable
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
a list of SQL strings that can be used to modify an existing column in the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
COLUMN-ERRORno native_type or qore_type keys in column option hash, column does not exist, invalid column data
Note
  • make sure and add a default_value value when modifying a column to have a "not null" constraint with existing data
  • if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractPrimaryKey SqlUtil::AbstractTable::getPrimaryKey ( )

returns an object of class AbstractPrimaryKey describing the primary key of the table

If there is no primary key then the object returned will be empty (see SqlUtil::AbstractPrimaryKey::empty())

Example:
Returns
an object of class AbstractPrimaryKey describing the primary key of the table
private *hash SqlUtil::AbstractTable::getPseudoColumnHash ( )

returns a hash of valid pseudocolumns

override in subclasses to return driver-specific pseudocolumns; by default this method returns NOTHING

private hash SqlUtil::AbstractTable::getRawUpdateOperatorMap ( )

returns the raw (default) update operator map for this object

override in subclasses to return driver-specific options

string SqlUtil::AbstractTable::getRenameColumnSql ( string  old_name,
string  new_name,
*hash  opt 
)

gets an SQL string that can be used to rename an existing column in the table

Example:
1 string sql = table.getRenameColumnSql("name", "family_name");
Parameters
old_namethe current name of the column
new_namethe new name of the column
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
an SQL string that can be used to rename an existing column in the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
COLUMN-ERRORif the old column does not exist in the table or the new column already does
See Also
getModifyColumnSql() for a method that allows the column definition to be updated
Note
if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
string SqlUtil::AbstractTable::getRenameSql ( string  new_name,
*hash  opt 
)

returns an SQL string that could be used to rename the table in the database

Example:
1 string sql = table.getRenameSql("new_name");
Parameters
new_namethe new name for the table
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
an SQL string that could be used to rename the table in the database
Exceptions
OPTION-ERRORinvalid or unsupported option passed
Note
If the sql_callback_executed option key is True, this method also renames the object internally (see SQL CallBack Executed Flag for more information), additionally if the "db_table_cache" option key is assigned to a Tables argument, then the table cache is also updated with the name change in this case
See Also
  • rename()
  • inDb() for a method that tells if the table is already in the database or not
Qore::SQL::SQLStatement SqlUtil::AbstractTable::getRowIterator ( *hash  sh,
*reference  sql,
*hash  opt 
)

returns an SQLStatement object that will iterate the results of a select statement matching the arguments

Example:
1 SQLStatement i = table.getRowIterator(sh);
Parameters
sha hash of conditions for the select statement; see select option hash for information about this argument
sqlan optional reference to a string to return the SQL generated for the select statement
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
an SQLStatement object that will iterate the results of a select statement matching the arguments
Exceptions
OPTION-ERRORinvalid or unsupported select option
SELECT-ERROR'offset' supplied without 'orderby' or 'limit', 'orderby' with 'limit' and 'offset' does not match any unique constraint
Note
  • if "offset" is supplied and no "orderby" is supplied, then if any primary key exists, the primary key columns will be used for the "orderby" option automatically
  • the SQLStatement object created by a successful call to this method acquires a thread resource for the underlying AbstractDatasource object that must be released by calling commit() or rollback(), even if the statement does not acquire any database locks
Qore::SQL::SQLStatement SqlUtil::AbstractTable::getRowIterator ( *hash  sh,
*hash  opt 
)

returns an SQLStatement object that will iterate the results of a select statement matching the arguments

Example:
1 SQLStatement i = table.getRowIterator();
Parameters
sha hash of conditions for the select statement; see select option hash for information about this argument
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
an SQLStatement object that will iterate the results of a select statement matching the arguments
Exceptions
OPTION-ERRORinvalid or unsupported select option
SELECT-ERROR'offset' supplied without 'orderby' or 'limit', 'orderby' with 'limit' and 'offset' does not match any unique constraint
Note
  • if "offset" is supplied and no "orderby" is supplied, then if any primary key exists, the primary key columns will be used for the "orderby" option automatically
  • the SQLStatement object created by a successful call to this method acquires a thread resource for the underlying AbstractDatasource object that must be released by calling commit() or rollback(), even if the statement does not acquire any database locks
private hash SqlUtil::AbstractTable::getSelectOptions ( )

returns the select options for this driver

override in subclasses to return driver-specific options

string SqlUtil::AbstractTable::getSelectSql ( *hash  sh,
*reference  args 
)

returns the SQL string to be executed corresponding to the argument hash with an output parameter for the select bind arguments

Example:
1 list args;
2 string sql = table.getSelectSql(sh, \args);
Parameters
sha hash of conditions for the select statement; see select option hash for information about this argument
argsan optional reference to a list for any bind arguments
Returns
the SQL that can be used to execute a select on the database corresponding to the arguments; the select bind arguments are returned in an output parameter
Exceptions
OPTION-ERRORinvalid or unsupported select option
SELECT-ERROR'offset' supplied without 'orderby' or 'limit', 'orderby' with 'limit' and 'offset' does not match any unique constraint
Note
  • the select string is specific to the arguments passed (for example NULL arguments will have clauses like 'is null')
  • if "offset" is supplied and no "orderby" is supplied, then if any primary key exists, the primary key columns will be used for the "orderby" option automatically
private hash SqlUtil::AbstractTable::getSqlDataCallbackOptions ( )

returns the sql data operation callback options for this driver

override in subclasses to return driver-specific options

string SqlUtil::AbstractTable::getSqlFromList ( list  l)

returns an SQL string corresponding to the list of commands in the argument

Example:
1 string sql = t.getSqlFromList(list);
Parameters
la list of SQL commands
Returns
an SQL string corresponding to the list of commands in the argument
string SqlUtil::AbstractTable::getSqlValue ( any  v)

returns a string for use in SQL queries representing the DB-specific value of the argument

Example:
1 string str = table.getSqlValue(date);
Parameters
vthe value to convert to an SQL value
Returns
a string representing the value usable in SQL strings for the given database driver
Exceptions
VALUE-ERRORthe given value cannot be converted to an SQL string (missing rules for value)
private hash SqlUtil::AbstractTable::getTableColumnDescOptions ( )

returns the table column description options for this driver

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getTableCreationOptions ( )

returns the table creation options for this driver

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getTableDescriptionHashOptions ( )

returns the table description hash options for this driver

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getTableOptions ( )

returns the table options for this driver

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getTriggerOptions ( )

returns the trigger options for this driver

override in subclasses to return driver-specific options

Triggers SqlUtil::AbstractTable::getTriggers ( )

returns an object of class Triggers describing the triggers on the table

If there are no triggers on the table then the object returned will be empty (see SqlUtil::Triggers::empty())

Example:
1 Triggers trig = table.getTriggers();
Returns
an object of class Triggers describing the triggers on the table
string SqlUtil::AbstractTable::getTruncateSql ( *hash  opt)

gets the SQL that can be used to truncate the table

Example:
1 string sql = table.getTruncateSql();
Parameters
opta hash of options for the SQL string; see SqlUtil::AbstractTable::AlignTableOptions for common options; each driver can support additional driver-specific options
Returns
the SQL that can be used to truncate the table
Exceptions
OPTION-ERRORinvalid or unsupported option passed
See Also
inDb() for a method that tells if the table is already in the database or not
Note
if the sql_callback_executed option is True in opt, then the changes are also effected in the current object, if not, then they are not (see SQL CallBack Executed Flag for more information)
Qore::AbstractIterator SqlUtil::AbstractTable::getUniqueConstraintIterator ( )

returns an iterator for all unique constraints on the table (including the primary key if any)

Example:
1 map printf("unique constraint %s\n", $1.getName()), table.getUniqueConstraintIterator();
Returns
an iterator for all unique constraints on the table (including the primary key if any)
private hash SqlUtil::AbstractTable::getUpdateOperatorMap ( )

returns the update operator map for this object

override in subclasses to return driver-specific options

code SqlUtil::AbstractTable::getUpsertClosure ( hash  row,
int  upsert_strategy = UpsertAuto,
*hash  opt 
)

returns a closure that can be executed given a hash argument representing a single row that will be updated or inserted in the database with the given upsert strategy; the table must have a unique key to do this; the closure returned does not check the input hash for validity

Example:
1 Datasource ds("pgsql:user/pass@db%localhost");
2 Table table(ds, "table_name");
3 code upsert = table.getUpsertClosure(row, AbstractTable::UpsertSelectFirst);
4 on_success ds.commit();
5 on_error ds.rollback();
6 map upsert($1), row_list;
Parameters
rowa hash representing an example row to insert or update; every row passed to the upsert closure returned must have the same keys in the same order
upsert_strategysee Upsert Strategy Codes for possible values for the upsert strategy
opta hash of options for the upsert operation; see SqlUtil::AbstractTable::UpsertOptions for common options; each driver can support additional driver-specific options
Returns
a closure that can be executed given a hash argument representing a single row that will be updated or inserted in the database with the given upsert strategy; the closure returned does not check the input hash for validity; the closure has the following signature:
1 int sub upsert(hash row) {}
The return value of the closure is an integer code giving the result of the update; see Upsert Result Codes for more information
Exceptions
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
UPSERT-ERRORno primary key, unique constraint, or unique index for upsert; not all columns of the unique constraint/index are used in the upsert statement
Note
the row values passed to the closure for upserting are not checked if they match the example row passed to the getUpsertClosure() method; passing non-conforming data will cause errors; see SqlUtil::AbstractTable::getUpsertClosureWithValidation() for a similar method that returns a validating closure; the closure returned by this method is faster than the one returned by SqlUtil::AbstractTable::getUpsertClosure() since there is no validation
code SqlUtil::AbstractTable::getUpsertClosureWithValidation ( hash  example_row,
int  upsert_strategy = UpsertAuto,
*hash  opt 
)

returns a closure that can be executed given a hash argument representing a single row that will be updated or inserted in the database with the given upsert strategy; the table must have a unique key to do this; the closure returned checks the input hash for validity

Example:
1 Datasource ds("pgsql:user/pass@db%localhost");
2 Table table(ds, "table_name");
3 code upsert = table.getUpsertClosureWithValidation(row, AbstractTable::UpsertSelectFirst);
4 on_success ds.commit();
5 on_error ds.rollback();
6 map upsert($1), row_list;
Parameters
example_rowa hash representing an example row to insert or update; every row passed to the upsert closure returned must have the same keys in the same order or the closure returned will throw an UPSERT-ERROR exception
upsert_strategysee Upsert Strategy Codes for possible values for the upsert strategy
opta hash of options for the upsert operation; see SqlUtil::AbstractTable::UpsertOptions for common options; each driver can support additional driver-specific options
Returns
a closure that can be executed given a hash argument representing a single row that will be updated or inserted in the database with the given upsert strategy; the closure has the following signature:
1 int sub upsert(hash row) {}
The return value of the closure is an integer code giving the result of the update; see Upsert Result Codes for more information
Exceptions
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
UPSERT-ERRORno primary key, unique constraint, or unique index for upsert; not all columns of the unique constraint/index are used in the upsert statement
Note
the row values passed to the closure for upserting are checked if they match the example row passed to the getUpsertClosure() method; passing non-conforming data to the closure will cause the closure to throw an UPSERT-ERROR exception; see SqlUtil::AbstractTable::getUpsertClosure() for a similar method that returns a non-validating closure; the closure returned by this method is a little slower than the one returned by SqlUtil::AbstractTable::getUpsertClosure() since each row is validated
private hash SqlUtil::AbstractTable::getUpsertOptions ( )

returns the upsert options for this driver

override in subclasses to return driver-specific options

private hash SqlUtil::AbstractTable::getWhereOperatorMap ( )

returns the "where" operator map for this object

override in subclasses to return driver-specific options

bool SqlUtil::AbstractTable::hasReturning ( )

returns True if the current database driver supports the "returning" clause in insert statements, False if not

Returns
True if the current database driver supports the "returning" clause in insert statements, False if not
Since
SqlUtil 1.3
bool SqlUtil::AbstractTable::inDb ( )

returns True if the table has been read from or created in the database, False if not

Example:
1 bool b = table.inDb();
Returns
True if the table has been read from or created in the database, False if not
Note
this method only returns a flag if the object contains configuration already retrieved from the database,
See Also
AbstractTable::checkExistence() for a method that will check the database if the table exists in case the table is not already known to exist in the database
*hash SqlUtil::AbstractTable::insert ( hash  row)

inserts a row into the table without any transaction management; a transaction will be in progress after this method is successfully executed

Example:
1 table.insert(row);
Parameters
rowa hash representing the row to insert; hash values can also be set with SQL Insert Operator Functions to insert values based on SQL operations to be used directly in the insert statement
sqlan optional reference to a string to return the SQL generated for the insert statement
optoptional insert options; see AbstractTable::InsertOptions for more info
Returns
in case the "returning" insert option is used, a hash of return values is returned, otherwise NOTHING is returned
Exceptions
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
*hash SqlUtil::AbstractTable::insertCommit ( hash  row)

inserts a row into the table; the transaction is committed if successful, if an error occurs, it is rolled back

Example:
1 table.insertCommit(row);
Parameters
rowa hash representing the row to insert; hash values can also be set with SQL Insert Operator Functions to insert values based on SQL operations to be used directly in the insert statement
sqlan optional reference to a string to return the SQL generated for the insert statement
optoptional insert options; see AbstractTable::InsertOptions for more info
Returns
in case the "returning" insert option is used, a hash of return values is returned, otherwise NOTHING is returned
Exceptions
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
int SqlUtil::AbstractTable::insertFromIterator ( Qore::AbstractIterator  i,
*hash  opt 
)

this method inserts data from the given iterator argument (whose getValue() method must return a hash giving row values) into the current table; no transaction management is performed with this method

Example:
1 int rows = table.insertFromIterator(i);
Parameters
ithe Qore::AbstractIterator argument that will provide the data to insert into the current table; the getValue() method of this object must return a hash giving row values (for example, the Qore::SQL::SQLStatement class is well-suited to be used here); note that the iterator is assumed to return the same columns in the same order in every element
opta hash of options for the insert operation; see SqlUtil::AbstractTable::InsertFromIteratorOptions for common options; each driver can support additional driver-specific options; note that this method ignores any "commit_block" option
Returns
the number of rows inserted
Exceptions
OPTION-ERRORinvalid or unsupported option
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
See Also
int SqlUtil::AbstractTable::insertFromIteratorCommit ( Qore::AbstractIterator  i,
*hash  opt 
)

this method inserts data from the given iterator argument (whose getValue() method must return a hash giving row values) into the current table; the transaction is committed if successful, if an error occurs then it is rolled back

Example:
1 int rows = table.insertFromIteratorCommit(i);
Parameters
ithe Qore::AbstractIterator argument that will provide the data to insert into the current table; the getValue() method of this object must return a hash giving row values (for example, the Qore::SQL::SQLStatement class is well-suited to be used here); note that the iterator is assumed to return the same columns in every element
opta hash of options for the insert operation; see SqlUtil::AbstractTable::InsertFromIteratorOptions for common options; each driver can support additional driver-specific options
Returns
the number of rows inserted
Exceptions
OPTION-ERRORinvalid or unsupported option
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
See Also
int SqlUtil::AbstractTable::insertFromSelect ( list  cols,
AbstractTable  source,
hash  sh,
reference  sql,
hash  opt 
)

inserts rows into a table based on a select statement from another table (which must be using the same datasource as the current table); a transaction will be in progress after this method is successfully executed

Example:
1 int rows = table.insertFromSelect(("id", "name", "created"), source_table, (("columns": ("id", "name", "created"), "where": ("type": "CUSTOMER"))));
Parameters
colsthe list of column names to use to insert in the current table
sourcethe source table for the select statement
sha hash of conditions for the select statement; see select option hash for information about this argument
sqlan optional reference to a string to return the SQL generated for the select statement
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more inf
Returns
the number of rows inserted
Exceptions
OPTION-ERRORinvalid or unsupported option
COLUMN-ERRORunknown or invalid column in insert list
SELECT-ERROR'offset' supplied without 'orderby' or 'limit', 'orderby' with 'limit' and 'offset' does not match any unique constraint
Note
this method does not take insert options because it is executed entirely in the database server; use insertFromIterator() or insertFromIteratorCommit() to insert arbitrary data with insert options
int SqlUtil::AbstractTable::insertFromSelectCommit ( list  cols,
AbstractTable  source,
hash  sh,
reference  sql,
hash  opt 
)

inserts rows into a table based on a select statement from another table (which must be using the same datasource as the current table); the transaction is committed if successful, if an error occurs, it is rolled back

Example:
1 int rows = table.insertFromSelectCommit(("id", "name", "created"), source_table, (("columns": ("id", "name", "created"), "where": ("type": "CUSTOMER"))));
Parameters
colsthe list of column names to use to insert in the current table
sourcethe source table for the select statement
sha hash of conditions for the select statement; see select option hash for information about this argument
sqlan optional reference to a string to return the SQL generated for the select statement
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more inf
Returns
the number of rows inserted
Exceptions
OPTION-ERRORinvalid or unsupported option
COLUMN-ERRORunknown or invalid column in insert list
SELECT-ERROR'offset' supplied without 'orderby' or 'limit', 'orderby' with 'limit' and 'offset' does not match any unique constraint
Note
this method does not take insert options because it is executed entirely in the database server; use insertFromIterator() or insertFromIteratorCommit() to insert arbitrary data with insert options
AbstractColumn SqlUtil::AbstractTable::modifyColumn ( string  cname,
hash  opt,
bool  nullable = True,
*reference  lsql 
)

modifies an existing column in the table; if the table is already known to be in the database, then the changes are effected in the database also immediately; otherwise it is only updated internally and the new column definition will be created when create() is called for example

Example:
1 table.modifyColumn("name", ("qore_type": Type::String, "size": 240), False);

In case the table is already in the database, this method commits the transaction on success and rolls back the transaction if there's an error.

Parameters
cnamethe name of the column
opta hash describing the column; the following keys are permitted (other column options may be supported depending on the underlying AbstractTable implementation):
  • qore_type: a qore type string that will be converted to a native DB type with some default conversion;
  • native_type: the native database column type; if both native_type and qore_type are given then native_type is used
  • size: for data types requiring a size component, the size; for numeric columns this represents the precision for example
  • scale: for numeric data types, this value gives the scale
  • default_value: the default value for the column
  • default_value_native: a boolean flag to say if a default_value should be validated against table column type (False) or used as it is (True) to allow to use DBMS native functions or features. Defaults to False. It is strongly recommended to use default_value_native for default_value in driver specific sub-hash to avoid non-portable schema hashes
lsqlan optional reference to a list of strings to retrieve the SQL used to modify the table (only executed if the table is already in the database)
nullableif True then the column can hold NULL values; note that primary key columns cannot be nullable
Exceptions
COLUMN-ERRORno native_type or qore_type keys in column option hash, column does not exist, invalid column data
Note
make sure and add a default_value value when modifying a column to have a "not null" constraint with existing data
See Also
inDb() for a method that tells if the table is already in the database or not
AbstractForeignConstraint SqlUtil::AbstractTable::removeForeignConstraint ( string  cname)

removes the named foreign constraint from the table; no SQL is executed in any case, only the named foreign constraint is removed from the table definition

Example:
1 table.removeForeignConstraint("uk_mytable_name");
Parameters
cnamethe name of the foreign constraint to remove
Returns
the foreign constraint removed from the table
Exceptions
FOREIGN-CONSTRAINT-ERRORthe given constraint does not exist
Note
this method retrieves all current foreign constraint definitions from the database if none have already been defined
See Also
inDb() for a method that tells if the table is already in the database or not
SqlUtil::AbstractTable::rename ( string  new_name,
*reference  sql,
*Tables  table_cache 
)

renames the table; if the table is already known to be in the database in the database, then the changes are effected in the database also immediately; otherwise it is only updated internally

Example:
1 table.rename("new_name");
Parameters
new_namethe new name for the table
sqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
table_cachean optional Tables argument to update the table name in any table cache
See Also
getRenameSql()
AbstractColumn SqlUtil::AbstractTable::renameColumn ( string  old_name,
string  new_name,
reference  sql 
)

renames an existing column; if the table is already known to be in the database, then the changes are effected in the database also immediately; otherwise it is only updated internally

Example:
1 AbstractColumn col = table.renameColumn("name", "family_name");
Parameters
old_namethe current name of the column
new_namethe new name of the column
sqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
the column object that was updated
Exceptions
COLUMN-ERRORif the given column does not exist in the table
See Also
modifyColumn() for a method that allows the column definition to be updated
Note
if any primary key or foreign table constraints refer to the column, the internal representations are also renamed, however check constraints are not updated and will be invalid if they refer to the renamed column
AbstractConstraint SqlUtil::AbstractTable::renameConstraint ( string  old_name,
string  new_name,
reference  lsql 
)

renames an existing constraint; this can be any constraint on the table, a primary key, a foreign key constraint, or a generic constraint; if the table is already known to be in the database, then the changes are effected in the database also immediately; otherwise it is only updated internally

Example:
1 AbstractConstraint con = table.renameConstraint("pk_table_name", "pkey_table_name");
Parameters
old_namethe current name of the constraint
new_namethe new name for the constraint
lsqlan optional reference to a list of strings to retrieve the SQL used to modify the constraint (only executed if the table is already in the database)
Returns
the constraint object that was updated
Exceptions
CONSTRAINT-ERRORif the old constraint does not exist in the table or if the new constraint name already exists
AbstractIndex SqlUtil::AbstractTable::renameIndex ( string  old_name,
string  new_name,
reference  sql 
)

renames an existing index; if the table is already known to be in the database, then the changes are effected in the database also immediately; otherwise it is only updated internally

Example:
1 AbstractIndex ix = table.renameIndex("uk_table_name", "unique_table_name");
Parameters
old_namethe current name of the index
new_namethe new name for the index
sqlan optional reference to a string to retrieve the SQL used to modify the table (only executed if the table is already in the database)
Returns
the index object that was updated
Exceptions
INDEX-ERRORif the old index does not exist in the table or if the new index name already exists
softint SqlUtil::AbstractTable::rowCount ( )

returns the number of rows in the table

Example:
1 int cnt = table.rowCount();
Returns
the number of rows in the table
Note
to see if the table is empty or not, use emptyData() as this is much faster than rowCount()
See Also
emptyData()
*hash SqlUtil::AbstractTable::select ( *hash  sh,
*reference  sql,
*hash  opt 
)

returns a hash of lists representing the columns and rows in the table that match the argument hahs

Example:
1 *hash h = table.select(sh);
Parameters
sha hash of conditions for the select statement; see select option hash for information about this argument
sqlan optional reference to a string to return the SQL generated for the select statement
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
a hash of lists representing the columns and rows in the table that match the argument hash
Exceptions
OPTION-ERRORinvalid or unsupported select option
SELECT-ERROR'offset' supplied without 'orderby' or 'limit', 'orderby' with 'limit' and 'offset' does not match any unique constraint
Note
  • if "offset" is supplied and no "orderby" is supplied, then if any primary key exists, the primary key columns will be used for the "orderby" option automatically
  • if the forupdate select option is used, then after a successful select operation, the calling thread will own the thread transaction lock
*hash SqlUtil::AbstractTable::select ( *hash  sh,
*hash  opt 
)

returns a hash of lists representing the columns and rows in the table that match the argument hahs

Example:
1 *hash h = table.select(sh);
Parameters
sha hash of conditions for the select statement; see select option hash for information about this argument
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
a hash of lists representing the columns and rows in the table that match the argument hash
Exceptions
OPTION-ERRORinvalid or unsupported select option
SELECT-ERROR'offset' supplied without 'orderby' or 'limit', 'orderby' with 'limit' and 'offset' does not match any unique constraint
Note
  • if "offset" is supplied and no "orderby" is supplied, then if any primary key exists, the primary key columns will be used for the "orderby" option automatically
  • if the forupdate select option is used, then after a successful select operation, the calling thread will own the thread transaction lock
*hash SqlUtil::AbstractTable::selectRow ( *hash  sh,
*reference  sql,
*hash  opt 
)

returns a hash representing the row in the table that matches the argument hash; if more than one row would be returned an exception is raised

Example:
1 *hash h = table.selectRow(sh);
Parameters
sha hash of conditions for the select statement; see select option hash for information about this argument
sqlan optional reference to a string to return the SQL generated for the select statement
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
a hash representing the row in the table that matches the argument hash; if more than one row would be returned an exception is raised
Exceptions
OPTION-ERRORinvalid or unsupported select option
SELECT-ERROR'offset' supplied without 'orderby' or 'limit', 'orderby' with 'limit' and 'offset' does not match any unique constraint
DBI-SELECT-ROW-ERRORmore than 1 row retrieved from the server
Note
  • if "offset" is supplied and no "orderby" is supplied, then if any primary key exists, the primary key columns will be used for the "orderby" option automatically
  • if the forupdate select option is used, then after a successful select operation, the calling thread will own the thread transaction lock
*hash SqlUtil::AbstractTable::selectRow ( *hash  sh,
*hash  opt 
)

returns a hash representing the row in the table that matches the argument hash; if more than one row would be returned an exception is raised

Example:
1 *hash h = table.selectRow(sh);
Parameters
sha hash of conditions for the select statement; see select option hash for information about this argument
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
a hash representing the row in the table that matches the argument hash; if more than one row would be returned an exception is raised
Exceptions
OPTION-ERRORinvalid or unsupported select option
SELECT-ERROR'offset' supplied without 'orderby' or 'limit', 'orderby' with 'limit' and 'offset' does not match any unique constraint
DBI-SELECT-ROW-ERRORmore than 1 row retrieved from the server
Note
  • if "offset" is supplied and no "orderby" is supplied, then if any primary key exists, the primary key columns will be used for the "orderby" option automatically
  • if the forupdate select option is used, then after a successful select operation, the calling thread will own the thread transaction lock
*list SqlUtil::AbstractTable::selectRows ( *hash  sh,
*reference  sql,
*hash  opt 
)

returns a list of hashes representing the rows in the table that match the argument hash

Example:
1 *list l = table.selectRows(sh);
Parameters
sha hash of conditions for the select statement; see select option hash for information about this argument
sqlan optional reference to a string to return the SQL generated for the select statement
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
a list of hashes representing the rows in the table that match the argument hash
Exceptions
OPTION-ERRORinvalid or unsupported select option
SELECT-ERROR'offset' supplied without 'orderby' or 'limit', 'orderby' with 'limit' and 'offset' does not match any unique constraint
Note
  • if "offset" is supplied and no "orderby" is supplied, then if any primary key exists, the primary key columns will be used for the "orderby" option automatically
  • if the forupdate select option is used, then after a successful select operation, the calling thread will own the thread transaction lock
*list SqlUtil::AbstractTable::selectRows ( *hash  sh,
*hash  opt 
)

returns a list of hashes representing the rows in the table that match the argument hash

Example:
1 *list l = table.selectRows(sh);
Parameters
sha hash of conditions for the select statement; see select option hash for information about this argument
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
a list of hashes representing the rows in the table that match the argument hash
Exceptions
OPTION-ERRORinvalid or unsupported select option
SELECT-ERROR'offset' supplied without 'orderby' or 'limit', 'orderby' with 'limit' and 'offset' does not match any unique constraint
Note
  • if "offset" is supplied and no "orderby" is supplied, then if any primary key exists, the primary key columns will be used for the "orderby" option automatically
  • if the forupdate select option is used, then after a successful select operation, the calling thread will own the thread transaction lock
SqlUtil::AbstractTable::setDatasource ( AbstractDatasource  nds)

changes the datasource for the table; if the inDb flag is True, then it is set to False by calling this method

Example:
1 Table table(ds1, "table_name");
2 table.setDatasource(ds2);
3 table.create();
Parameters
ndsthe new datasource for the table
Note
it's generally not safe to call this method while SQL operations are in progress in other threads on the same table
SqlUtil::AbstractTable::setupTable ( hash  desc,
*hash  opt 
)

creates the object from a table description hash

Parameters
desca table description hash describing the table
optan optional hash of options for the table creation string; see SqlUtil::AbstractTable::TableOptions for common options; each driver can support additional driver-specific options
Exceptions
OPTION-ERRORinvalid or unsupported option passed
DESCRIPTION-ERRORinvalid or unsupported description hash value passed
SqlUtil::AbstractTable::truncate ( )

truncates all the table data without any transaction management

Example:
1 table.truncate();
Note
Transaction management may not be applied when truncating tables depending on the database driver (for example truncating tables in Oracle does not participate in transaction management), however this method uses the Qore::SQL::AbstractDatasource::exec() method, which normally participates in acquiring a transaction lock for the underlying datasource object; therefore after this method executes normally the transaction lock will be dedicated to the calling thread.
SqlUtil::AbstractTable::truncateCommit ( )

truncates all the table data; releases the transaction lock after executing

Example:
1 table.truncateCommit();
Note
The transaction is committed if successful or rolled back if an exception occurs; use truncate() to execute without any transaction management
any SqlUtil::AbstractTable::tryExec ( string  sql)

executes some SQL with optional arguments so that if an error occurs the current transaction state is not lost

Example:
1 t.tryExec("drop table tmp_table");

Include any arguments in the parameter list after the sql argument

Parameters
sqlthe SQL to execute
Returns
any return value from the SQL command executed
any SqlUtil::AbstractTable::tryExecArgs ( string  sql,
*softlist  args 
)

executes some SQL with optional arguments so that if an error occurs the current transaction state is not lost

Example:
1 t.tryExec("delete from tmp_table where id = %v and name = %v", arglist);
Parameters
sqlthe SQL to execute
argsthe bind / placeholder or other arguments corresponding to the SQL string
Returns
any return value from the SQL command executed
any SqlUtil::AbstractTable::tryExecRaw ( string  sql)

executes some SQL so that if an error occurs the current transaction state is not lost

Example:
1 t.tryExecRaw("drop table tmp_table");

Include any arguments in the parameter list after the sql argument

Parameters
sqlthe SQL to execute
Returns
any return value from the SQL command executed
int SqlUtil::AbstractTable::update ( hash  set,
hash  cond,
reference  sql,
hash  opt 
)

updates rows in the table matching an optional condition and returns the count of rows updated; no transaction management is performed with this method

Example:
1 int ucnt = table.update(("id": id), ("name": name));
Parameters
setthe hash of values to set, key values are column names, hash values are the values to assign to those columns or update operators (see SQL Update Operator Functions)
conda hash of conditions for the where clause; see Where Clauses for more information
sqlan optional reference to a string to return the SQL generated for the select statement
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
the count of rows updated
Exceptions
UPDATE-ERRORthe set hash is empty
WHERE-ERRORunknown operator or invalid arguments given in the cond hash for the where clause
See Also
updateCommit()
int SqlUtil::AbstractTable::updateCommit ( hash  set,
hash  cond,
reference  sql,
hash  opt 
)

updates rows in the table matching an optional condition and returns the count of rows updated; the transaction is committed if successful, if an error occurs then it is rolled back

Example:
1 int ucnt = table.updateCommit(("id": id), ("name": name));
Parameters
setthe hash of values to set, key values are column names, hash values are the values to assign to those columns or update operators (see SQL Update Operator Functions)
conda hash of conditions for the where clause; see Where Clauses for more information
sqlan optional reference to a string to return the SQL generated for the select statement
optoptional SQL data operation callback options; see AbstractTable::SqlDataCallbackOptions for more info
Returns
the count of rows updated
Exceptions
UPDATE-ERRORthe set hash is empty
WHERE-ERRORunknown operator or invalid arguments given in the cond hash for the where clause
See Also
update()
int SqlUtil::AbstractTable::upsert ( hash  row,
int  upsert_strategy = UpsertAuto,
*hash  opt 
)

update or insert the data in the table according to the hash argument; the table must have a unique key to do this

Example:
1 table.upsert(row);
Parameters
rowa hash representing the row to insert or update
upsert_strategysee Upsert Strategy Codes for possible values for the upsert strategy
opta hash of options for the upsert operation; see SqlUtil::AbstractTable::UpsertOptions for common options; each driver can support additional driver-specific options
Returns
an integer code giving the result of the update; see Upsert Result Codes for more information
Exceptions
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
UPSERT-ERRORno primary key, unique constraint, or unique index for upsert; not all columns of the unique constraint/index are used in the upsert statement
Note
if upserting multiple rows; it's better to use getBulkUpsertClosure(), getUpsertClosure(), or getUpsertClosureWithValidation() and execute the closure on each row; when using this method, the overhead for setting up the upsert is made for each row which is very inefficient
int SqlUtil::AbstractTable::upsertCommit ( hash  row,
int  upsert_strategy = UpsertAuto,
*hash  opt 
)

update or insert the data in the table according to the hash argument; the table must have a unique key to do this; the transaction is committed if successful, if an error occurs then it is rolled back

Example:
1 table.upsertCommit(row);
Parameters
rowa hash representing the row to insert or update
upsert_strategysee Upsert Strategy Codes for possible values for the upsert strategy
opta hash of options for the upsert operation; see SqlUtil::AbstractTable::UpsertOptions for common options; each driver can support additional driver-specific options
Returns
an integer code giving the result of the update; see Upsert Result Codes for more information
Exceptions
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
UPSERT-ERRORno primary key, unique constraint, or unique index for upsert; not all columns of the unique constraint/index are used in the upsert statement
Note
if upserting multiple rows; it's better to use getBulkUpsertClosure(), getUpsertClosure(), or getUpsertClosureWithValidation() and execute the closure on each row; when using this method, the overhead for setting up the upsert is made for each row which is very inefficient
*hash SqlUtil::AbstractTable::upsertFromIterator ( Qore::AbstractIterator  i,
int  upsert_strategy = AbstractTable::UpsertAuto,
*hash  opt 
)

this method upserts or merges data from the given iterator argument (whose getValue() method must return a hash giving row values) into the current table; no transaction management is performed with this method

Example:
1 hash h = table.upsertFromIterator(i, AbstractTable::UpsertUpdateFirst);
Parameters
ithe Qore::AbstractIterator argument that will provide the data to upsert or merge into the current table; the getValue() method of this object must return a hash giving row values (for example, the Qore::SQL::SQLStatement class is well-suited to be used here)
upsert_strategysee Upsert Strategy Codes for possible values for the upsert strategy
opta hash of options for the upsert operation; see SqlUtil::AbstractTable::UpsertOptions for common options; each driver can support additional driver-specific options; note that this method ignores any "commit_block" option
Returns
NOTHING if no actions were taken or a hash with the following keys assigned to numeric values indicating the number of rows processed (keys correspond to SqlUtil::AbstractTable::UpsertResultDescriptionMap keys):
Exceptions
OPTION-ERRORinvalid or unsupported option
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
UPSERT-ERRORno primary key, unique constraint, or unique index for upsert; not all columns of the unique constraint/index are used in the upsert statement
Note
if upsert option delete_others is True, then a hash of primary key values in the input data is built as the input data is iterated. After iterating, if the row count of the table and the input data matches, then nothing more is done, otherwise, every row of the table is iterated and compared to the primary key hash; if a row does not match a primary key value, then it is deleted. This operation is only executed if delete_others is True and is expensive for large data sets.
See Also
*hash SqlUtil::AbstractTable::upsertFromIteratorCommit ( Qore::AbstractIterator  i,
int  upsert_strategy = AbstractTable::UpsertAuto,
*hash  opt 
)

this method upserts or merges data from the given iterator argument (whose getValue() method must return a hash giving row values) into the current table; the transaction is committed if successful, if an error occurs then it is rolled back

Example:
1 hash h = table.upsertFromIterator(i, AbstractTable::UpsertUpdateFirst);
Parameters
ithe Qore::AbstractIterator argument that will provide the data to upsert or merge into the current table; the getValue() method of this object must return a hash giving row values (for example, the Qore::SQL::SQLStatement class is well-suited to be used here)
upsert_strategysee Upsert Strategy Codes for possible values for the upsert strategy
opta hash of options for the upsert operation; see SqlUtil::AbstractTable::UpsertOptions for common options; each driver can support additional driver-specific options
Returns
NOTHING if no actions were taken or a hash with the following keys assigned to numeric values indicating the number of rows processed (keys correspond to SqlUtil::AbstractTable::UpsertResultDescriptionMap keys):
Exceptions
OPTION-ERRORinvalid or unsupported option
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
UPSERT-ERRORno primary key, unique constraint, or unique index for upsert; not all columns of the unique constraint/index are used in the upsert statement
Note
if upsert option delete_others is True, then a hash of primary key values in the input data is built as the input data is iterated. After iterating, if the row count of the table and the input data matches, then nothing more is done, otherwise, every row of the table is iterated and compared to the primary key hash; if a row does not match a primary key value, then it is deleted. This operation is only executed if delete_others is True and is expensive for large data sets.
See Also
*hash SqlUtil::AbstractTable::upsertFromSelect ( AbstractTable  t,
*hash  sh,
int  upsert_strategy = AbstractTable::UpsertAuto,
*hash  opt 
)

this method upserts or merges data from the given foreign table and select option hash into the current table; no transaction management is performed with this method

Example:
1 on_success { table.commit(); table2.commit(); }
2 on_error { table.rollback(); table2.rollback(); }
3 hash h = table.upsertFromSelect(table2, ("where": ("account_type": "CUSTOMER")), AbstractTable::UpsertUpdateFirst);

The table argument does not need to be in the same database as the current table; it can also be in a different database server or a database server of a different type (you can use this method to upsert or merge data to or from any database supported by SqlUtil).

Parameters
tthe table for the source data; this does not need to be in the same database as the target (the current table), nor does it need to be the same database type
sha hash of conditions for the select statement; see select option hash for information about this argument
upsert_strategysee Upsert Strategy Codes for possible values for the upsert strategy
opta hash of options for the upsert operation; see SqlUtil::AbstractTable::UpsertOptions for common options; each driver can support additional driver-specific options; note that this method ignores any "commit_block" option
Returns
NOTHING if no actions were taken or a hash with the following keys assigned to numeric values indicating the number of rows processed (keys correspond to SqlUtil::AbstractTable::UpsertResultDescriptionMap keys):
Exceptions
OPTION-ERRORinvalid or unsupported option
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
UPSERT-ERRORno primary key, unique constraint, or unique index for upsert; not all columns of the unique constraint/index are used in the upsert statement
Note
  • if upsert option delete_others is True, then a hash of primary key values in the input data is built as the input data is iterated. After iterating, if the row count of the table and the input data matches, then nothing more is done, otherwise, every row of the table is iterated and compared to the primary key hash; if a row does not match a primary key value, then it is deleted. This operation is only executed if delete_others is True and is expensive for large data sets.
*hash SqlUtil::AbstractTable::upsertFromSelectCommit ( AbstractTable  t,
*hash  sh,
int  upsert_strategy = AbstractTable::UpsertAuto,
*hash  opt 
)

this method upserts or merges data from the given foreign table and select option hash into the current table; the transaction is committed if successful, if an error occurs then it is rolled back

Example:
1 hash h = table.upsertFromSelectCommit(table2, ("where": ("account_type": "CUSTOMER")), AbstractTable::UpsertUpdateFirst);

The table argument does not need to be in the same database as the current table; it can also be in a different database server or a database server of a different type (you can use this method to upsert or merge data to or from any database supported by SqlUtil).

Parameters
tthe table for the source data; this does not need to be in the same database as the target (the current table), nor does it need to be the same database type
sha hash of conditions for the select statement; see select option hash for information about this argument
upsert_strategysee Upsert Strategy Codes for possible values for the upsert strategy
opta hash of options for the upsert operation; see SqlUtil::AbstractTable::UpsertOptions for common options; each driver can support additional driver-specific options
Returns
NOTHING if no actions were taken or a hash with the following keys assigned to numeric values indicating the number of rows processed (keys correspond to SqlUtil::AbstractTable::UpsertResultDescriptionMap keys):
Exceptions
OPTION-ERRORinvalid or unsupported option
COLUMN-ERRORan unknown column was referenced in the hash to be inserted
UPSERT-ERRORno primary key, unique constraint, or unique index for upsert; not all columns of the unique constraint/index are used in the upsert statement
Note
  • if upsert option delete_others is True, then a hash of primary key values in the input data is built as the input data is iterated. After iterating, if the row count of the table and the input data matches, then nothing more is done, otherwise, every row of the table is iterated and compared to the primary key hash; if a row does not match a primary key value, then it is deleted. This operation is only executed if delete_others is True and is expensive for large data sets.
  • this method also calls commit() or rollback() on the source table to release the transaction lock on the underlying source table datasource as an SQLStatement object is used to pipeline the data to the upsert code; use upsertFromSelect() to do manual transaction management instead
  • unlike insertFromSelect() and insertFromSelectCommit(), this method processes arbitrary input data and accepts upsert options
See Also

Member Data Documentation

const SqlUtil::AbstractTable::AdditionalColumnDescOptions
Initial value:
= (
"notnull": Type::Boolean,
)

additional column description keys valid when describing columns in a table description hash

the following keys are valid in a table description hash in addition to any AbstractTable::ColumnDescOptions:

  • notnull: (bool) if True then the column will have a not null constraint
const SqlUtil::AbstractTable::AlignTableOptions
Initial value:
"column_map": Type::Hash,
"index_map": Type::Hash,
"constraint_map": Type::Hash,
"trigger_map": Type::Hash,
"db_table_cache": "Tables",
"force": Type::Boolean,
)

table alignment options

currently this option is a combination of SqlUtil::AbstractTable::TableCreationOptions and the following options:

  • column_map: (hash) a hash for automatically renaming columns; if the source name (key) exists and the target name (value) does not exist, then the source column is automatically renamed
  • index_map: (hash) a hash for automatically renaming indexes; if the source name (key) exists and the target name (value) does not exist, then the source index is automatically renamed
  • constraint_map: (hash) a hash for automatically renaming constraints; if the source name (key) exists and the target name (value) does not exist, then the source constraint is automatically renamed
  • trigger_map: (hash) a hash for automatically renaming triggers; if the source name (key) exists and the target name (value) does not exist, then the source trigger is automatically renamed
  • db_table_cache: (Tables) an optional table cache for maintaining tables in the database and foreign key relationships between tables
  • force: (bool) if True and supported by the driver and object, any objects dropped will be dropped with FORCE or CASCADE options
const SqlUtil::AbstractTable::ColumnDescOptions
Initial value:
= (
"qore_type": Type::String,
"native_type": Type::String,
"size": Type::Int,
"scale": Type::Int,
"default_value": Type::NothingType,
"default_value_native" : Type::Boolean,
"comment": Type::String,
)

Column description options.

this option is made up of the following keys:

  • qore_type: (string) a qore type string that will be converted to a native DB type with some default conversion
  • native_type: (string) the native database column type; if both native_type and qore_type are given then native_type is used
  • size: (int) for data types requiring a size component, the size; for numeric columns this represents the precision for example
  • scale: (int) for numeric data types, this value gives the scale
  • default_value: the default value for the column
  • default_value_native: a boolean flag to say if a default_value should be validated against table column type (False) or used as it is (True) to allow to use DBMS native functions or features. Defaults to False. It is strongly recommended to use default_value_native for default_value in driver specific sub-hash to avoid non-portable schema hashes
  • comment: (string) an optional comment for the column
  • notnull: if the column should have a "not null" constraint on it; if missing the default value is False
  • driver: this key can optionally contain a hash keyed by driver name which contains a hash of values that will be added to the column description hash before processing; this way a column description hash can contain all the information required for the column including driver-specific options; any driver-specific options will overwrite values in the top level of the hash if there are duplicate hash keys, see below for an example
    See Also
    Column Description Hash
const SqlUtil::AbstractTable::ConstraintOptions = IndexOptions

default constraint options

currently this option is identical to SqlUtil::AbstractTable::IndexOptions

const SqlUtil::AbstractTable::ForeignConstraintOptions
Initial value:
"table_cache": "Tables",
)

default foreign constraint options

The following keys can be set for this option:

  • table_cache: (Tables) an optional table cache for maintaining cached tables and foreign key relationships between tables
const SqlUtil::AbstractTable::IndexOptions
Initial value:
= (
"index_tablespace": Type::String,
"replace": Type::Boolean,
)

default index options

  • index_tablespace: (string) a string giving the index tablespace to use for indexes
  • replace: (bool) if True and supported by the underlying db driver "create or replace" text is used when creating objects
const SqlUtil::AbstractTable::InsertFromIteratorOptions
Initial value:
"info_callback": "code",
"commit_block": Type::Int,
)

default insert option keys

In addition to any SqlDataCallbackOptions, the following keys can be set for this option:

  • info_callback: see Insert Info Callback
  • commit_block: the number of changes made before an automatic commit is made for insert methods that perform commits
const SqlUtil::AbstractTable::InsertOptions
Initial value:
"returning": "stringhashlist",
)

generic SQL insert options

In addition to any SqlDataCallbackOptions, the following keys can be set for this option:

  • returning: a list having elements of one of the two following types:
    • string: column names to return the value inserted
    • hash: a hash having the following keys:
      • "key": (required) the column name to return
      • "type": (optional) the data type for the output placeholder buffer (ex: Type::Number)
Note
using "returning" with a database that does not support this clause will cause an exception to be thrown; see SqlUtil::AbstractTable::hasReturning()
const SqlUtil::AbstractTable::SelectOptions
Initial value:
= (
"alias": Type::String,
"comment": Type::String,
"hint": Type::String,
"columns": Type::NothingType,
"where": "hash/list",
"orderby": "softstringinthashlist",
"desc": Type::Boolean,
"limit": Type::Int,
"offset": Type::Int,
"join": Type::Hash,
"groupby": "softstringinthashlist",
"having": Type::Hash,
"superquery": Type::Hash,
"forupdate": Type::Boolean,
)

default select options

the possible keys for select options are as follows (all keys are optional):

  • alias: provides a table alias for the main table
  • columns: describes the output columns and any output column operations
  • where: describes how any "where" clause will be built
  • orderby: describes the ordering of the results
  • desc: specifies descending order for results
  • limit: specifies the maximum number of results to be returned
  • offset: specifies the starting offset of the first record to be returned (starting with 0)
  • join: specifies any SQL join operations to return results from multiple tables
  • groupby: specifies grouping for aggregate column functions
  • having: specifies filtering for results with aggregate column functions
  • superquery: specifies that the rest of the argument belong to a subquery and the hash arguments under this key will select from the subquery
  • forupdate: allows for the rows selected to be locked for updating
const SqlUtil::AbstractTable::SqlDataCallbackOptions
Initial value:
= (
"sqlarg_callback": "code",
"tablecode": "code",
)

generic SQL data operation callbacks

The following keys can be set for this option:

const SqlUtil::AbstractTable::TableCreationOptions
Initial value:
"omit": "softstringlist",
)

table creation options

currently this option is a combination of SqlUtil::AbstractTable::IndexOptions and AbstractDatabase::CreationOptions plus the following:

  • omit: a list pf attributes to omit; possible values are: indexes, foreign_constraints, triggers (see TableOmissionOptions)
const SqlUtil::AbstractTable::TableDescriptionHashOptions
Initial value:
= (
"columns": Type::Hash,
"primary_key": Type::Hash,
"indexes": Type::Hash,
"triggers": Type::Hash,
"foreign_constraints": Type::Hash,
"unique_constraints": Type::Hash,
"table_cache": "Tables",
)

Table description options.

this option is made up of the following keys:

  • columns: (column description hash) a hash describing the column
  • primary_key : (primary key description hash) a hash describing the primary key for the table
  • indexes: (index description hashes) a hash describing the indexes on the table
  • triggers: a hash of trigger information keyed by trigger name; the values are the trigger source code; since triggers are driver-dependent, a driver-independent table description would include trigger hashes under the drivers key and the driver key name under that
  • foreign_constraints: (foreign constraint hashes) a hash describing the foreign constraints on the table
  • unique_constraints: (unique constraint hashes) a hash describing the unique constraints on the table
  • table_cache: (Tables) an optional table cache for maintaining cached tables and foreign key relationships between tables
See Also
Table Description Hash
const SqlUtil::AbstractTable::TableOptions
Initial value:
= (
"native_case": Type::Boolean,
"table_cache": "Tables",
)

table options

The following keys can be set for this option:

  • native_case: (bool) if True then objects will be returned in the case the database server returns them in even if the database server uses case-insensitive names; normally in this case SqlUtil will convert the names to lower-case
  • table_cache: (Tables) an optional table cache for maintaining cached tables and foreign key relationships between tables
const SqlUtil::AbstractTable::TriggerOptions = AbstractDatabase::CreationOptions

default trigger options

currently this option is identical to AbstractDatabase::CreationOptions

const SqlUtil::AbstractTable::UpsertOptions
Initial value:
= (
"info_callback": "code",
"commit_block": Type::Int,
"delete_others": Type::Boolean,
"omit_update": "softstringlist",
)

default upsert option keys

The following keys can be set for this option:

  • commit_block: the number of changes made before an automatic commit is made for upsert methods that perform commits
  • delete_others: if this option is True, then a hash of primary key values in the input data is built as the input data is iterated. After iterating, if the row count of the table and the input data matches, then nothing more is done, otherwise, every row of the table is iterated and compared to the primary key hash; if a row does not match a primary key value, then it is deleted. This operation allows tables to be completely synchronized by removing rows in the target table not present in the source table. This operation is expensive for large data sets.
  • info_callback: see Upsert Info Callback
  • omit_update: allows for an asymmetrical upsert where a set of column values is inserted, but a smaller set is updated in case the unique key values are present in the target table; the value of this key should be set to the columns to omit in the update clause
const SqlUtil::AbstractTable::UpsertResultDescriptionMap
Initial value:
= (
"inserted": UR_Inserted,
"verified": UR_Verified,
"updated": UR_Updated,
"unchanged": UR_Unchanged,
"deleted": UR_Deleted,
)

hash mapping upsert descriptions to codes

See Also
UpsertResultMap for a reverse mapping
const SqlUtil::AbstractTable::UpsertResultMap
Initial value:
= (
UR_Inserted: "inserted",
UR_Verified: "verified",
UR_Updated: "updated",
UR_Unchanged: "unchanged",
UR_Deleted: "deleted",
)

hash mapping upsert results to a description

See Also
UpsertResultDescriptionMap for a reverse mapping