MDB2_Schema
[ class tree: MDB2_Schema ] [ index: MDB2_Schema ] [ all elements ]
Packages:
MDB2_Schema
MDB2


Classes:
MDB2_Schema
MDB2_Schema_Error
MDB2_Schema_Parser
MDB2_Schema_Writer
Files:
ibase.php
mssql.php
mysql.php
oci8.php
Parser.php
pgsql.php
Schema.php
Writer.php

Class: MDB2_Schema

Source Location: /MDB2_Schema-0.6.0/MDB2/Schema.php

Class Overview

PEAR
   |
   --MDB2_Schema

The database manager is a class that provides a set of database management services like installing, altering and dumping the data structures of databases.


Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 78]
The database manager is a class that provides a set of database management services like installing, altering and dumping the data structures of databases.


[ Top ]

Class Variables

$db =

[line 82]


Type:   mixed


[ Top ]

$options = array(
        'fail_on_invalid_names' => true,
        'dtd_file' => false,
        'valid_types' => array(),'force_defaults'=>true,'parser'=>'MDB2_Schema_Parser','writer'=>'MDB2_Schema_Writer',)

[line 86]


Type:   mixed


[ Top ]

$warnings = array()

[line 84]


Type:   mixed


[ Top ]


Method Detail

alterDatabase   [line 1599]

bool|MDB2_Error alterDatabase( array $current_definition, array $previous_definition, array $changes)

Execute the necessary actions to implement the requested changes in a database structure.
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

array   $current_definition   —  multi dimensional array that contains the current definition
array   $previous_definition   —  multi dimensional array that contains the previous definition
array   $changes   —  associative array that contains the definition of the changes that are meant to be applied to the database structure.

[ Top ]

alterDatabaseIndexes   [line 1395]

bool|MDB2_Error alterDatabaseIndexes( string $table_name, array $changes)

Execute the necessary actions to implement the requested changes in the indexes inside a database structure.
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

string   $table_name   —  name of the table
array   $changes   —  associative array that contains the definition of the changes that are meant to be applied to the database structure.

[ Top ]

alterDatabaseSequences   [line 1541]

bool|MDB2_Error alterDatabaseSequences( array $current_definition, array $previous_definition, array $changes)

Execute the necessary actions to implement the requested changes in the sequences inside a database structure.
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

array   $current_definition   —  multi dimensional array that contains the current definition
array   $previous_definition   —  multi dimensional array that contains the previous definition
array   $changes   —  associative array that contains the definition of the changes that are meant to be applied to the database structure.

[ Top ]

alterDatabaseTables   [line 1467]

bool|MDB2_Error alterDatabaseTables( array $current_definition, array $previous_definition, array $changes)

Execute the necessary actions to implement the requested changes in the tables inside a database structure.
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

array   $current_definition   —  multi dimensional array that contains the current definition
array   $previous_definition   —  multi dimensional array that contains the previous definition
array   $changes   —  associative array that contains the definition of the changes that are meant to be applied to the database structure.

[ Top ]

apiVersion   [line 104]

string apiVersion( )

Return the MDB2 API version
  • Return: the MDB2 API version number
  • Access: public

[ Top ]

arrayMergeClobber   [line 119]

array|false arrayMergeClobber( array $a1, array $a2)

Clobbers two arrays together.
  • Return: array on success and false on error
  • Author: kc@hireability.com
  • Access: public

Parameters:

array   $a1   —  array that should be clobbered
array   $a2   —  array that should be clobbered

[ Top ]

compareDefinitions   [line 933]

array|MDB2_Error compareDefinitions( array $current_definition, array $previous_definition)

Compare a previous definition with the currently parsed definition
  • Return: array of changes on success, or a error object
  • Access: public

Parameters:

array   $current_definition   —  multi dimensional array that contains the current definition
array   $previous_definition   —  multi dimensional array that contains the previous definition

[ Top ]

compareSequenceDefinitions   [line 1262]

array|MDB2_Error compareSequenceDefinitions( string $sequence_name, array $current_definition, array $previous_definition, array &$defined_sequences)

Compare a previous definition with the currently parsed definition
  • Return: array of changes on success, or a error object
  • Access: public

Parameters:

string   $sequence_name   —  name of the sequence
array   $current_definition   —  multi dimensional array that contains the current definition
array   $previous_definition   —  multi dimensional array that contains the previous definition
array   &$defined_sequences   — 

[ Top ]

compareTableDefinitions   [line 1166]

array|MDB2_Error compareTableDefinitions( string $table_name, array $current_definition, array $previous_definition, array &$defined_tables)

Compare a previous definition with the currently parsed definition
  • Return: array of changes on success, or a error object
  • Access: public

Parameters:

string   $table_name   —  name of the table
array   $current_definition   —  multi dimensional array that contains the current definition
array   $previous_definition   —  multi dimensional array that contains the previous definition
array   &$defined_tables   — 

[ Top ]

compareTableFieldsDefinitions   [line 1004]

array|MDB2_Error compareTableFieldsDefinitions( string $table_name, array $current_definition, array $previous_definition, array &$defined_fields)

Compare a previous definition with the currently parsed definition
  • Return: array of changes on success, or a error object
  • Access: public

Parameters:

string   $table_name   —  name of the table
array   $current_definition   —  multi dimensional array that contains the current definition
array   $previous_definition   —  multi dimensional array that contains the previous definition
array   &$defined_fields   — 

[ Top ]

compareTableIndexesDefinitions   [line 1070]

array|MDB2_Error compareTableIndexesDefinitions( string $table_name, array $current_definition, array $previous_definition, array &$defined_indexes)

Compare a previous definition with the currently parsed definition
  • Return: array of changes on success, or a error object
  • Access: public

Parameters:

string   $table_name   —  name of the table
array   $current_definition   —  multi dimensional array that contains the current definition
array   $previous_definition   —  multi dimensional array that contains the previous definition
array   &$defined_indexes   — 

[ Top ]

connect   [line 252]

bool|MDB2_Error connect( string|array|MDB2_Driver_Common &$db, [array $options = array()])

Create a new MDB2 connection object and connect to the specified database
  • Return: MDB2_OK or error object
  • See: MDB2::parseDSN method for a description of the dsn format. Can also be specified as an array of the format returned by @see MDB2::parseDSN. Finally you can also pass an existing db object to be used.
  • See: MDB2::parseDSN
  • Access: public

Parameters:

string|array|MDB2_Driver_Common   &$db   —  'data source name', see the
array   $options   —  An associative array of option names and their values.

[ Top ]

createDatabase   [line 818]

bool|MDB2_Error createDatabase( array $database_definition)

Create a database space within which may be created database objects

like tables, indexes and sequences. The implementation of this function is highly DBMS specific and may require special permissions to run successfully. Consult the documentation or the DBMS drivers that you use to be aware of eventual configuration requirements.

  • Return: MDB2_OK or error object
  • Access: public

Parameters:

array   $database_definition   —  multi dimensional array that contains the current definition

[ Top ]

createSequence   [line 733]

bool|MDB2_Error createSequence( string $sequence_name, array $sequence, [bool $overwrite = false])

Create a sequence
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

string   $sequence_name   —  name of the sequence to be created
array   $sequence   —  multi dimensional array that contains the structure and optional data of the table
bool   $overwrite   —  if the sequence should be overwritten if it already exists

[ Top ]

createTable   [line 631]

bool|MDB2_Error createTable( string $table_name, array $table, [bool $overwrite = false])

Create a table and inititialize the table if data is available
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

string   $table_name   —  name of the table to be created
array   $table   —  multi dimensional array that contains the structure and optional data of the table
bool   $overwrite   —  if the table/index should be overwritten if it already exists

[ Top ]

createTableIndexes   [line 542]

bool|MDB2_Error createTableIndexes( string $table_name, array $indexes, [bool $overwrite = false])

Create indexes on a table
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

string   $table_name   —  name of the table
array   $indexes   —  indexes to be created
bool   $overwrite   —  if the table/index should be overwritten if it already exists

[ Top ]

disconnect   [line 295]

void disconnect( )

Log out and disconnect from the database.
  • Access: public

[ Top ]

dumpDatabase   [line 1843]

bool|MDB2_Error dumpDatabase( array $database_definition, array $arguments, [int $dump = MDB2_SCHEMA_DUMP_ALL])

Dump a previously parsed database structure in the Metabase schema XML based format suitable for the Metabase parser. This function may optionally dump the database definition with initialization commands that specify the data that is currently present in the tables.
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

array   $database_definition   —  multi dimensional array that contains the current definition
array   $arguments   —  associative array that takes pairs of tag names and values that define dump options. 
array (
                     'output_mode'    =>    String
                         'file' :   dump into a file
                         default:   dump using a function
                     'output'        =>    String
                         depending on the 'Output_Mode'
                                  name of the file
                                  name of the function
                     'end_of_line'        =>    String
                         end of line delimiter that should be used
                         default: "\n"
                 );
int   $dump   —  that determines what data to dump
  • MDB2_SCHEMA_DUMP_ALL : the entire db
  • MDB2_SCHEMA_DUMP_STRUCTURE : only the structure of the db
  • MDB2_SCHEMA_DUMP_CONTENT : only the content of the db

[ Top ]

dumpDatabaseChanges   [line 1670]

bool|MDB2_Error dumpDatabaseChanges( array $changes)

Dump the changes between two database definitions.
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

array   $changes   —  associative array that specifies the list of database definitions changes as returned by the _compareDefinitions manager class function.

[ Top ]

errorMessage   [line 2082]

string errorMessage( [int|array $value = null])

Return a textual error message for a MDB2 error code
  • Return: error message, or false if the error code was not recognized
  • Access: public

Parameters:

int|array   $value   —  integer error code, 
  1. null
    2.
to get the current error code-message map, or an array with a new error code-message map

[ Top ]

factory   [line 225]

bool|MDB2_Error &factory( string|array|MDB2_Driver_Common &$db, [array $options = array()])

Create a new MDB2 object for the specified database type type
  • Return: MDB2_OK or error object
  • See: MDB2::parseDSN method for a description of the dsn format. Can also be specified as an array of the format returned by @see MDB2::parseDSN. Finally you can also pass an existing db object to be used.
  • See: MDB2::parseDSN
  • Access: public

Parameters:

string|array|MDB2_Driver_Common   &$db   —  'data source name', see the
array   $options   —  An associative array of option names and their values.

[ Top ]

getDefinitionFromDatabase   [line 401]

array|MDB2_Error getDefinitionFromDatabase( )

Attempt to reverse engineer a schema structure from an existing MDB2 This method can be used if no xml schema file exists yet.

The resulting xml schema file may need some manual adjustments.

  • Return: array with definition or error object
  • Access: public

[ Top ]

getOption   [line 199]

mixed getOption( string $option)

returns the value of an option
  • Return: the option value or error object
  • Access: public

Parameters:

string   $option   —  option name

[ Top ]

getWarnings   [line 159]

array getWarnings( )

Get all warnings in reverse order.

This means that the last warning is the first element in the array


[ Top ]

initializeTable   [line 691]

bool|MDB2_Error initializeTable( string $table_name, array $table)

Inititialize the table with data
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

string   $table_name   —  name of the table
array   $table   —  multi dimensional array that contains the structure and optional data of the table

[ Top ]

isError   [line 2153]

bool isError( mixed $data, [int $code = null])

Tell whether a value is an MDB2_Schema error.
  • Return: true if parameter is an error
  • Access: public

Parameters:

mixed   $data   —  the value to test
int   $code   —  if $data is an error object, return true only if $code is $code is an integer and $db->getCode() == $code

[ Top ]

parseDatabaseDefinition   [line 318]

void parseDatabaseDefinition( string|array $schema, [bool $skip_unreadable = false], [array $variables = array()], [bool $fail_on_invalid_names = true], [array $structure = false])

Parse a database definition from a file or an array
  • Access: public

Parameters:

string|array   $schema   —  the database schema array or file name
bool   $skip_unreadable   —  if non readable files should be skipped
array   $variables   —  associative array that the defines the text string values that are meant to be used to replace the variables that are used in the schema description.
bool   $fail_on_invalid_names   —  make function fail on invalid names
array   $structure   —  database structure definition

[ Top ]

parseDatabaseDefinitionFile   [line 355]

void parseDatabaseDefinitionFile( string $input_file, [array $variables = array()], [bool $fail_on_invalid_names = true], [array $structure = false])

Parse a database definition file by creating a schema format parser object and passing the file contents as parser input data stream.
  • Access: public

Parameters:

string   $input_file   —  the database schema file.
array   $variables   —  associative array that the defines the text string values that are meant to be used to replace the variables that are used in the schema description.
bool   $fail_on_invalid_names   —  make function fail on invalid names
array   $structure   —  database structure definition

[ Top ]

raiseError   [line 2134]

object a &raiseError( [int|PEAR_Error $code = null], [int $mode = null], [array $options = null], [string $userinfo = null])

This method is used to communicate an error and invoke error callbacks etc. Basically a wrapper for PEAR::raiseError without the message string.
  • Return: PEAR error object
  • See: PEAR_Error
  • Access: public

Parameters:

int|PEAR_Error   $code   —  integer error code or and PEAR_Error instance
int   $mode   — 

error mode, see PEAR_Error docs

error level (E_USER_NOTICE etc). If error mode is PEAR_ERROR_CALLBACK, this is the callback function, either as a function name, or as an array of an object and method name. For other error modes this parameter is ignored.
array   $options   —  Options, depending on the mode, @see PEAR::setErrorHandling
string   $userinfo   —  Extra debug information. Defaults to the last query and native error code.

[ Top ]

resetWarnings   [line 142]

void resetWarnings( )

reset the warning array
  • Access: public

[ Top ]

setOption   [line 175]

bool|MDB2_Error setOption( string $option, mixed $value)

set the option for the db class
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

string   $option   —  option name
mixed   $value   —  value for the option

[ Top ]

updateDatabase   [line 1995]

bool|MDB2_Error updateDatabase( string|array $current_schema, [string|array $previous_schema = false], [array $variables = array()], [bool $disable_query = false])

Compare the correspondent files of two versions of a database schema definition: the previously installed and the one that defines the schema that is meant to update the database.

If the specified previous definition file does not exist, this function will create the database from the definition specified in the current schema file. If both files exist, the function assumes that the database was previously installed based on the previous schema file and will update it by just applying the changes. If this function succeeds, the contents of the current schema file are copied to replace the previous schema file contents. Any subsequent schema changes should only be done on the file specified by the $current_schema_file to let this function make a consistent evaluation of the exact changes that need to be applied.

  • Return: MDB2_OK or error object
  • Access: public

Parameters:

string|array   $current_schema   —  filename or array of the updated database schema definition.
string|array   $previous_schema   —  filename or array of the previously installed database schema definition.
array   $variables   —  associative array that is passed to the argument of the same name to the parseDatabaseDefinitionFile function. (there third param)
bool   $disable_query   —  determines if the disable_query option should be set to true for the alterDatabase() or createDatabase() call

[ Top ]

verifyAlterDatabase   [line 1328]

bool|MDB2_Error verifyAlterDatabase( array $changes)

Verify that the changes requested are supported
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

array   $changes   —  associative array that contains the definition of the changes that are meant to be applied to the database structure.

[ Top ]

writeInitialization   [line 1904]

bool|MDB2_Error writeInitialization( string|array $data, [string|array $structure = false], [array $variables = array()])

Write initialization and sequences
  • Return: MDB2_OK or error object
  • Access: public

Parameters:

string|array   $data   —  data file or data array
string|array   $structure   —  structure file or array
array   $variables   —  associative array that is passed to the argument of the same name to the parseDatabaseDefinitionFile function. (there third param)

[ Top ]
Documentation generated on Mon, 11 Mar 2019 14:42:29 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.