Class CI_DB_utility - echiong/testRepo GitHub Wiki

##Class CI_DB_utility

Database Utility Class

	###Direct known subclasses
		<a href="Class CI_DB_cubrid_utility.md">CI_DB_cubrid_utilityggg</a>, 
		<a href="Class CI_DB_mssql_utility.md">CI_DB_mssql_utilityggg</a>, 
		<a href="Class CI_DB_mysql_utility.md">CI_DB_mysql_utilityggg</a>, 
		<a href="Class CI_DB_mysqli_utility.md">CI_DB_mysqli_utilityggg</a>, 
		<a href="Class CI_DB_oci8_utility.md">CI_DB_oci8_utilityggg</a>, 
		<a href="Class CI_DB_odbc_utility.md">CI_DB_odbc_utilityggg</a>, 
		<a href="Class CI_DB_pdo_utility.md">CI_DB_pdo_utilityggg</a>, 
		<a href="Class CI_DB_postgre_utility.md">CI_DB_postgre_utilityggg</a>, 
		<a href="Class CI_DB_sqlite_utility.md">CI_DB_sqlite_utilityggg</a>, 
		<a href="Class CI_DB_sqlsrv_utility.md">CI_DB_sqlsrv_utilityggg</a>

Category: Database
Author: ExpressionEngine Dev Team
Link: http://codeigniter.com/user_guide/database/
Located at system/database/DB_utility.php

##Methods summary

public __construct ( )

Constructor

Grabs the CI super object instance so we can access it.

###Overrides CI_DB_forge::__construct()

public boolean list_databases ( )

List databases

Returns boolean

public boolean database_exists ( string $database_name )

Determine if a particular database exists

Parameters

$database_name string

Returns boolean

public boolean optimize_table ( string $table_name )

Optimize Table

Parameters

$table_name string
the table name

Returns boolean

public array optimize_database ( )

Optimize Database

Returns array

public boolean repair_table ( string $table_name )

Repair Table

Parameters

$table_name string
the table name

Returns boolean

public string csv_from_result ( object $query, string $delim = ",", string $newline = "\n", string $enclosure = '"' )

Generate CSV from a query result object

Parameters

$query object
The query result object

$delim string
The delimiter - comma by default

$newline string
The newline character - \n by default

$enclosure string
The enclosure - double quote by default

Returns string

public string xml_from_result ( object $query, array $params = array() )

Generate XML data from a query result object

Parameters

$query object
The query result object

$params array
Any preferences

Returns string

public backup ( mixed $params = array() )

Database Backup

Methods inherited from CI_DB_forge

_reset()

add_column()

add_field()

add_key()

create_database()

create_table()

drop_column()

drop_database()

drop_table()

modify_column()

rename_table()

<table class="summary" id="properties">
<caption>Properties summary</caption>
<tr data-order="db" id="$db">
	<td class="attributes"><code>
		public  
		mixed
	</code></td>

	<td class="name">

$db

		<div class="description detailed">
			

		</div>
	</div></td>
</tr>
<tr data-order="data_cache" id="$data_cache">
	<td class="attributes"><code>
		public  
		array
	</code></td>

	<td class="name">

		<div class="description detailed">
			

		</div>
	</div></td>
</tr>
</table>

<table class="summary inherited">
<caption>Properties inherited from <a href="Class CI_DB_forge.md#properties">CI_DB_forge</a></caption>
<tr>
	<td><code>
		<a href="Class CI_DB_forge.md#$db_char_set"><var>$db_char_set</var></a>, 
		<a href="Class CI_DB_forge.md#$fields"><var>$fields</var></a>, 
		<a href="Class CI_DB_forge.md#$keys"><var>$keys</var></a>, 
		<a href="Class CI_DB_forge.md#$primary_keys"><var>$primary_keys</var></a>
	</code></td>
</tr>
</table>