CI_DB_mssql_forge Class Reference

Inheritance diagram for CI_DB_mssql_forge:

[legend]

Collaboration diagram for CI_DB_mssql_forge:

[legend]

List of all members.

Public Member Functions
	_create_database ($name)
	Create database.
	_drop_database ($name)
	Drop database.
	_drop_table ($table)
	Drop Table.
	_create_table ($table, $fields, $primary_keys, $keys, $if_not_exists)
	Create Table.
	_alter_table ($alter_type, $table, $column_name, $column_definition= '', $default_value= '', $null= '', $after_field= '')
	Alter table query.
	_rename_table ($table_name, $new_table_name)
	Rename a table.

---

Detailed Description

Definition at line 25 of file mssql_forge.php.

---

Member Function Documentation

CI_DB_mssql_forge::_alter_table	(	$	alter_type,
		$	table,
		$	column_name,
		$	column_definition = '',
		$	default_value = '',
		$	null = '',
		$	after_field = ''
	)

Alter table query.

Generates a platform-specific query so that a table can be altered Called by add_column(), drop_column(), and column_alter(),

private

Parameters:

	string	the ALTER type (ADD, DROP, CHANGE)
	string	the column name
	string	the table name
	string	the column definition
	string	the default value
	boolean	should 'NOT NULL' be added
	string	the field after which we should add the new field

Returns:

object

Definition at line 191 of file mssql_forge.php.

        {
                $sql = 'ALTER TABLE '.$this->db->_protect_identifiers($table)." $alter_type ".$this->db->_protect_identifiers($column_name);

                // DROP has everything it needs now.
                if ($alter_type == 'DROP')
                {
                        return $sql;
                }

                $sql .= " $column_definition";

                if ($default_value != '')
                {
                        $sql .= " DEFAULT \"$default_value\"";
                }

                if ($null === NULL)
                {
                        $sql .= ' NULL';
                }
                else
                {
                        $sql .= ' NOT NULL';
                }

                if ($after_field != '')
                {
                        $sql .= ' AFTER ' . $this->db->_protect_identifiers($after_field);
                }
                
                return $sql;
                
        }

CI_DB_mssql_forge::_create_database

(

$

name

)

Create database.

private

Parameters:

string

the database name

Returns:

bool

Definition at line 34 of file mssql_forge.php.

        {
                return "CREATE DATABASE ".$name;
        }

CI_DB_mssql_forge::_create_table	(	$	table,
		$	fields,
		$	primary_keys,
		$	keys,
		$	if_not_exists
	)

Create Table.

private

Parameters:

	string	the table name
	array	the fields
	mixed	primary key(s)
	mixed	key(s)
	boolean	should 'IF NOT EXISTS' be added to the SQL

Returns:

bool

Definition at line 79 of file mssql_forge.php.

References CI_DB_forge::$fields, CI_DB_forge::$keys, and CI_DB_forge::$primary_keys.

        {
                $sql = 'CREATE TABLE ';
                
                if ($if_not_exists === TRUE)
                {
                        $sql .= 'IF NOT EXISTS ';
                }
                
                $sql .= $this->db->_escape_table($table)." (";
                $current_field_count = 0;

                foreach ($fields as $field=>$attributes)
                {
                        // Numeric field names aren't allowed in databases, so if the key is
                        // numeric, we know it was assigned by PHP and the developer manually
                        // entered the field information, so we'll simply add it to the list
                        if (is_numeric($field))
                        {
                                $sql .= "\n\t$attributes";
                        }
                        else
                        {
                                $attributes = array_change_key_case($attributes, CASE_UPPER);
                                
                                $sql .= "\n\t".$this->db->_protect_identifiers($field);
                                
                                $sql .=  ' '.$attributes['TYPE'];
        
                                if (array_key_exists('CONSTRAINT', $attributes))
                                {
                                        $sql .= '('.$attributes['CONSTRAINT'].')';
                                }
        
                                if (array_key_exists('UNSIGNED', $attributes) && $attributes['UNSIGNED'] === TRUE)
                                {
                                        $sql .= ' UNSIGNED';
                                }
        
                                if (array_key_exists('DEFAULT', $attributes))
                                {
                                        $sql .= ' DEFAULT \''.$attributes['DEFAULT'].'\'';
                                }
        
                                if (array_key_exists('NULL', $attributes) && $attributes['NULL'] === TRUE)
                                {
                                        $sql .= ' NULL';
                                }
                                else
                                {
                                        $sql .= ' NOT NULL';                    
                                }
        
                                if (array_key_exists('AUTO_INCREMENT', $attributes) && $attributes['AUTO_INCREMENT'] === TRUE)
                                {
                                        $sql .= ' AUTO_INCREMENT';
                                }
                        }
                        
                        // don't add a comma on the end of the last field
                        if (++$current_field_count < count($fields))
                        {
                                $sql .= ',';
                        }
                }

                if (count($primary_keys) > 0)
                {
                        $primary_keys = $this->db->_protect_identifiers($primary_keys);
                        $sql .= ",\n\tPRIMARY KEY (" . implode(', ', $primary_keys) . ")";
                }
                
                if (is_array($keys) && count($keys) > 0)
                {
                        foreach ($keys as $key)
                        {
                                if (is_array($key))
                                {
                                        $key = $this->db->_protect_identifiers($key);   
                                }
                                else
                                {
                                        $key = array($this->db->_protect_identifiers($key));
                                }
                                
                                $sql .= ",\n\tFOREIGN KEY (" . implode(', ', $key) . ")";
                        }
                }
                
                $sql .= "\n)";

                return $sql;
        }

CI_DB_mssql_forge::_drop_database

(

$

name

)

Drop database.

private

Parameters:

string

the database name

Returns:

bool

Definition at line 48 of file mssql_forge.php.

        {
                return "DROP DATABASE ".$name;
        }

CI_DB_mssql_forge::_drop_table

(

$

table

)

Drop Table.

private

Returns:

bool

Definition at line 61 of file mssql_forge.php.

        {
                return "DROP TABLE ".$this->db->_escape_table($table);
        }

CI_DB_mssql_forge::_rename_table	(	$	table_name,
		$	new_table_name
	)

Rename a table.

Generates a platform-specific query so that a table can be renamed

private

Parameters:

	string	the old table name
	string	the new table name

Returns:

string

Definition at line 238 of file mssql_forge.php.

        {
                // I think this syntax will work, but can find little documentation on renaming tables in MSSQL
                $sql = 'ALTER TABLE '.$this->db->_protect_identifiers($table_name)." RENAME TO ".$this->db->_protect_identifiers($new_table_name);
                return $sql;
        }

---

The documentation for this class was generated from the following file:

• mssql_forge.php