SqlUtil Namespace Reference

the SqlUtil namespace contains all the objects in the SqlUtil module More...

Classes
class	AbstractCheckConstraint
	abstract class for check constraints More...
class	AbstractColumn
	the base class for column information More...
class	AbstractConstraint
	abstract base class for constraints More...
class	AbstractDatabase
	the base abstract class for the database implementation More...
class	AbstractForeignConstraint
	the base class for foreign key constraint information More...
class	AbstractFunction
	base class for functions More...
class	AbstractFunctionBase
	base class for function or objects with code More...
class	AbstractHashContainer
	abstract container class that throws an exception if an unknown key is accessed More...
class	AbstractIndex
	the abstract base class for index information More...
class	AbstractListContainer
	abstract container class that throws an exception if an unknown key is accessed More...
class	AbstractPrimaryKey
	represents a primary key More...
class	AbstractSequence
	base class for sequences More...
class	AbstractSqlUtilBase
	base class for abstract SqlUtil classes More...
class	AbstractTable
	the base abstract class for the table implementation More...
class	AbstractTrigger
	the base class for triggers More...
class	AbstractUniqueConstraint
	represents a unique column constraint More...
class	AbstractView
	base class for views More...
class	Columns
	column container class that throws an exception if an unknown column is accessed More...
class	Constraints
	constraint container class that throws an exception if an unknown constraint is accessed More...
class	Database
	represents a database; this class embeds an AbstractDatabase object that is created automatically in the constructor based on the database driver for the AbstractDatasource object providing the database connection More...
class	ForeignConstraints
	foreign constraint container class that throws an exception if an unknown constraint is accessed More...
class	ForeignConstraintTarget
	a class describing a foreign constraint target More...
class	Functions
	function container class that throws an exception if an unknown function is accessed More...
class	Indexes
	index container class that throws an exception if an unknown index is accessed More...
class	NumericColumnInfo
	the base class to use to extend AbstractColumn to implement numeric columns More...
class	Table
	represents a database table; this class embeds an AbstractTable object that is created automatically in the constructor based on the database driver for the AbstractDatasource object providing the database connection More...
class	Tables
	the table container class stores a collection of tables in a schema More...
class	Triggers
	trigger container class that throws an exception if an unknown trigger is accessed More...

Functions
hash	cop_append (any column, string arg)
	returns a hash for the "append" operator with the given argument More...
hash	cop_as (any column, string arg)
	returns a hash for the "as" operator with the given argument More...
hash	cop_avg (any column)
	returns a hash for the "avg" operator; returns average column values More...
hash	cop_count (string column="")
	returns a hash for the "count" operator; returns row counts More...
hash	cop_distinct (any column)
	returns a hash for the "distinct" operator with the given argument; returns distinct column values More...
hash	cop_divide (any column1, any column2)
	returns a hash for the "/" operator with the given arguments More...
hash	cop_lower (any column)
	returns a hash for the "lower" operator with the given argument; returns a column value in lower case More...
hash	cop_max (any column)
	returns a hash for the "max" operator; returns maximum column values More...
hash	cop_min (any column)
	returns a hash for the "min" operator; returns minimum column values More...
hash	cop_minus (any column1, any column2)
	returns a hash for the "-" operator with the given arguments More...
hash	cop_multiply (any column1, any column2)
	returns a hash for the "*" operator with the given arguments More...
hash	cop_over (any column, string arg)
	returns a hash for the "over" clause More...
hash	cop_plus (any column1, any column2)
	returns a hash for the "+" operator with the given arguments More...
hash	cop_prepend (any column, string arg)
	returns a hash for the "prepend" operator with the given argument More...
hash	cop_seq (string seq)
	returns a hash for the "seq" operator with the given argument giving the sequence name whose value should be returned More...
hash	cop_upper (any column)
	returns a hash for the "upper" operator with the given argument; returns a column value in upper case More...
hash	cop_value (any arg)
	returns a hash for the "value" operator with the given argument More...
hash	cop_year (any column)
	returns a hash for the "year" operator with the given argument More...
hash	cop_year_day (any column)
	returns a hash for the "year_day" operator with the given argument More...
hash	cop_year_hour (any column)
	returns a hash for the "year_hour" operator with the given argument More...
hash	cop_year_month (any column)
	returns a hash for the "year_month" operator with the given argument More...
hash	iop_seq (string arg)
	returns a hash for retrieving the value of the given sequence in insert queries More...
hash	join_inner (AbstractTable table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for standard inner joins with the given arguments More...
hash	join_inner (Table table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for standard inner joins with the given arguments More...
hash	join_inner (string ta, AbstractTable table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for standard inner joins with the given arguments for use when joining with a table other than the primary table More...
hash	join_inner (string ta, Table table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for standard inner joins with the given arguments for use when joining with a table other than the primary table More...
hash	join_left (AbstractTable table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for left outer joins with the given arguments More...
hash	join_left (Table table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for left outer joins with the given arguments More...
hash	join_left (string ta, AbstractTable table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for left outer joins with the given arguments for use when joining with a table other than the primary table More...
hash	join_left (string ta, Table table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for left outer joins with the given arguments for use when joining with a table other than the primary table More...
hash	join_right (AbstractTable table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for right outer joins with the given arguments More...
hash	join_right (Table table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for right outer joins with the given arguments More...
hash	join_right (string ta, AbstractTable table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for right outer joins with the given arguments for use when joining with a table other than the primary table More...
hash	join_right (string ta, Table table, *string alias, *hash jcols, *hash cond, *hash opt)
	returns a hash for right outer joins with the given arguments for use when joining with a table other than the primary table More...
hash	make_cop (string cop, any column, any arg)
	returns a hash with cop, column, and arg keys More...
hash	make_iop (string iop, any arg)
	returns a hash with _iop and arg keys More...
hash	make_jop (string jop, AbstractTable table, *string alias, *hash jcols, *hash cond, *string ta, *hash opt)
	returns a hash keyed with the table name assigned to a hash with jop, table, jcols, cond, alias, and ta keys More...
hash	make_op (string op, any arg)
	returns a hash with op and arg keys
hash	make_uop (string uop, any arg, *hash nest)
	returns a hash with uop, arg, and nest keys More...
hash	op_between (any l, any r)
	returns a hash for the "between" operator with the given arguments, neither of which can be NULL or NOTHING; for use in where clauses More...
hash	op_ceq (string arg)
	returns a hash for the "=" operator with the given argument for use in where clauses when comparing the values of two columns More...
hash	op_cge (string arg)
	returns a hash for the ">=" operator with the given argument for use in where clauses when comparing the values of two columns More...
hash	op_cgt (string arg)
	returns a hash for the ">" operator with the given argument for use in where clauses when comparing the values of two columns More...
hash	op_cle (string arg)
	returns a hash for the "<=" operator with the given argument for use in where clauses when comparing the values of two columns More...
hash	op_clt (string arg)
	returns a hash for the "<" operator with the given argument for use in where clauses when comparing the values of two columns More...
hash	op_cne (string arg)
	returns a hash for the "!=" or "<>" operator with the given argument for use in where clauses when comparing the values of two columns More...
hash	op_eq (any arg)
	returns a hash for the "=" operator with the given argument for use in where clauses when comparing column values to immediate values More...
hash	op_ge (any arg)
	returns a hash for the ">=" operator with the given argument for use in where clauses when comparing column values to immediate values More...
hash	op_gt (any arg)
	returns a hash for the ">" operator with the given argument for use in where clauses when comparing column values to immediate values More...
hash	op_in ()
	returns a hash for the "in" operator with all arguments passed to the function; for use in where clauses More...
hash	op_in (list args)
	returns a hash for the "in" operator with the given argument list as the first argument; for use in where clauses More...
hash	op_le (any arg)
	returns a hash for the "<=" operator with the given argument for use in where clauses when comparing column values to immediate values More...
hash	op_like (string str)
	returns a hash for the "like" operator with the given argument for use in where clauses More...
hash	op_lt (any arg)
	returns a hash for the "<" operator with the given argument for use in where clauses when comparing column values to immediate values More...
hash	op_ne (any arg)
	returns a hash for the "!=" or "<>" operator with the given argument for use in where clauses when comparing column values to immediate values More...
hash	op_not (hash arg)
	returns a hash for the "not" operator; for use in where clauses More...
hash	uop_append (string arg, *hash nest)
	returns a hash for the "append" or concatenate operator with the given argument More...
hash	uop_lower (*hash nest)
	returns a hash for the "lower" operator with the given argument; returns a column value in lower case More...
hash	uop_prepend (string arg, *hash nest)
	returns a hash for the "prepend" operator with the given argument More...
hash	uop_seq (string seq)
	returns a hash for the "seq" operator with the given argument giving the sequence name whose value should be returned More...
hash	uop_upper (*hash nest)
	returns a hash for the "upper" operator with the given argument; returns a column value in upper case More...

Variables
const	COP_APPEND = "append"
	to append a string to a column on output More...
const	COP_AS = "as"
	to rename a column on output More...
const	COP_AVG = "avg"
	to return the average value More...
const	COP_COUNT = "count"
	to return the row count More...
const	COP_DISTINCT = "distinct"
	to return distinct values More...
const	COP_DIVIDE = "divide"
	the SQL "divide" operator More...
const	COP_LOWER = "lower"
	to return column value in lower case More...
const	COP_MAX = "max"
	to return the maximum value More...
const	COP_MIN = "min"
	to return the minimum value More...
const	COP_MINUS = "minus"
	the SQL "minus" operator More...
const	COP_MULTIPLY = "multiply"
	the SQL "multiply" operator More...
const	COP_OVER = "over"
	the SQL "over" clause More...
const	COP_PLUS = "plus"
	the SQL "minus" operator More...
const	COP_PREPEND = "prepend"
	to prepend a string to a column on output More...
const	COP_SEQ = "seq"
	to return the value of a sequence More...
const	COP_UPPER = "upper"
	to return column value in upper case More...
const	COP_VALUE = "value"
	to append a constant value to use as an output column value More...
const	COP_YEAR = "year"
	to return a date value with year information only More...
const	COP_YEAR_DAY = "year_day"
	to return a date value with year to day information More...
const	COP_YEAR_HOUR = "year_hour"
	to return a date value with year to hextern information More...
const	COP_YEAR_MONTH = "year_month"
	to return a date value with year to month information More...
const	DefaultCopMap
	a hash of default column operator descriptions
const	DefaultIopMap = hash()
	a hash of default insert operator descriptions
const	DefaultOpMap
	a hash of valid operators for use in Where Clauses
const	DefaultUopMap
	a hash of valid update operators
const	IOP_SEQ = "seq"
	for using the value of a sequence More...
const	JOP_INNER = "inner"
	for standard inner joins More...
const	JOP_LEFT = "left"
	for left outer joins More...
const	JOP_RIGHT = "right"
	for right outer joins More...
const	JopMap
	a hash of valid join operators
const	OP_BETWEEN = "between"
	the SQL "between" operator for use in Where Clauses More...
const	OP_CEQ = "C="
	the SQL equals operator (=) for use in Where Clauses More...
const	OP_CGE = "C>="
	the SQL greater than or equals operator (>=) for use in Where Clauses More...
const	OP_CGT = "C>"
	the SQL greater than operator (>) for use in Where Clauses More...
const	OP_CLE = "C<="
	the SQL less than or equals (<=) operator for use in Where Clauses More...
const	OP_CLT = "C<"
	the SQL less than (<) operator for use in Where Clauses when comparing two columns More...
const	OP_CNE = "C!="
	the SQL not equals operator (!= or <>) for use in Where Clauses More...
const	OP_EQ = "="
	the SQL equals operator (=) for use in Where Clauses More...
const	OP_GE = ">="
	the SQL greater than or equals operator (>=) for use in Where Clauses More...
const	OP_GT = ">"
	the SQL greater than operator (>) for use in Where Clauses More...
const	OP_IN = "in"
	the SQL "in" operator for use in Where Clauses More...
const	OP_LE = "<="
	the SQL less than or equals (<=) operator for use in Where Clauses More...
const	OP_LIKE = "like"
	the SQL "like" operator for use in Where Clauses More...
const	OP_LT = "<"
	the SQL less than (<) operator for use in Where Clauses More...
const	OP_NE = "!="
	the SQL not equals operator (!= or <>) for use in Where Clauses More...
const	OP_NOT = "not"
	the SQL "not" operator for use in Where Clauses More...
const	SZ_MAND = 1
	the data type takes a mandatory size parameter
const	SZ_NONE = 0
	the data type does not take a size parameter
const	SZ_NUM = 3
	the data type is numeric so takes an optional precision and scale
const	SZ_OPT = 2
	the data type takes an optional size parameter
const	DB_FUNCTIONS = "functions"
	Features constants. More...
const	DB_MVIEWS = "materialized views"
	Feature: materialized views/snapshots.
const	DB_PACKAGES = "packages"
	Feature: packages.
const	DB_PROCEDURES = "procedures"
	Feature: procedures.
const	DB_SEQUENCES = "sequences"
	Feature: sequences.
const	DB_TABLES = "tables"
	Feature: tables.
const	DB_TYPES = "named types"
	Feature: named types.
const	DB_VIEWS = "views"
	Feature: views.
const	VARCHAR = "string"
	specifies a VARCHAR column (equivalent to Qore::Type::String)
const	NUMERIC = "number"
	specifies a numeric column (equivalent to Qore::Type::Number)
const	CHAR = "char"
	specifies a CHAR column
const	BLOB = "blob"
	specifies a large variable-length binary column (ie BLOB or BYTEA, etc)
const	CLOB = "clob"
	specifies a large variable-length character column (ie CLOB or TEXT, etc)

Detailed Description

the SqlUtil namespace contains all the objects in the SqlUtil module

Variable Documentation

const SqlUtil::DB_FUNCTIONS = "functions"

Features constants.

Feature: functions