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


Classes:
MDB2_BufferedResult_mssql
MDB2_Driver_Datatype_mssql
MDB2_Driver_Function_mssql
MDB2_Driver_Manager_mssql
MDB2_Driver_mssql
MDB2_Driver_Native_mssql
MDB2_Driver_Reverse_mssql
MDB2_Result_mssql
MDB2_Statement_mssql
Files:
mssql.php
mssql.php
mssql.php
mssql.php
mssql.php
mssql.php

Class: MDB2_Driver_Manager_mssql

Source Location: /MDB2_Driver_mssql-1.1.2/MDB2/Driver/Manager/mssql.php

Class Overview

MDB2_Driver_Manager_Common
   |
   --MDB2_Driver_Manager_mssql

MDB2 MSSQL driver for the management modules


Author(s):

Methods

Inherited Variables

Inherited Methods

Class Details

[line 60]
MDB2 MSSQL driver for the management modules


[ Top ]

Method Detail

alterTable   [line 201]

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 MDB2 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 MDB2 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 70]

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 481]

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 97]

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 ]

dropIndex   [line 458]

mixed dropIndex( string $table, string $name)

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

Parameters:

string   $table   —  name of table that should be used in method
string   $name   —  name of the index to be dropped

[ Top ]

dropSequence   [line 531]

mixed dropSequence( string $seq_name)

This function drops an 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 ]

listSequences   [line 551]

mixed listSequences( )

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

[ Top ]

listTableFields   [line 302]

mixed listTableFields( string $table)

list all fields in a table in the current database
  • Return: array of field names on success, a MDB2 error on failure
  • Access: public

Parameters:

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

[ Top ]

listTableIndexes   [line 333]

mixed listTableIndexes( string $table)

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

Parameters:

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

[ Top ]

listTables   [line 266]

mixed listTables( )

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

[ Top ]

listTableTriggers   [line 385]

mixed listTableTriggers( [string $table = null])

list all triggers in the database that reference a given table
  • Return: array of trigger names on success, otherwise, false which could be a db error if the db is not instantiated or could be the results of the error that occured during the querying of the sysobject module.
  • Access: public

Parameters:

string   $table   —  table for which all referenced triggers should be found

[ Top ]

listViews   [line 422]

mixed listViews( string 0)

list all views in the current database
  • Return: array of view names on success, a MDB2 error on failure
  • Access: public

Parameters:

string   0   —  database, the current is default

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