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


Classes:
MDB2_BufferedResult_pgsql
MDB2_Driver_Datatype_pgsql
MDB2_Driver_Function_pgsql
MDB2_Driver_Manager_pgsql
MDB2_Driver_Native_pgsql
MDB2_Driver_pgsql
MDB2_Driver_Reverse_pgsql
MDB2_Result_pgsql
MDB2_Statement_pgsql
Files:
pgsql.php
pgsql.php
pgsql.php
pgsql.php
pgsql.php
pgsql.php

Class: MDB2_Driver_Manager_pgsql

Source Location: /MDB2_Driver_pgsql-1.2.2/MDB2/Driver/Manager/pgsql.php

Class Overview

MDB2_Driver_Manager_Common
   |
   --MDB2_Driver_Manager_pgsql

MDB2 MySQL driver for the management modules


Author(s):

Methods

Inherited Variables

Inherited Methods

Class Details

[line 56]
MDB2 MySQL driver for the management modules


[ Top ]

Method Detail

alterTable   [line 192]

mixed alterTable( string $name, array $changes, boolean $check)

alter an existing table
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $name   —  name of the table that is intended to be changed.
array   $changes   — 

associative array that contains the details of each type of change that is intended to be performed. The types of changes that are currently supported are defined as follows:

name

New name for the table.

add

Associative array with the names of fields to be added as indexes of the array. The value of each entry of the array should be set to another associative array with the properties of the fields to be added. The properties of the fields should be the same as defined by the Metabase parser.

remove

Associative array with the names of fields to be removed as indexes of the array. Currently the values assigned to each entry are ignored. An empty array should be used for future compatibility.

rename

Associative array with the names of fields to be renamed as indexes of the array. The value of each entry of the array should be set to another associative array with the entry named name with the new field name and the entry named Declaration that is expected to contain the portion of the field declaration already in DBMS specific SQL code as it is used in the CREATE TABLE statement.

change

Associative array with the names of the fields to be changed as indexes of the array. Keep in mind that if it is intended to change either the name of a field and any other properties, the change array entries should have the new names of the fields as array indexes.

The value of each entry of the array should be set to another associative array with the properties of the fields to that are meant to be changed as array entries. These entries should be assigned to the new values of the respective properties. The properties of the fields should be the same as defined by the Metabase parser.

Example array( 'name' => 'userlist', 'add' => array( 'quota' => array( 'type' => 'integer', 'unsigned' => 1 ) ), 'remove' => array( 'file_limit' => array(), 'time_limit' => array() ), 'change' => array( 'name' => array( 'length' => '20', 'definition' => array( 'type' => 'text', 'length' => 20, ), ) ), 'rename' => array( 'sex' => array( 'name' => 'gender', 'definition' => array( 'type' => 'text', 'length' => 1, 'default' => 'M', ), ) ) )
boolean   $check   —  indicates whether the function should just check if the DBMS driver can perform the requested table alterations if the value is true or actually perform them otherwise.

[ Top ]

createDatabase   [line 67]

mixed createDatabase( string $name)

create a new database
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $name   —  name of the database that should be created

[ Top ]

createSequence   [line 620]

mixed createSequence( string $seq_name, [string $start = 1])

create sequence
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $seq_name   —  name of the sequence to be created
string   $start   —  start value of the sequence; default is 1

[ Top ]

dropDatabase   [line 88]

mixed dropDatabase( string $name)

drop an existing database
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $name   —  name of the database that should be dropped

[ Top ]

dropSequence   [line 642]

mixed dropSequence( string $seq_name)

drop existing sequence
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $seq_name   —  name of the sequence to be dropped

[ Top ]

listDatabases   [line 305]

mixed listDatabases( )

list all databases
  • Return: data array on success, a MDB2 error on failure
  • Access: public

[ Top ]

listFunctions   [line 421]

mixed listFunctions( )

list all functions in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

[ Top ]

listSequences   [line 662]

mixed listSequences( )

list all sequences in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

[ Top ]

listTableConstraints   [line 577]

mixed listTableConstraints( string $table)

list all constraints in a table
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $table   —  name of table that should be used in method

[ Top ]

listTableFields   [line 506]

mixed listTableFields( string $table)

list all fields in a tables in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $table   —  name of table that should be used in method

[ Top ]

listTableIndexes   [line 537]

mixed listTableIndexes( string $table)

list all indexes in a table
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $table   —  name of table that should be used in method

[ Top ]

listTables   [line 459]

mixed listTables( )

list all tables in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

[ Top ]

listTableViews   [line 393]

mixed listTableViews( string $table)

list the views in the database that reference a given table
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Parameters:

string   $table   —  table for which all references views should be found

[ Top ]

listUsers   [line 338]

mixed listUsers( )

list all users
  • Return: data array on success, a MDB2 error on failure
  • Access: public

[ Top ]

listViews   [line 365]

mixed listViews( )

list the views in the database
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

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