301 lines
17 KiB
HTML
301 lines
17 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
|
|
<html lang="en">
|
|
<head>
|
|
|
|
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
|
|
<meta name="when" content="Wed, 14 Apr 2010 15:12:04 +0000">
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
|
|
<link rel="start" href="../../../overview-summary.html">
|
|
|
|
<title>MsSqlSchemaManager (Doctrine)</title>
|
|
|
|
</head>
|
|
<body id="definition" onload="parent.document.title=document.title;">
|
|
|
|
<div class="header">
|
|
<h1>Doctrine</h1>
|
|
<ul>
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="../../../doctrine/dbal/schema/package-summary.html">Namespace</a></li>
|
|
<li class="active">Class</li>
|
|
<li><a href="../../../doctrine/dbal/schema/package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="small_links">
|
|
<a href="../../../index.html" target="_top">Frames</a>
|
|
<a href="../../../doctrine/dbal/schema/mssqlschemamanager.html" target="_top">No frames</a>
|
|
</div>
|
|
<div class="small_links">
|
|
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
|
|
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
|
|
</div>
|
|
<hr>
|
|
|
|
<div class="qualifiedName">Doctrine\DBAL\Schema\MsSqlSchemaManager</div>
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 33</div>
|
|
|
|
<h1>Class MsSqlSchemaManager</h1>
|
|
|
|
<pre class="tree">Class:MsSqlSchemaManager - Superclass: AbstractSchemaManager
|
|
<a href="../../../doctrine/dbal/schema/abstractschemamanager.html">AbstractSchemaManager</a><br> ⌊ <strong>MsSqlSchemaManager</strong><br /></pre>
|
|
|
|
<hr>
|
|
|
|
<p class="signature">public class <strong>MsSqlSchemaManager</strong><br>extends <a href="../../../doctrine/dbal/schema/abstractschemamanager.html">AbstractSchemaManager</a>
|
|
|
|
</p>
|
|
|
|
<div class="comment" id="overview_description"><p>xxx</p></div>
|
|
|
|
<dl>
|
|
<dt>License:</dt>
|
|
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
|
|
<dt>Author:</dt>
|
|
<dd>Konsta Vesterinen <kvesteri@cc.hut.fi></dd>
|
|
<dd>Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)</dd>
|
|
<dt>Version:</dt>
|
|
<dd>$Revision$</dd>
|
|
<dt>Since:</dt>
|
|
<dd>2.0</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<table class="inherit">
|
|
<tr><th colspan="2">Fields inherited from Doctrine\DBAL\Schema\AbstractSchemaManager</th></tr>
|
|
<tr><td><a href="../../../doctrine/dbal/schema/abstractschemamanager.html#_conn">_conn</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#_platform">_platform</a></td></tr></table>
|
|
|
|
<table id="summary_method">
|
|
<tr><th colspan="2">Method Summary</th></tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#alterTable()">alterTable</a>(string name, array changes, boolean check, <a href="../../../doctrine/dbal/schema/tablediff.html">TableDiff</a> tableDiff)</p><p class="description">alter an existing table</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#createDatabase()">createDatabase</a>(string name, string database)</p><p class="description">create a new database</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#createSequence()">createSequence</a>(mixed seqName, mixed start, mixed allocationSize, <a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a> sequence)</p><p class="description">{@inheritdoc}</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#dropDatabase()">dropDatabase</a>(string name, string database)</p><p class="description">drop an existing database</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#dropSequenceSql()">dropSequenceSql</a>(string seqName)</p><p class="description">This function drops an existing sequence</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#listSequences()">listSequences</a>(string|null database)</p><p class="description">lists all database sequences</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#listTableColumns()">listTableColumns</a>(string table)</p><p class="description">lists table constraints</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#listTableIndexes()">listTableIndexes</a>(string table)</p><p class="description">lists table constraints</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#listTableTriggers()">listTableTriggers</a>(string table)</p><p class="description">lists table triggers</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#listTableViews()">listTableViews</a>(string table)</p><p class="description">lists table views</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#listTables()">listTables</a>(string|null database)</p><p class="description">lists tables</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#listTriggers()">listTriggers</a>(mixed database)</p><p class="description">lists all triggers</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#listViews()">listViews</a>(string|null database)</p><p class="description">lists database views</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table class="inherit">
|
|
<tr><th colspan="2">Methods inherited from Doctrine\DBAL\Schema\AbstractSchemaManager</th></tr>
|
|
<tr><td><a href="../../../doctrine/dbal/schema/abstractschemamanager.html#alterTable()">alterTable</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#createConstraint()">createConstraint</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#createDatabase()">createDatabase</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#createForeignKey()">createForeignKey</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#createIndex()">createIndex</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#createSchema()">createSchema</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#createSchemaConfig()">createSchemaConfig</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#createSequence()">createSequence</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#createTable()">createTable</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#createView()">createView</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropAndCreateConstraint()">dropAndCreateConstraint</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropAndCreateDatabase()">dropAndCreateDatabase</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropAndCreateForeignKey()">dropAndCreateForeignKey</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropAndCreateIndex()">dropAndCreateIndex</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropAndCreateSequence()">dropAndCreateSequence</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropAndCreateTable()">dropAndCreateTable</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropAndCreateView()">dropAndCreateView</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropConstraint()">dropConstraint</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropDatabase()">dropDatabase</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropForeignKey()">dropForeignKey</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropIndex()">dropIndex</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropSequence()">dropSequence</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropTable()">dropTable</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#dropView()">dropView</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#getDatabasePlatform()">getDatabasePlatform</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#listDatabases()">listDatabases</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#listSequences()">listSequences</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#listTableColumns()">listTableColumns</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#listTableDetails()">listTableDetails</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#listTableForeignKeys()">listTableForeignKeys</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#listTableIndexes()">listTableIndexes</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#listTableNames()">listTableNames</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#listTables()">listTables</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#listViews()">listViews</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#renameTable()">renameTable</a>, <a href="../../../doctrine/dbal/schema/abstractschemamanager.html#tryMethod()">tryMethod</a></td></tr></table>
|
|
|
|
<h2 id="detail_method">Method Detail</h2>
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 151</div>
|
|
<h3 id="alterTable()">alterTable</h3>
|
|
<code class="signature">public void <strong>alterTable</strong>(string name, array changes, boolean check, <a href="../../../doctrine/dbal/schema/tablediff.html">TableDiff</a> tableDiff)</code>
|
|
<div class="details">
|
|
<p>alter an existing table</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>name - name of the table that is intended to be changed.</dd>
|
|
<dd>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', ), ) ) )</dd>
|
|
<dd>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.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 41</div>
|
|
<h3 id="createDatabase()">createDatabase</h3>
|
|
<code class="signature">public void <strong>createDatabase</strong>(string name, string database)</code>
|
|
<div class="details">
|
|
<p>create a new database</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>name - name of the database that should be created</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 196</div>
|
|
<h3 id="createSequence()">createSequence</h3>
|
|
<code class="signature">public void <strong>createSequence</strong>(mixed seqName, mixed start, mixed allocationSize, <a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a> sequence)</code>
|
|
<div class="details">
|
|
<p></p><dl>
|
|
<dt>Throws:</dt>
|
|
<dd>if something fails at database level</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 58</div>
|
|
<h3 id="dropDatabase()">dropDatabase</h3>
|
|
<code class="signature">public void <strong>dropDatabase</strong>(string name, string database)</code>
|
|
<div class="details">
|
|
<p>drop an existing database</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>name - name of the database that should be dropped</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 224</div>
|
|
<h3 id="dropSequenceSql()">dropSequenceSql</h3>
|
|
<code class="signature">public void <strong>dropSequenceSql</strong>(string seqName)</code>
|
|
<div class="details">
|
|
<p>This function drops an existing sequence</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>seqName - name of the sequence to be dropped</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 235</div>
|
|
<h3 id="listSequences()">listSequences</h3>
|
|
<code class="signature">public array <strong>listSequences</strong>(string|null database)</code>
|
|
<div class="details">
|
|
<p>lists all database sequences</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 249</div>
|
|
<h3 id="listTableColumns()">listTableColumns</h3>
|
|
<code class="signature">public array <strong>listTableColumns</strong>(string table)</code>
|
|
<div class="details">
|
|
<p>lists table constraints</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>table - database table name</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 297</div>
|
|
<h3 id="listTableIndexes()">listTableIndexes</h3>
|
|
<code class="signature">public array <strong>listTableIndexes</strong>(string table)</code>
|
|
<div class="details">
|
|
<p>lists table constraints</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>table - database table name</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 335</div>
|
|
<h3 id="listTableTriggers()">listTableTriggers</h3>
|
|
<code class="signature">public array <strong>listTableTriggers</strong>(string table)</code>
|
|
<div class="details">
|
|
<p>lists table triggers</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>table - database table name</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 351</div>
|
|
<h3 id="listTableViews()">listTableViews</h3>
|
|
<code class="signature">public array <strong>listTableViews</strong>(string table)</code>
|
|
<div class="details">
|
|
<p>lists table views</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>table - database table name</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 308</div>
|
|
<h3 id="listTables()">listTables</h3>
|
|
<code class="signature">public array <strong>listTables</strong>(string|null database)</code>
|
|
<div class="details">
|
|
<p>lists tables</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 320</div>
|
|
<h3 id="listTriggers()">listTriggers</h3>
|
|
<code class="signature">public array <strong>listTriggers</strong>(mixed database)</code>
|
|
<div class="details">
|
|
<p>lists all triggers</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Schema/MsSqlSchemaManager.php at line 388</div>
|
|
<h3 id="listViews()">listViews</h3>
|
|
<code class="signature">public array <strong>listViews</strong>(string|null database)</code>
|
|
<div class="details">
|
|
<p>lists database views</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="header">
|
|
<h1>Doctrine</h1>
|
|
<ul>
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="../../../doctrine/dbal/schema/package-summary.html">Namespace</a></li>
|
|
<li class="active">Class</li>
|
|
<li><a href="../../../doctrine/dbal/schema/package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="small_links">
|
|
<a href="../../../index.html" target="_top">Frames</a>
|
|
<a href="../../../doctrine/dbal/schema/mssqlschemamanager.html" target="_top">No frames</a>
|
|
</div>
|
|
<div class="small_links">
|
|
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
|
|
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
|
|
</div>
|
|
<hr>
|
|
|
|
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
|
|
|
|
</body>
|
|
|
|
</html> |