include/database/OracleManager.php

Show:

inherited

Classes
- \OracleManager

Table of Contents

\OracleManager
jump to top

Package: SugarCRM

Oracle driver

Parent(s): \DBManager

Properties


                 $_lastResult= ''

contains the last result set returned from query()

Details

Type: n/a


                 $capabilities= 'array(
        "affected_rows" => true,
        "case_sensitive" => true,
        "fulltext" => true,
        "auto_increment_sequence" => true,
        'limit_subquery' => true,
    )'

Capabilities this DB supports. Supported list: affected_rows Can report query affected rows for UPDATE/DELETE implement getAffectedRowCount() select_rows Can report row count for SELECT implement getRowCount() case_sensitive Supports case-sensitive text columns fulltext Supports fulltext search indexes inline_keys Supports defining keys together with the table auto_increment_sequence Autoincrement support implemented as sequence limit_subquery Supports LIMIT clauses in subqueries create_user Can create users for Sugar create_db Can create databases collation Supports setting collations disable_keys Supports temporarily disabling keys (for upgrades, etc.)

Default value

array(
        "affected_rows" => true,
        "case_sensitive" => true,
        "fulltext" => true,
        "auto_increment_sequence" => true,
        'limit_subquery' => true,
    )

Details

Type: n/a

array
                 $configOptions= ''

DB configuration options

Details

Type: array

resource
                 $database= 'null'

inherited

Name of database

Inherited from: \DBManager::$$database

Default valuenullDetails

Type: resource
Inherited_from: \DBManager::$$database


                 $date_formats= 'array(
        '%Y-%m-%d' => 'YYYY-MM-DD',
        '%Y-%m' => 'YYYY-MM',
        '%Y' => 'YYYY',
    )'

Default value

array(
        '%Y-%m-%d' => 'YYYY-MM-DD',
        '%Y-%m' => 'YYYY-MM',
        '%Y' => 'YYYY',
    )

Details

Type: n/a


                 $dbName= ''Oracle''

Default value'Oracle'Details

Type: n/a


                 $dbType= ''oci8''

Default value'oci8'Details

Type: n/a
See: \DBManager::$dbType


                 $dieOnError= 'false'

inherited

Indicates whether we should die when we get an error from the DB

Inherited from: \DBManager::$$dieOnError

Default valuefalseDetails

Type: n/a
Inherited_from: \DBManager::$$dieOnError


                 $encode= 'true'

inherited

Indicates whether we should html encode the results from a query by default

Inherited from: \DBManager::$$encode

Default valuetrueDetails

Type: n/a
Inherited_from: \DBManager::$$encode

array
                 $index_descriptions= 'array()'

staticinherited

Index descriptions

Inherited from: \DBManager::$$index_descriptions

Default valuearray()Details

Type: array
Inherited_from: \DBManager::$$index_descriptions


                 $is_express= ''

Details

Type: n/a

string
                 $label= ''LBL_ORACLE''

Driver name label, for install

Default value'LBL_ORACLE'Details

Type: string


                 $lastResult= ''

inherited

Registry of available result sets

Inherited from: \DBManager::$$lastResult

Details

Type: n/a
Inherited_from: \DBManager::$$lastResult


                 $last_error= 'false'

inherited

Last error message from the DB backend

Inherited from: \DBManager::$$last_error

Default valuefalseDetails

Type: n/a
Inherited_from: \DBManager::$$last_error

\Logger
                 $log= ''

inherited

PHP Logger

Inherited from: \DBManager::$$log

Details

Type: \Logger
Inherited_from: \DBManager::$$log

array
                 $maxNameLengths= 'array(
        'table' => 30,
        'column' => 30,
        'index' => 30,
        'alias' => 30
    )'

Maximum length of identifiers

Default value

array(
        'table' => 30,
        'column' => 30,
        'index' => 30,
        'alias' => 30
    )

Details

Type: array

array
                 $options= 'array()'

inherited

Database options

Inherited from: \DBManager::$$options

Default valuearray()Details

Type: array
Inherited_from: \DBManager::$$options


                 $oracle_privs= 'array(
        "CREATE TABLE" => "CREATE TABLE",
        "DROP TABLE" => "DROP ANY TABLE",
        "INSERT" => "INSERT ANY TABLE",
        "UPDATE" => "UPDATE ANY TABLE",
        "SELECT" => "SELECT ANY TABLE",
        "DELETE" => "DELETE ANY TABLE",
        "ADD COLUMN" => "ALTER ANY TABLE",
        "CHANGE COLUMN" => "ALTER ANY TABLE",
        "DROP COLUMN" => "ALTER ANY TABLE",
    )'

Default value

array(
        "CREATE TABLE" => "CREATE TABLE",
        "DROP TABLE" => "DROP ANY TABLE",
        "INSERT" => "INSERT ANY TABLE",
        "UPDATE" => "UPDATE ANY TABLE",
        "SELECT" => "SELECT ANY TABLE",
        "DELETE" => "DELETE ANY TABLE",
        "ADD COLUMN" => "ALTER ANY TABLE",
        "CHANGE COLUMN" => "ALTER ANY TABLE",
        "DROP COLUMN" => "ALTER ANY TABLE",
    )

Details

Type: n/a


                 $preparedTokens= 'array()'

inherited

Array of prepared statements and their correspoding parsed tokens

Inherited from: \DBManager::$$preparedTokens

Default valuearray()Details

Type: n/a
Inherited_from: \DBManager::$$preparedTokens

int
                 $priority= '0'

inherited

DB driver priority Higher priority drivers override lower priority ones

Inherited from: \DBManager::$$priority

Default value0Details

Type: int
Inherited_from: \DBManager::$$priority


                 $queryCount= '0'

staticinherited

Current query count

Inherited from: \DBManager::$$queryCount

Default value0Details

Type: n/a
Inherited_from: \DBManager::$$queryCount


                 $queryLimit= '0'

staticinherited

Query threshold limit

Inherited from: \DBManager::$$queryLimit

Default value0Details

Type: n/a
Inherited_from: \DBManager::$$queryLimit


                 $query_time= '0'

inherited

Records the execution time of the last query

Inherited from: \DBManager::$$query_time

Default value0Details

Type: n/a
Inherited_from: \DBManager::$$query_time

array
                 $sequences= 'null'

static

List of known sequences

Default valuenullDetails

Type: array


                 $standardQueries= 'array(
		'ALTER TABLE' => 'verifyAlterTable',
		'DROP TABLE' => 'verifyDropTable',
		'CREATE TABLE' => 'verifyCreateTable',
		'INSERT INTO' => 'verifyInsertInto',
		'UPDATE' => 'verifyUpdate',
		'DELETE FROM' => 'verifyDeleteFrom',
	)'

inheritedInherited from: \DBManager::$$standardQueries

Default value

array(
		'ALTER TABLE' => 'verifyAlterTable',
		'DROP TABLE' => 'verifyDropTable',
		'CREATE TABLE' => 'verifyCreateTable',
		'INSERT INTO' => 'verifyInsertInto',
		'UPDATE' => 'verifyUpdate',
		'DELETE FROM' => 'verifyDeleteFrom',
	)

Details

Type: n/a
Inherited_from: \DBManager::$$standardQueries

array
                 $table_descriptions= 'array()'

staticinherited

Table descriptions

Inherited from: \DBManager::$$table_descriptions

Default valuearray()Details

Type: array
Inherited_from: \DBManager::$$table_descriptions

\TimeDate
                 $timedate= ''

inherited

TimeDate instance

Inherited from: \DBManager::$$timedate

Details

Type: \TimeDate
Inherited_from: \DBManager::$$timedate

array
                 $type_class= 'array(
			'int'      => 'int',
			'double'   => 'float',
			'float'    => 'float',
			'uint'     => 'int',
			'ulong'    => 'bigint',
			'long'     => 'bigint',
			'short'    => 'int',
			'date'     => 'date',
			'datetime' => 'date',
			'datetimecombo' => 'date',
			'time'     => 'time',
			'bool'     => 'bool',
			'tinyint'  => 'int',
			'currency' => 'float',
			'decimal'  => 'float',
			'decimal2' => 'float',
	)'

inherited

Type classification into: - int - bool - float - date

Inherited from: \DBManager::$$type_class

Default value

array(
			'int'      => 'int',
			'double'   => 'float',
			'float'    => 'float',
			'uint'     => 'int',
			'ulong'    => 'bigint',
			'long'     => 'bigint',
			'short'    => 'int',
			'date'     => 'date',
			'datetime' => 'date',
			'datetimecombo' => 'date',
			'time'     => 'time',
			'bool'     => 'bool',
			'tinyint'  => 'int',
			'currency' => 'float',
			'decimal'  => 'float',
			'decimal2' => 'float',
	)

Details

Type: array
Abstract
Inherited_from: \DBManager::$$type_class

array
                 $type_map= 'array(
            'int'      => 'number',
            'double'   => 'number(38,10)',
            'float'    => 'number(30,6)',
            'uint'     => 'number(15)',
            'ulong'    => 'number(38)',
            'long'     => 'number(38)',
            'short'    => 'number(3)',
            'varchar'  => 'varchar2',
            'text'     => 'clob',
            'longtext' => 'clob',
            'date'     => 'date',
            'enum'     => 'varchar2(255)',
            'relate'   => 'varchar2',
            'multienum'=> 'clob',
            'html'     => 'clob',
            'longhtml' => 'clob',
    		'datetime' => 'date',
            'datetimecombo' => 'date',
            'time'     => 'date',
            'bool'     => 'number(1)',
            'tinyint'  => 'number(3)',
            'char'     => 'char',
            'id'       => 'varchar2(36)',
            'blob'     => 'blob',
            'longblob' => 'blob',
            'currency' => 'number(26,6)',
            'decimal'  => 'number(20,2)',
            'decimal2' => 'number(30,6)',
            'url'      => 'varchar2',
            'encrypt'  => 'varchar2(255)',
            'file'     => 'varchar2(255)',
	    	'decimal_tpl' => 'number(%d, %d)',
            )'

Type names map

Default value

array(
            'int'      => 'number',
            'double'   => 'number(38,10)',
            'float'    => 'number(30,6)',
            'uint'     => 'number(15)',
            'ulong'    => 'number(38)',
            'long'     => 'number(38)',
            'short'    => 'number(3)',
            'varchar'  => 'varchar2',
            'text'     => 'clob',
            'longtext' => 'clob',
            'date'     => 'date',
            'enum'     => 'varchar2(255)',
            'relate'   => 'varchar2',
            'multienum'=> 'clob',
            'html'     => 'clob',
            'longhtml' => 'clob',
    		'datetime' => 'date',
            'datetimecombo' => 'date',
            'time'     => 'date',
            'bool'     => 'number(1)',
            'tinyint'  => 'number(3)',
            'char'     => 'char',
            'id'       => 'varchar2(36)',
            'blob'     => 'blob',
            'longblob' => 'blob',
            'currency' => 'number(26,6)',
            'decimal'  => 'number(20,2)',
            'decimal2' => 'number(30,6)',
            'url'      => 'varchar2',
            'encrypt'  => 'varchar2(255)',
            'file'     => 'varchar2(255)',
	    	'decimal_tpl' => 'number(%d, %d)',
            )

Details

Type: array


                 $variant= ''oci8''

Default value'oci8'Details

Type: n/a

Methods

AltlobExecute(
          string $table, array $field_defs, array $data, string $sql
          )
        
        :
          bool

Executes a query, with special handling for Oracle CLOB and BLOB field type

Oracle seems to need special treatment for BLOB/CLOB insertion, so this method inserts BLOB data properly.

Parameters

Name	Type	Description
$table	string	Table name
$field_defs	array	Field metadata definitions
$data	array	Data being inserted
$sql	string	SQL statement

Returns

Type	Description
bool	Success?

__construct(
          
          )
        
        :
          void

inherited

Create DB Driver

Inherited from: \DBManager::__construct()

__get(
          string $p
          )
        
        :
          mixed

inherited

Wrapper for those trying to access the private and protected class members directly

Inherited from: \DBManager::__get()

Parameters

Name	Type	Description
$p	string	var name

Returns

Type	Description
mixed

_emptyValue(
          mixed $val, string $type
          )
        
        :
          bool

inherited

Check if the value is empty value for this type

Inherited from: \DBManager::_emptyValue()

Parameters

Name	Type	Description
$val	mixed	Value
$type	string	Type (one of vardef types)

Returns

Type	Description
bool	true if the value if empty

_findSequence(
          string $name
          )
        
        :
          bool

Returns true if the sequence name given is found

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool	true if the sequence is found, false otherwise TODO: check if some caching here makes sense, keeping in mind bug 43148

_getBooleanValue(
          mixed $val
          )
        
        :
          bool

inherited

Get truth value for boolean type Allows 'off' to mean false, along with all 'empty' values

Inherited from: \DBManager::_getBooleanValue()

Parameters

Name	Type	Description
$val	mixed

Returns

Type	Description
bool

_getSequenceName(
          string $table, string $field_name, boolean $upper_case
              =
              true
          )
        
        :
          string

Generate an Oracle SEQUENCE name. If the length of the sequence names exceeds a certain amount we will use an md5 of the field name to shorten.

Parameters

Name	Type	Description
$table	string
$field_name	string
$upper_case	boolean

Returns

Type	Description
string

_isNullableDb(
          string $tableName, string $fieldName
          )
        
        :
          bool

returns true if the field is nullable

Parameters

Name	Type	Description
$tableName	string
$fieldName	string

Returns

Type	Description
bool

addColumn(
          string $tablename, array $fieldDefs
          )
        
        :
          bool

inherited

Adds a column to table identified by field def.

Inherited from: \DBManager::addColumn()

Parameters

Name	Type	Description
$tablename	string
$fieldDefs	array

Returns

Type	Description
bool	query result

addColumnSQL(
          string $tablename, array $fieldDefs
          )
        
        :
          string

inherited

This method generates sql for adding a column to table identified by field def.

Inherited from: \DBManager::addColumnSQL()

Parameters

Name	Type	Description
$tablename	string
$fieldDefs	array

Returns

Type	Description
string	SQL statement

addDistinctClause(
          string $sql
          )
        
        :
          void

inherited

addDistinctClause This method takes a SQL statement and checks if the disable_count_query setting is enabled before altering it. The alteration modifies the way the team security queries are made by changing it from a subselect to a distinct clause; hence the name of the method.

Inherited from: \DBManager::addDistinctClause()

Parameters

Name	Type	Description
$sql	string	value of SQL statement to alter

addIndexes(
          string $tablename, array $indexes, bool $execute
              =
              true
          )
        
        :
          string

inherited

Adds a new indexes

Inherited from: \DBManager::addIndexes()

Parameters

Name	Type	Description
$tablename	string
$indexes	array	indexes to add
$execute	bool	true if we want to execute the returned sql statement

Returns

Type	Description
string	SQL statement

add_drop_constraint(
          string $table, array $definition, bool $drop
              =
              false
          )
        
        :
          string

Generates alter constraint statement given a table name and vardef definition.

Supports both adding and droping a constraint.

Parameters

Name	Type	Description
$table	string	tablename
$definition	array	field definition
$drop	bool	true if we are dropping the constraint, false if we are adding it

Returns

Type	Description
string	SQL statement

Details

See: \DBManager::add_drop_constraint()

alterColumn(
          string $tablename, array $newFieldDef, bool $ignoreRequired
              =
              false
          )
        
        :
          bool

inherited

Alters old column identified by oldFieldDef to new fieldDef.

Inherited from: \DBManager::alterColumn()

Parameters

Name	Type	Description
$tablename	string
$newFieldDef	array
$ignoreRequired	bool	optional, true if we are ignoring this being a required field

Returns

Type	Description
bool	query result

alterColumnSQL(
          string $tablename, array $newFieldDefs, bool $ignorerequired
              =
              false
          )
        
        :
          string | array

inherited

This method genrates sql for altering old column identified by oldFieldDef to new fieldDef.

Inherited from: \DBManager::alterColumnSQL()

Parameters

Name	Type	Description
$tablename	string
$newFieldDefs	array
$ignorerequired	bool	Optional, true if we should ignor this being a required field

Returns

Type	Description
string \| array	SQL statement(s)

arrayQuote(
          array $array
          )
        
        :
          array

inherited

Quote the strings of the passed in array

Inherited from: \DBManager::arrayQuote()

The array must only contain strings

Parameters

Name	Type	Description
$array	array

Returns

Type	Description
array	Quoted strings

auditSQL(
          \SugarBean $bean, array $changes
          )
        
        :
          string

inherited

Generate query for audit table

Inherited from: \DBManager::auditSQL()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean that was changed
$changes	array	List of changes, contains 'before' and 'after'

Returns

Type	Description
string	Audit table INSERT query

canInstall(
          
          )
        
        :
          mixed

Check DB version

Returns

Type	Description
mixed

Details

See: \DBManager::canInstall()

changeColumnSQL(
          string $tablename, array $fieldDefs, string $action, bool $ignoreRequired
              =
              false
          )
        
        :
          string | array

Generates the SQL for changing columns

Parameters

Name	Type	Description
$tablename	string
$fieldDefs	array
$action	string
$ignoreRequired	bool	Optional, true if we should ignor this being a required field

Returns

Type	Description
string \| array

Details

See: \DBManager::changeColumnSQL()

changeOneColumnSQL(
          string $tablename, array $fieldDef, string $action, bool $ignoreRequired
              =
              false
          )
        
        :
          void

Generate modify statement for one column

Parameters

Name	Type	Description
$tablename	string
$fieldDef	array	Vardef definition for field
$action	string
$ignoreRequired	bool

checkConnection(
          
          )
        
        :
          void

inherited

Checks the current connection; if it is not connected then reconnect

Inherited from: \DBManager::checkConnection()

checkError(
          string $msg
              =
              '', bool $dieOnError
              =
              false,  $stmt
              =
              null
          )
        
        :
          bool

Checks for error happening in the database

Parameters

Name	Type	Description
$msg	string	message to prepend to the error message
$dieOnError	bool	true if we want to die immediately on error
$stmt

Returns

Type	Description
bool	True if there was an error

Details

See: \DBManager::checkError()

checkPrivilege(
          string $privilege
          )
        
        :
          bool

Check if connecting user has certain privilege

Parameters

Name	Type	Description
$privilege	string

Returns

Type	Description
bool	Privilege allowed?

checkQuery(
          string $sql
          )
        
        :
          bool

Scans order by to ensure that any field being ordered by is.

It will throw a warning error to the log file - fatal if slow query logging is enabled

Parameters

Name	Type	Description
$sql	string	query to be run

Returns

Type	Description
bool	true if an index is found false otherwise

Details

See: \DBManager::checkQuery()

columnSQLRep(
          array $fieldDefs, bool $ignoreRequired
              =
              false, string $tablename
          )
        
        :
          string

inherited

Returns SQL defintions for all columns in a table

Inherited from: \DBManager::columnSQLRep()

Parameters

Name	Type	Description
$fieldDefs	array	Vardef-format field def
$ignoreRequired	bool	Optional, true if we should ignor this being a required field
$tablename	string	Optional, table name

Returns

Type	Description
string	SQL column definitions

commit(
          
          )
        
        :
          bool

inherited

Commits pending changes to the database when the driver is setup to support transactions.

Inherited from: \DBManager::commit()

Note that the default implementation is applicable for transaction-less or auto commit scenarios.

Returns

Type	Description
bool	true if commit succeeded, false if it failed

Details

Abstract

compareFieldInTables(
          string $name, string $table1, string $table2
          )
        
        :
          array

inherited

Compare a field in two tables

Inherited from: \DBManager::compareFieldInTables()

Parameters

Name	Type	Description
$name	string	field name
$table1	string
$table2	string

Returns

Type	Description
array	array with keys 'msg','table1','table2'

compareVarDefs(
          array $fielddef1, array $fielddef2, bool $ignoreName
              =
              false
          )
        
        :
          bool

Compares two vardefs

Parameters

Name	Type	Description
$fielddef1	array	This is from the database
$fielddef2	array	This is from the vardef
$ignoreName	bool	Ignore name-only differences?

Returns

Type	Description
bool	true if they match, false if they don't

concat(
          string $table, array $fields, string $space
              =
              ' '
          )
        
        :
          string

inherited

Returns the database string needed for concatinating multiple database strings together

Inherited from: \DBManager::concat()

Parameters

Name	Type	Description
$table	string	table name of the database fields to concat
$fields	array	fields in the table to concat together
$space	string	Separator between strings, default is single space

Returns

Type	Description
string

connect(
          array $configOptions
              =
              null, boolean $dieOnError
              =
              false
          )
        
        :
          void

Connects to the database backend

Takes in the database settings and opens a database connection based on those will open either a persistent or non-persistent connection. If a persistent connection is desired but not available it will defualt to non-persistent

configOptions must include db_host_name - server ip db_user_name - database user name db_password - database password

Parameters

Name	Type	Description
$configOptions	array
$dieOnError	boolean

Details

See: \DBManager::connect()

convert(
          string $string, string $type, array $additional_parameters
              =
              array()
          )
        
        :
          string

Use when you need to convert a database string to a different value; this function does it in a database-backend aware way Supported conversions: today return current date left Take substring from the left date_format Format date as string, supports %Y-%m-%d, %Y-%m, %Y time_format Format time as string date Convert date string to datetime value time Convert time string to datetime value datetime Convert datetime string to datetime value ifnull If var is null, use default value concat Concatenate strings quarter Quarter number of the date length Length of string month Month number of the date add_date Add specified interval to a date add_time Add time interval to a date text2char Convert text field to varchar

Parameters

Name	Type	Description
$string	string	database string to convert
$type	string	type of conversion to do
$additional_parameters	array	optional, additional parameters to pass to the db function

Returns

Type	Description
string

Details

See: \DBManager::convert()

countQuery(
          
          )
        
        :
          void

inherited

This function increments the global $sql_queries variable

Inherited from: \DBManager::countQuery()

createConstraintSql(
          \SugarBean $bean
          )
        
        :
          array

inherited

returns SQL to create constraints or indices

Inherited from: \DBManager::createConstraintSql()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance

Returns

Type	Description
array	list of SQL statements

createDatabase(
          string $dbname
          )
        
        :
          void

Create a database

Parameters

Name	Type	Description
$dbname	string

createDbUser(
          string $database_name, string $host_name, string $user, string $password
          )
        
        :
          void

Create DB user

Parameters

Name	Type	Description
$database_name	string
$host_name	string
$user	string
$password	string

createIndex(
          \SugarBean $bean, array $fieldDefs, string $name, bool $unique
              =
              true
          )
        
        :
          bool

inherited

Creates an index identified by name on the given fields.

Inherited from: \DBManager::createIndex()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance
$fieldDefs	array	Field definitions, in vardef format
$name	string	index name
$unique	bool	optional, true if we want to create an unique index

Returns

Type	Description
bool	query result

createIndexSQL(
          \SugarBean $bean, array $fields, string $name, bool $unique
              =
              true
          )
        
        :
          string

inherited

Generates SQL for create index statement for a bean.

Inherited from: \DBManager::createIndexSQL()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance
$fields	array	fields used in the index
$name	string	index name
$unique	bool	Optional, set to true if this is an unique index

Returns

Type	Description
string	SQL Select Statement

createTable(
          \SugarBean $bean
          )
        
        :
          void

inherited

Implements creation of a db table for a bean.

Inherited from: \DBManager::createTable()

NOTE: does not handle out-of-table constraints, use createConstraintSQL for that

Parameters

Name	Type	Description
$bean	\SugarBean	Sugarbean instance

createTableParams(
          string $tablename, array $fieldDefs, array $indices, string $engine
              =
              null
          )
        
        :
          bool

inherited

Implements creation of a db table

Inherited from: \DBManager::createTableParams()

Parameters

Name	Type	Description
$tablename	string
$fieldDefs	array	Field definitions, in vardef format
$indices	array	Index definitions, in vardef format
$engine	string	Engine parameter, used for MySQL engine so far

Returns

Type	Description
bool	success value

createTableSQL(
          \SugarBean $bean
          )
        
        :
          string

inherited

Generates sql for create table statement for a bean.

Inherited from: \DBManager::createTableSQL()

NOTE: does not handle out-of-table constraints, use createConstraintSQL for that

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance

Returns

Type	Description
string	SQL Create Table statement

createTableSQLParams(
          string $tablename, array $fieldDefs, array $indices
          )
        
        :
          string

Generates sql for create table statement for a bean.

Parameters

Name	Type	Description
$tablename	string
$fieldDefs	array
$indices	array

Returns

Type	Description
string	SQL Create Table statement

Details

See: \DBManager::createTableSQLParams()

dbExists(
          string $dbname
          )
        
        :
          void

Check if certain database exists

Parameters

Name	Type	Description
$dbname	string

delete(
          \SugarBean $bean, array $where
              =
              array()
          )
        
        :
          bool

inherited

Implements a generic delete for any bean identified by id

Inherited from: \DBManager::delete()

Parameters

Name	Type	Description
$bean	\SugarBean	Sugarbean instance
$where	array	values with the keys as names of fields. If we want to pass multiple values for a name, pass it as an array If where is not passed, it defaults to id of table

Returns

Type	Description
bool	query result

deleteAutoIncrement(
          string $table, string $field_name
          )
        
        :
          void

Deletes an auto increment

Parameters

Name	Type	Description
$table	string	tablename
$field_name	string

Details

See: \DBManager::deleteAutoIncrement()

deleteColumn(
          \SugarBean $bean, array $fieldDefs
          )
        
        :
          bool

inherited

Deletes a column identified by fieldDef.

Inherited from: \DBManager::deleteColumn()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean containing the field
$fieldDefs	array	Vardef definition of the field

Returns

Type	Description
bool	query result

deleteColumnSQL(
          \SugarBean $bean, array $fieldDefs
          )
        
        :
          string

inherited

This method generates sql that deletes a column identified by fieldDef.

Inherited from: \DBManager::deleteColumnSQL()

Parameters

Name	Type	Description
$bean	\SugarBean	Sugarbean instance
$fieldDefs	array

Returns

Type	Description
string	SQL statement

deleteSQL(
          \SugarBean $bean, array $where
          )
        
        :
          string

inherited

Generates SQL for delete statement identified by id.

Inherited from: \DBManager::deleteSQL()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance
$where	array	where conditions in an array

Returns

Type	Description
string	SQL Update Statement

describeField(
          string $name, string $tablename
          )
        
        :
          array

inherited

Returns the field description for a given field in table

Inherited from: \DBManager::describeField()

Parameters

Name	Type	Description
$name	string
$tablename	string

Returns

Type	Description
array

describeIndex(
          string $name, string $tablename
          )
        
        :
          array

inherited

Returns the index description for a given index in table

Inherited from: \DBManager::describeIndex()

Parameters

Name	Type	Description
$name	string
$tablename	string

Returns

Type	Description
array

disableKeys(
          string $tableName
          )
        
        :
          void

inherited

Disable keys on the table

Inherited from: \DBManager::disableKeys()

Parameters

Name	Type	Description
$tableName	string

Details

Abstract

disconnect(
          
          )
        
        :
          void

Disconnects from the database

Also handles any cleanup needed

disconnectAll(
          
          )
        
        :
          void

inherited

Inherited from: \DBManager::disconnectAll()

dropColumnSQL(
          string $tablename, array $fieldDefs
          )
        
        :
          string

inherited

This method generates sql that drops a column identified by fieldDef.

Inherited from: \DBManager::dropColumnSQL()

Designed to work like the other addColumnSQL() and alterColumnSQL() functions

Parameters

Name	Type	Description
$tablename	string
$fieldDefs	array

Returns

Type	Description
string	SQL statement

dropDatabase(
          string $dbname
          )
        
        :
          void

Drop a database

Parameters

Name	Type	Description
$dbname	string

dropIndexes(
          string $tablename, array $indexes, bool $execute
              =
              true
          )
        
        :
          string

inherited

Drops indexes

Inherited from: \DBManager::dropIndexes()

Parameters

Name	Type	Description
$tablename	string
$indexes	array	indexes to drop
$execute	bool	true if we want to execute the returned sql statement

Returns

Type	Description
string	SQL statement

dropTable(
          \SugarBean $bean
          )
        
        :
          bool

inherited

Drops the table associated with a bean

Inherited from: \DBManager::dropTable()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance

Returns

Type	Description
bool	query result

dropTableName(
          string $name
          )
        
        :
          bool

inherited

Drops the table by name

Inherited from: \DBManager::dropTableName()

Parameters

Name	Type	Description
$name	string	Table name

Returns

Type	Description
bool	query result

dropTableNameSQL(
          string $name
          )
        
        :
          string

Generates SQL for dropping a table.

Parameters

Name	Type	Description
$name	string	table name

Returns

Type	Description
string	SQL statement

Details

See: \DBManager::dropTableNameSQL()

dropTableSQL(
          \SugarBean $bean
          )
        
        :
          string

inherited

Generates SQL for dropping a table.

Inherited from: \DBManager::dropTableSQL()

Parameters

Name	Type	Description
$bean	\SugarBean	Sugarbean instance

Returns

Type	Description
string	SQL statement

dump_slow_queries(
          string $query
          )
        
        :
          boolean

inherited

This method is called by every method that runs a query.

Inherited from: \DBManager::dump_slow_queries()

If slow query dumping is turned on and the query time is beyond the time limit, we will log the query. This function may do additional reporting or log in a different area in the future.

Parameters

Name	Type	Description
$query	string	query to log

Returns

Type	Description
boolean	true if the query was logged, false otherwise

emptyValue(
          string $type
          )
        
        :
          mixed

Return representation of an empty value depending on type The value is fully quoted, converted, etc.

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
mixed	Empty value

enableKeys(
          string $tableName
          )
        
        :
          void

inherited

Re-enable keys on the table

Inherited from: \DBManager::enableKeys()

Parameters

Name	Type	Description
$tableName	string

Details

Abstract

escape_quote(
          string $string
          )
        
        :
          string

inherited

Quotes a string for storing in the database

Inherited from: \DBManager::escape_quote()

Parameters

Name	Type	Description
$string	string

Returns

Type	Description
string

executePreparedQuery(
          int $stmt, array $data
              =
              array()
          )
        
        :
          resource

inherited

Takes a prepared stmt index and the data to replace and creates the query and runs it.

Inherited from: \DBManager::executePreparedQuery()

Parameters

Name	Type	Description
$stmt	int	The index of the prepared statement from preparedTokens
$data	array	The array of data to replace the tokens with.

Returns

Type	Description
resource	result set or false on error

extractTableName(
          string $query
          )
        
        :
          string

inherited

Extract table name from a query

Inherited from: \DBManager::extractTableName()

Parameters

Name	Type	Description
$query	string	SQL query

Returns

Type	Description
string

fetchByAssoc(
          resource $result, bool $encode
              =
              true
          )
        
        :
          array

inherited

Fetches the next row in the query result into an associative array

Inherited from: \DBManager::fetchByAssoc()

Parameters

Name	Type	Description
$result	resource
$encode	bool	Need to HTML-encode the result?

Returns

Type	Description
array	returns false if there are no more rows available to fetch

fetchOne(
          string $sql, bool $dieOnError
              =
              false, string $msg
              =
              '', bool $suppress
              =
              false
          )
        
        :
          array

inherited

Runs a query and returns a single row

Inherited from: \DBManager::fetchOne()

Parameters

Name	Type	Description
$sql	string	SQL Statement to execute
$dieOnError	bool	True if we want to call die if the query returns errors
$msg	string	Message to log if error occurs
$suppress	bool	Message to log if error occurs

Returns

Type	Description
array	single row from the query

fetchRow(
          resource $result
          )
        
        :
          array

Fetches the next row in the query result into an associative array

Parameters

Name	Type	Description
$result	resource

Returns

Type	Description
array	returns false if there are no more rows available to fetch

Details

See: \DBManager::fetchRow()

fixIndexName(
          string $name
          )
        
        :
          string

Fixes an Oracle index name

Oracle has a strict limit on the size of object names (30 characters). errors will occur if this is not checked. indexes should follow the naming convention as follows

idx_[table name][column](_[column2] ...)

and columns should be abbreviated by the first three letters or the following abbreviation chart

    u = assigned user
    t = assigned team
    d = deleted
    n = name

Parameters

Name	Type	Description
$name	string	index name

Returns

Type	Description
string

freeDbResult(
          resource $dbResult
          )
        
        :
          void

Free Database result

Parameters

Name	Type	Description
$dbResult	resource

Details

See: \DBManager::freeDbResult()

freeResult(
          resource | bool $result
              =
              false
          )
        
        :
          void

inherited

Frees out previous results

Inherited from: \DBManager::freeResult()

Parameters

Name	Type	Description
$result	resource \| bool	optional, pass if you want to free a single result instead of all results

fromConvert(
          string $string, string $type
          )
        
        :
          string

Converts from Database data to app data

Supported types - date - time - datetime - datetimecombo - timestamp

Parameters

Name	Type	Description
$string	string	database string to convert
$type	string	type of conversion to do

Returns

Type	Description
string

Details

See: \DBManager::fromConvert()

full_text_indexing_installed(
          
          )
        
        :
          bool

Check if the database supports fulltext indexing Note that database driver can be capable of supporting FT (see supports('fulltext)) but particular instance can still have it disabled

Returns

Type	Description
bool

full_text_indexing_setup(
          
          )
        
        :
          void

inherited

Setup FT indexing

Inherited from: \DBManager::full_text_indexing_setup()

Details

Abstract

generateInsertSQL(
          \SugarBean $bean, string $select_query, int $start, int $count
              =
              -1, string $table, bool $is_related_query
              =
              false
          )
        
        :
          string

inherited

Generate a set of Insert statements based on the bean given

Inherited from: \DBManager::generateInsertSQL()

Parameters

Name	Type	Description
$bean	\SugarBean	the bean from which table we will generate insert stmts
$select_query	string	the query which will give us the set of objects we want to place into our insert statement
$start	int	the first row to query
$count	int	the number of rows to query
$table	string	the table to query from
$is_related_query	bool

Returns

Type	Description
string	SQL insert statement

getAffectedRowCount(
          resource $result
          )
        
        :
          int

Get number of rows affected by last operation

Parameters

Name	Type	Description
$result	resource	query result resource

Returns

Type	Description
int

Details

See: \DBManager::getAffectedRowCount()

getAutoIncrement(
          string $table, string $field_name
          )
        
        :
          string

Returns the next value for an auto increment

Parameters

Name	Type	Description
$table	string	Table name
$field_name	string	Field name

Returns

Type	Description
string

Details

See: \DBManager::getAutoIncrement()

getAutoIncrementSQL(
          string $table, string $field_name
          )
        
        :
          string

Returns the sql for the next value in a sequence

Parameters

Name	Type	Description
$table	string	Table name
$field_name	string	Field name

Returns

Type	Description
string

Details

See: \DBManager::getAutoIncrementSQL()

getCollationList(
          
          )
        
        :
          array

inherited

List of available collation settings

Inherited from: \DBManager::getCollationList()

Returns

Type	Description
array

Details

Abstract

getColumnType(
          string $type
          )
        
        :
          string

inherited

Returns the valid type for a column given the type in fieldDef

Inherited from: \DBManager::getColumnType()

Parameters

Name	Type	Description
$type	string	field type

Returns

Type	Description
string	valid type for the given field

getColumnWhereClause(
          string $table, array $whereArray
              =
              array()
          )
        
        :
          string

inherited

Returns a where clause without the 'where' key word

Inherited from: \DBManager::getColumnWhereClause()

The clause returned does not have an 'and' at the beginning and the columns are joined by 'and'.

Parameters

Name	Type	Description
$table	string	table name
$whereArray	array	Optional, where conditions in an array

Returns

Type	Description
string

getConstraintSql(
          array $indices, string $table
          )
        
        :
          array

inherited

returns a SQL query that creates the indices as defined in metadata

Inherited from: \DBManager::getConstraintSql()

Parameters

Name	Type	Description
$indices	array	Assoc array with index definitions from vardefs
$table	string	Focus table

Returns

Type	Description
array	Array of SQL queries to generate indices

getDataChanges(
          \SugarBean $bean
          )
        
        :
          array

inherited

Uses the audit enabled fields array to find fields whose value has changed.

Inherited from: \DBManager::getDataChanges()

The before and after values are stored in the bean. Uses $bean->fetched_row to compare

Parameters

Name	Type	Description
$bean	\SugarBean	Sugarbean instance that was changed

Returns

Type	Description
array

getDatabase(
          
          )
        
        :
          resource

inherited

Returns the current database handle

Inherited from: \DBManager::getDatabase()

Returns

Type	Description
resource

getDbInfo(
          
          )
        
        :
          array | null

Get database configuration information (DB-dependent)

Returns

Type	Description
array \| null

getDefaultCollation(
          
          )
        
        :
          string

inherited

List of available collation settings

Inherited from: \DBManager::getDefaultCollation()

Returns

Type	Description
string

Details

Abstract

getFieldNameFromSelect(
          string $string
          )
        
        :
          string

inherited

returns the field name used in a select

Inherited from: \DBManager::getFieldNameFromSelect()

Parameters

Name	Type	Description
$string	string	SELECT query

Returns

Type	Description
string

getFieldType(
          array $fieldDef
          )
        
        :
          string

inherited

Returns the type of the variable in the field

Inherited from: \DBManager::getFieldType()

Parameters

Name	Type	Description
$fieldDef	array	Vardef-format field def

Returns

Type	Description
string

getFieldsArray(
          resource $result, boolean $make_lower_case
              =
              false
          )
        
        :
          array

Returns the description of fields based on the result

Parameters

Name	Type	Description
$result	resource
$make_lower_case	boolean

Returns

Type	Description
array	field array

Details

See: \DBManager::getFieldsArray()

getFromDummyTable(
          
          )
        
        :
          string

Returns a DB specific FROM clause which can be used to select against functions.

Note that depending on the database that this may also be an empty string.

Returns

Type	Description
string

getFulltextQuery(
           $field, array $terms, array $must_terms
              =
              array(), array $exclude_terms
              =
              array(),  $label
              =
              1
          )
        
        :
          void

Generate fulltext query from set of terms

Parameters

Name	Type	Description
$field
$terms	array	Search terms that may be or not be in the result
$must_terms	array	Search terms that have to be in the result
$exclude_terms	array	Search terms that have to be not in the result
$label

getGuidSQL(
          
          )
        
        :
          string

Returns a DB specific piece of SQL which will generate GUID (UUID) This string can be used in dynamic SQL to do multiple inserts with a single query.

I.e. generate a unique Sugar id in a sub select of an insert statement.

Returns

Type	Description
string

getHelper(
          
          )
        
        :
          \DBManager

inherited

Returns this instance's DBHelper Actually now returns $this

Inherited from: \DBManager::getHelper()

Returns

Type	Description
\DBManager

getOne(
          string $sql, bool $dieOnError
              =
              false, string $msg
              =
              ''
          )
        
        :
          array

inherited

Runs a query and returns a single row containing single value

Inherited from: \DBManager::getOne()

Parameters

Name	Type	Description
$sql	string	SQL Statement to execute
$dieOnError	bool	True if we want to call die if the query returns errors
$msg	string	Message to log if error occurs

Returns

Type	Description
array	single value from the query

getOption(
          string $option
          )
        
        :
          mixed

inherited

Get DB option by name

Inherited from: \DBManager::getOption()

Parameters

Name	Type	Description
$option	string	Option name

Returns

Type	Description
mixed	Option value or null if doesn't exist

getOptions(
          
          )
        
        :
          array

inherited

Get DB options

Inherited from: \DBManager::getOptions()

Returns

Type	Description
array

getQueryCount(
          
          )
        
        :
          int

staticinherited

Returns the static queryCount value

Inherited from: \DBManager::getQueryCount()

Returns

Type	Description
int	value of the queryCount static variable

getQueryTime(
          
          )
        
        :
          int

inherited

Returns the time the last query took to execute

Inherited from: \DBManager::getQueryTime()

Returns

Type	Description
int

getRowCount(
          resource $result
          )
        
        :
          int

inherited

Returns the number of rows returned by the result

Inherited from: \DBManager::getRowCount()

This function can't be reliably implemented on most DB, do not use it.

Parameters

Name	Type	Description
$result	resource

Returns

Type	Description
int

Details

Abstract

getScriptName(
          
          )
        
        :
          string

(non-PHPdoc)

Returns

Type	Description
string

Details

See: \DBManager::getScriptName()

getSelectFieldsFromQuery(
          string $selectStatement
          )
        
        :
          array

inherited

Take an SQL statement and produce a list of fields used in that select

Inherited from: \DBManager::getSelectFieldsFromQuery()

Parameters

Name	Type	Description
$selectStatement	string

Returns

Type	Description
array

getTableDescription(
          string $tablename, bool $reload
              =
              false
          )
        
        :
          array

inherited

Get table description

Inherited from: \DBManager::getTableDescription()

Parameters

Name	Type	Description
$tablename	string
$reload	bool	true means load from DB, false allows using cache

Returns

Type	Description
array	Vardef-format table description

getTablesArray(
          
          )
        
        :
          array | false

Returns an array of tables for this database

Returns

Type	Description
array \| false	an array of with table names, false if no tables found

Details

See: \DBManager::getTablesArray()

getTypeParts(
          string $type
          )
        
        :
          array | bool

inherited

retrieves the different components from the passed column type as it is used in the type mapping and vardefs type format: [([,])]

Inherited from: \DBManager::getTypeParts()

Parameters

Name	Type	Description
$type	string	Column type

Returns

Type	Description
array \| bool	array containing the different components of the passed in type or false in case the type contains illegal characters

getValidDBName(
          string | array $name, bool | string $ensureUnique
              =
              false, string $type
              =
              'column', bool $force
              =
              false
          )
        
        :
          string | array

inherited

Return a version of $proposed that can be used as a column name in any of our supported databases Practically this means no longer than 25 characters as the smallest identifier length for our supported DBs is 30 chars for Oracle plus we add on at least four characters in some places (for indicies for example)

Inherited from: \DBManager::getValidDBName()

Parameters

Name	Type	Description
$name	string \| array	Proposed name for the column
$ensureUnique	bool \| string	Ensure the name is unique
$type	string	Name type (table, column)
$force	bool	Force new name

Returns

Type	Description
string \| array	Valid column name trimmed to right length and with invalid characters removed

getWhereClause(
          \SugarBean $bean, array $whereArray
              =
              array()
          )
        
        :
          string

inherited

This method returns a complete where clause built from the where values specified.

Inherited from: \DBManager::getWhereClause()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean that describes the table
$whereArray	array	Optional, where conditions in an array

Returns

Type	Description
string

get_columns(
          string $tablename
          )
        
        :
          array

Get list of DB column definitions

return will is a multi-dimensional array that categorizes the index definition by types, unique, primary and index.

 array (
          'name'   => 'field1',
          'type'   => 'varchar',
          'len' => '200'
          )
      )
?>

This format is similar to how indicies are defined in vardef file.

Parameters

Name	Type	Description
$tablename	string

Returns

Type	Description
array

get_indices(
          string $tablename,  $indexname
              =
              null
          )
        
        :
          array

Returns definitions of all indies for passed table.

return will is a multi-dimensional array that categorizes the index definition by types, unique, primary and index.

 array (
          'name'   => 'index1',
          'type'   => 'primary',
          'fields' => array('field1','field2')
          )
      )
?>

This format is similar to how indicies are defined in vardef file.

Parameters

Name	Type	Description
$tablename	string
$indexname

Returns

Type	Description
array

Details

See: \DBManager::get_indices()

hasLimit(
          string $sql
          )
        
        :
          bool

inherited

Inherited from: \DBManager::hasLimit()

Parameters

Name	Type	Description
$sql	string

Returns

Type	Description
bool

Details

Abstract: Check if query has LIMIT clause Relevant for now only for Mysql

insert(
          \SugarBean $bean
          )
        
        :
          bool

Implements a generic insert for any bean.

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance

Returns

Type	Description
bool	query result

Details

See: \DBManager::insert()

insertParams(
          string $table, array $field_defs, array $data, array $field_map
              =
              null, bool $execute
              =
              true
          )
        
        :
          bool

TODO: may want to join it with Altlobexecute (non-PHPdoc)

Parameters

Name	Type	Description
$table	string	Table name
$field_defs	array	Definitions in vardef-like format
$data	array	Key/value to insert
$field_map	array	Fields map from SugarBean
$execute	bool	Execute or return query?

Returns

Type	Description
bool	query result

Details

See: \DBManager::insertParams()

insertSQL(
          \SugarBean $bean
          )
        
        :
          string

inherited

Generates SQL for insert statement.

Inherited from: \DBManager::insertSQL()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance

Returns

Type	Description
string	SQL Create Table statement

installConfig(
          
          )
        
        :
          array

Get install configuration for this DB

Returns

Type	Description
array

isBooleanType(
          string $type
          )
        
        :
          bool

inherited

Check if type is boolean

Inherited from: \DBManager::isBooleanType()

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
bool

isDatabaseNameValid(
          string $name
          )
        
        :
          bool

Check if this DB name is valid

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool

isExpress(
          
          )
        
        :
          bool

Check if we're running Oracle Express edition

Returns

Type	Description
bool

isFieldArray(
          mixed $defArray
          )
        
        :
          bool

inherited

Checks to see if passed array is truely an array of defitions

Inherited from: \DBManager::isFieldArray()

Such an array may have type as a key but it will point to an array for a true array of definitions an to a col type for a definition only

Parameters

Name	Type	Description
$defArray	mixed

Returns

Type	Description
bool

isNullable(
          array $vardef
          )
        
        :
          bool

Can this field be null? Auto-increment and ID fields can not be null

Parameters

Name	Type	Description
$vardef	array

Returns

Type	Description
bool

isNumericType(
          string $type
          )
        
        :
          bool

inherited

Check if type is a number

Inherited from: \DBManager::isNumericType()

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
bool

isSelect(
          string $query
          )
        
        :
          bool

inherited

Check if the query is a select query

Inherited from: \DBManager::isSelect()

Parameters

Name	Type	Description
$query	string

Returns

Type	Description
bool	Is query SELECT?

isTextType(
          string $type
          )
        
        :
          bool

Does this type represent text (i.e., non-varchar) value?

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
bool

lastDbError(
          
          )
        
        :
          string | false

(non-PHPdoc)

Returns

Type	Description
string \| false	Error message or false if no error happened

Details

See: \DBManager::lastDbError()

lastError(
          
          )
        
        :
          string

inherited

Return DB error message for the last query executed

Inherited from: \DBManager::lastError()

Returns

Type	Description
string	Last error message

limitQuery(
          string $sql, int $start, int $count, boolean $dieOnError
              =
              false, string $msg
              =
              '', bool $execute
              =
              true
          )
        
        :
          resource

Runs a limit query: one where we specify where to start getting records and how many to get

Parameters

Name	Type	Description
$sql	string
$start	int
$count	int
$dieOnError	boolean
$msg	string
$execute	bool	optional, false if we just want to return the query

Returns

Type	Description
resource	query result

limitQuerySql(
          string $sql, int $start, int $count, bool $dieOnError
              =
              false, string $msg
              =
              ''
          )
        
        :
          resource | bool

inherited

Return limit query based on given query

Inherited from: \DBManager::limitQuerySql()

Parameters

Name	Type	Description
$sql	string
$start	int
$count	int
$dieOnError	bool
$msg	string

Returns

Type	Description
resource \| bool	query result

Details

See: \DBManager::limitQuery()

massageFieldDef(
          array $fieldDef, string $tablename
          )
        
        :
          array

Massages the field defintions to fill in anything else the DB backend may add

Parameters

Name	Type	Description
$fieldDef	array
$tablename	string

Returns

Type	Description
array

Details

See: \DBManager::massageFieldDef()

massageValue(
          mixed $val, array $fieldDef
          )
        
        :
          mixed

Outputs a correct string for the sql statement according to value

Parameters

Name	Type	Description
$val	mixed
$fieldDef	array	field definition

Returns

Type	Description
mixed

Details

See: \DBManager::massageValue()

modifyIndexes(
          string $tablename, array $indexes, bool $execute
              =
              true
          )
        
        :
          string

inherited

Modifies indexes

Inherited from: \DBManager::modifyIndexes()

Parameters

Name	Type	Description
$tablename	string
$indexes	array	indexes to modify
$execute	bool	true if we want to execute the returned sql statement

Returns

Type	Description
string	SQL statement

inherited

Return current time in format fit for insertion into DB (with quotes)

Inherited from: \DBManager::now()

Returns

Type	Description
string

number_of_columns(
          string $table_name
          )
        
        :
          int

inherited

Returns the number of columns in a table

Inherited from: \DBManager::number_of_columns()

Parameters

Name	Type	Description
$table_name	string

Returns

Type	Description
int

ociFetchRow(
          resource $result
          )
        
        :
          array

Fetches the next row from the result set

Parameters

Name	Type	Description
$result	resource	result set

Returns

Type	Description
array

oneColumnSQLRep(
          array $fieldDef, bool $ignoreRequired
              =
              false, string $table
              =
              '', bool $return_as_array
              =
              false
          )
        
        :
          string

Returns the defintion for a single column

Parameters

Name	Type	Description
$fieldDef	array	Vardef-format field def
$ignoreRequired	bool	Optional, true if we should ignore this being a required field
$table	string	Optional, table name
$return_as_array	bool	Optional, true if we should return the result as an array instead of sql

Returns

Type	Description
string	or array if $return_as_array is true

Details

See: \DBManager::oneColumnSQLRep()

orderByEnum(
          string $order_by, array $values, string $order_dir
          )
        
        :
          string

(non-PHPdoc)

Parameters

Name	Type	Description
$order_by	string	Field name
$values	array	Possible enum value
$order_dir	string	Order direction, ASC or DESC

Returns

Type	Description
string

Details

See: \DBManager::orderByEnum()

pQuery(
          string $sql, array $data
              =
              array()
          )
        
        :
          resource

inherited

Run both prepare and execute without the client having to run both individually.

Inherited from: \DBManager::pQuery()

Parameters

Name	Type	Description
$sql	string	The sql to parse
$data	array	The array of data to replace the tokens with.

Returns

Type	Description
resource	result set or false on error

parseFulltextQuery(
          string $query
          )
        
        :
          array

inherited

Parse fulltext search query with mysql syntax: terms quoted by "" + means the term must be included - means the term must be excluded * or % at the end means wildcard

Inherited from: \DBManager::parseFulltextQuery()

Parameters

Name	Type	Description
$query	string

Returns

Type	Description
array	of 3 elements - query terms, mandatory terms and excluded terms

postInstall(
          
          )
        
        :
          void

inherited

Inherited from: \DBManager::postInstall()

Details

Abstract: Code run on new database after installing

preInstall(
          
          )
        
        :
          void

inherited

Inherited from: \DBManager::preInstall()

Details

Abstract: Code run on new database before installing

prepareQuery(
          string $sql
          )
        
        :
          int

inherited

Given a sql stmt attempt to parse it into the sql and the tokens. Then return the index of this prepared statement Tokens can come in the following forms: ? - a scalar which will be quoted ! - a literal which will not be quoted & - binary data to read from a file

Inherited from: \DBManager::prepareQuery()

Parameters

Name	Type	Description
$sql	string	The sql to parse

Returns

Type	Description
int	index of the prepared statement to be used with execute

query(
          string $sql, bool $dieOnError
              =
              false, string $msg
              =
              '', bool $suppress
              =
              false, bool $keepResult
              =
              false
          )
        
        :
          resource

Parses and runs queries

Parameters

Name	Type	Description
$sql	string	SQL Statement to execute
$dieOnError	bool	True if we want to call die if the query returns errors
$msg	string	Message to log if error occurs
$suppress	bool	Flag to suppress all error output unless in debug logging mode.
$keepResult	bool	True if we want to push this result into the $lastResult var.

Returns

Type	Description
resource	result set

queryArray(
          array $sqls, bool $dieOnError
              =
              false, string $msg
              =
              '', bool $suppress
              =
              false
          )
        
        :
          resource | bool

inherited

Execute multiple queries one after another

Inherited from: \DBManager::queryArray()

Parameters

Name	Type	Description
$sqls	array	Queries
$dieOnError	bool	Die on error, passed to query()
$msg	string	Error message, passed to query()
$suppress	bool	Supress errors, passed to query()

Returns

Type	Description
resource \| bool	result set or success/failure bool

quote(
          string $string
          )
        
        :
          string

Quote string in DB-specific manner

Parameters

Name	Type	Description
$string	string

Returns

Type	Description
string

Details

See: \DBManager::quote()

quoteFormEmail(
          string $string
          )
        
        :
          string

inherited

Quotes a string for storing in the database

Inherited from: \DBManager::quoteFormEmail()

Parameters

Name	Type	Description
$string	string

Returns

Type	Description
string

quoteTerm(
          string $term
          )
        
        :
          string

Quote Oracle search term

Parameters

Name	Type	Description
$term	string

Returns

Type	Description
string

quoteType(
          string $type, string $value
          )
        
        :
          string

inherited

Quote value according to type Numerics aren't quoted Dates are converted and quoted Rest is just quoted

Inherited from: \DBManager::quoteType()

Parameters

Name	Type	Description
$type	string
$value	string

Returns

Type	Description
string	Quoted value

quoted(
          string $string
          )
        
        :
          string

inherited

Return string properly quoted with ''

Inherited from: \DBManager::quoted()

Parameters

Name	Type	Description
$string	string

Returns

Type	Description
string

registerError(
          string $userMessage, string $message, bool $dieOnError
              =
              false
          )
        
        :
          void

inherited

Inherited from: \DBManager::registerError()

Parameters

Name	Type	Description
$userMessage	string	Message from function user
$message	string	Message from SQL driver
$dieOnError	bool

renameColumnSQL(
          string $tablename, string $column, string $newname
          )
        
        :
          void

Rename column in the DB

Parameters

Name	Type	Description
$tablename	string
$column	string
$newname	string

renameIndexDefs(
          array $old_definition, array $new_definition, string $table_name
          )
        
        :
          string

Renames an index using fields definition

Parameters

Name	Type	Description
$old_definition	array
$new_definition	array
$table_name	string

Returns

Type	Description
string	SQL statement

Details

See: \DBManager::renameIndexDefs()

repairTable(
          \SugarBean $bean, bool $execute
              =
              true
          )
        
        :
          string

inherited

Implements repair of a db table for a bean.

Inherited from: \DBManager::repairTable()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance
$execute	bool	true if we want the action to take place, false if we just want the sql returned

Returns

Type	Description
string	SQL statement or empty string, depending upon $execute

repairTableParams(
          string $tablename, array $fielddefs, array $indices, bool $execute
              =
              true, string $engine
              =
              null
          )
        
        :
          string

Builds the SQL commands that repair a table structure

Parameters

Name	Type	Description
$tablename	string
$fielddefs	array	Field definitions, in vardef format
$indices	array	Index definitions, in vardef format
$execute	bool	optional, true if we want the queries executed instead of returned
$engine	string	optional, MySQL engine

Returns

Type	Description
string

repair_index_name(
          string $index_name
          )
        
        :
          string

Generates an index name for the repair table

If the last character is not an 'r', make it that; else make it '1'

Parameters

Name	Type	Description
$index_name	string

Returns

Type	Description
string

resetQueryCount(
          
          )
        
        :
          void

staticinherited

Resets the queryCount value to 0

Inherited from: \DBManager::resetQueryCount()

retrieve(
          \SugarBean $bean, array $where
              =
              array()
          )
        
        :
          resource

inherited

Implements a generic retrieve for any bean identified by id

Inherited from: \DBManager::retrieve()

If we want to pass multiple values for a name, pass it as an array If where is not passed, it defaults to id of table

Parameters

Name	Type	Description
$bean	\SugarBean	Sugarbean instance
$where	array	values with the keys as names of fields.

Returns

Type	Description
resource	result from the query

retrieveSQL(
          \SugarBean $bean, array $where
          )
        
        :
          string

inherited

Generates SQL for select statement for any bean identified by id.

Inherited from: \DBManager::retrieveSQL()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance
$where	array	where conditions in an array

Returns

Type	Description
string	SQL Select Statement

retrieveView(
          array $beans, array $cols
              =
              array(), array $where
              =
              array()
          )
        
        :
          resource

inherited

Implements a generic retrieve for a collection of beans.

Inherited from: \DBManager::retrieveView()

These beans will be joined in the sql by the key attribute of field defs. Currently, this function does support outer joins.

Parameters

Name	Type	Description
$beans	array	Sugarbean instance(s)
$cols	array	columns to be returned with the keys as names of bean as identified by get_class of bean. Values of this array is the array of fieldDefs to be returned for a bean. If an empty array is passed, all columns are selected.
$where	array	values with the keys as names of bean as identified by get_class of bean Each value at the first level is an array of values for that bean identified by name of fields. If we want to pass multiple values for a name, pass it as an array If where is not passed, all the rows will be returned.

Returns

Type	Description
resource

retrieveViewSQL(
          array $beans, array $cols
              =
              array(), array $whereClause
              =
              array()
          )
        
        :
          string

inherited

This method implements a generic sql for a collection of beans.

Inherited from: \DBManager::retrieveViewSQL()

Currently, this function does not support outer joins.

Parameters

Name	Type	Description
$beans	array	Array of values returned by get_class method as the keys and a bean as the value for that key. These beans will be joined in the sql by the key attribute of field defs.
$cols	array	Optional, columns to be returned with the keys as names of bean as identified by get_class of bean. Values of this array is the array of fieldDefs to be returned for a bean. If an empty array is passed, all columns are selected.
$whereClause	array	Optional, values with the keys as names of bean as identified by get_class of bean. Each value at the first level is an array of values for that bean identified by name of fields. If we want to pass multiple values for a name, pass it as an array. If where is not passed, all the rows will be returned.

Returns

Type	Description
string	SQL Select Statement

rollback(
          
          )
        
        :
          bool

inherited

Rollsback pending changes to the database when the driver is setup to support transactions.

Inherited from: \DBManager::rollback()

Note that the default implementation is applicable for transaction-less or auto commit scenarios. Since rollbacks cannot be done, this implementation always returns false.

Returns

Type	Description
bool	true if rollback succeeded, false if it failed

Details

Abstract

save_audit_records(
          \SugarBean $bean, array $changes
          )
        
        :
          bool

inherited

Saves changes to module's audit table

Inherited from: \DBManager::save_audit_records()

Parameters

Name	Type	Description
$bean	\SugarBean	Sugarbean instance that was changed
$changes	array	List of changes, contains 'before' and 'after'

Returns

Type	Description
bool	query result

setAutoIncrement(
          string $table, string $field_name
          )
        
        :
          string

Either creates an auto increment through queries or returns sql for auto increment that can be appended to the end of column defination (mysql)

Parameters

Name	Type	Description
$table	string	Table name
$field_name	string	Field name

Returns

Type	Description
string

Details

See: \DBManager::setAutoIncrement()

setAutoIncrementStart(
          string $table, string $field_name,  $start_value
          )
        
        :
          string

Sets the next auto-increment value of a column to a specific value.

Parameters

Name	Type	Description
$table	string	tablename
$field_name	string
$start_value

Returns

Type	Description
string

setDieOnError(
          bool $value
          )
        
        :
          void

inherited

Sets the dieOnError value

Inherited from: \DBManager::setDieOnError()

Parameters

Name	Type	Description
$value	bool

setOptions(
          array $options
          )
        
        :
          \DBManager

inherited

Set database options Options are usually db-dependant and derive from $config['dbconfigoption']

Inherited from: \DBManager::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\DBManager

setQueryLimit(
          int $limit
          )
        
        :
          void

staticinherited

This function sets the query threshold limit

Inherited from: \DBManager::setQueryLimit()

Parameters

Name	Type	Description
$limit	int	value of query threshold limit

splitType(
          string $type
          )
        
        :
          array

Split column type into components type proper, length and scale

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
array

supports(
          string $cap
          )
        
        :
          bool

inherited

Check if this DB supports certain capability See $this->capabilities for the list

Inherited from: \DBManager::supports()

Parameters

Name	Type	Description
$cap	string

Returns

Type	Description
bool

tableExists(
          string $tableName
          )
        
        :
          bool

Checks if a table with the name $tableName exists and returns true if it does or false otherwise

Parameters

Name	Type	Description
$tableName	string

Returns

Type	Description
bool

Details

See: \DBManager::tableExists()

tablesLike(
          \$like $like
          )
        
        :
          array

Get tables like expression

Parameters

Name	Type	Description
$like	\$like	string

Returns

Type	Description
array

track_slow_queries(
          string $query
          )
        
        :
          void

inherited

Tracks slow queries in the tracker database table

Inherited from: \DBManager::track_slow_queries()

Parameters

Name	Type	Description
$query	string	value of query to track

truncate(
          string $string, int $len
          )
        
        :
          string

inherited

Truncates a string to a given length

Inherited from: \DBManager::truncate()

Parameters

Name	Type	Description
$string	string
$len	int	length to trim to

Returns

Type	Description
string

truncateTableSQL(
           $name
          )
        
        :
          string

Truncate table

Parameters

Name	Type	Description
$name

Returns

Type	Description
string

update(
          \SugarBean $bean, array $where
              =
              array()
          )
        
        :
          bool

Implements a generic update for any bean

Parameters

Name	Type	Description
$bean	\SugarBean	Sugarbean instance
$where	array	values with the keys as names of fields. If we want to pass multiple values for a name, pass it as an array If where is not passed, it defaults to id of table

Returns

Type	Description
bool	query result

Details

See: \DBManager::update()

updateSQL(
          \SugarBean $bean, array $where
              =
              array()
          )
        
        :
          string

inherited

Generates SQL for update statement.

Inherited from: \DBManager::updateSQL()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance
$where	array	Optional, where conditions in an array

Returns

Type	Description
string	SQL Create Table statement

updateWhereArray(
          \SugarBean $bean, array $where
              =
              array()
          )
        
        :
          array

inherited

This method returns a where array so that it has id entry if where is not an array or is empty

Inherited from: \DBManager::updateWhereArray()

Parameters

Name	Type	Description
$bean	\SugarBean	SugarBean instance
$where	array	Optional, where conditions in an array

Returns

Type	Description
array

userExists(
          string $dbname
          )
        
        :
          void

Check if certain database exists

Parameters

Name	Type	Description
$dbname	string

Check if this driver can be used

Returns

Type	Description
bool

validColumnType(
          string $type
          )
        
        :
          bool

inherited

returns true if the type can be mapped to a valid column type

Inherited from: \DBManager::validColumnType()

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
bool

validateQuery(
          string $query
          )
        
        :
          bool

Check if this query is valid Validates only SELECT queries

Parameters

Name	Type	Description
$query	string

Returns

Type	Description
bool

verifyCreateTable(
          string $table, string $query
          )
        
        :
          string

inherited

Tests an CREATE TABLE query

Inherited from: \DBManager::verifyCreateTable()

Parameters

Name	Type	Description
$table	string	The table name to get DDL
$query	string	The query to test.

Returns

Type	Description
string	Non-empty if error found

verifyDeleteFrom(
          string $table, string $query
          )
        
        :
          string

Tests an DELETE FROM query

Parameters

Name	Type	Description
$table	string	table The table name to get DDL
$query	string	query The query to test.

Returns

Type	Description
string	Non-empty if error found

verifyGenericQueryRollback(
          \$type $type, \$table $table, \$query $query
          )
        
        :
          string | bool

Execute data manipulation statement, then roll it back

Parameters

Name	Type	Description
$type	\$type	Statement type
$table	\$table	Table name
$query	\$query	Query to validate

Returns

Type	Description
string \| bool	String will be not empty if there's any

verifyInsertInto(
          string $table, string $query
          )
        
        :
          string

Tests an INSERT INTO query

Parameters

Name	Type	Description
$table	string	table The table name to get DDL
$query	string	query The query to test.

Returns

Type	Description
string	Non-empty if error found

verifySQLStatement(
          string $query, array $skipTables
          )
        
        :
          string

inherited

Verify SQl statement using per-DB verification function provided the function exists

Inherited from: \DBManager::verifySQLStatement()

Parameters

Name	Type	Description
$query	string	Query to verify
$skipTables	array	List of blacklisted tables that aren't checked

Returns

Type	Description
string

verifyUpdate(
          string $table, string $query
          )
        
        :
          string

Tests an UPDATE query

Parameters

Name	Type	Description
$table	string	table The table name to get DDL
$query	string	query The query to test.

Returns

Type	Description
string	Non-empty if error found

version(
          
          )
        
        :
          string

Return's the version of the database

Returns

Type	Description
string

Details

See: \DBManager::version()

include/database/OracleManager.php

\OracleManagerjump to top

Properties

Methods

\OracleManager
jump to top