RetailCRM-Mirror/doctrine2
1
0
Fork 0
mirror of synced 2024-12-15 15:46:02 +03:00
Code Issues Projects Releases Wiki Activity
427d4eed29
doctrine2/lib/api/doctrine/dbal/schema/abstractschemamanager.html
Roman S. Borschel 10acab655d Adding new API docs.
2010-04-14 17:13:14 +02:00

689 lines
30 KiB
HTML
Raw Blame History

<!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>AbstractSchemaManager (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/abstractschemamanager.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\AbstractSchemaManager</div>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 41</div>
<h1>Class AbstractSchemaManager</h1>
<pre class="tree"><strong>AbstractSchemaManager</strong><br /></pre>
<hr>
<p class="signature">public abstract class <strong>AbstractSchemaManager</strong></p>
<div class="comment" id="overview_description"><p>Base class for schema managers. Schema managers are used to inspect and/or
modify the database schema/structure.</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>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dd>Jonathan H. Wage <jonwage@gmail.com></dd>
<dd>Benjamin Eberlei <kontakt@beberlei.de></dd>
<dt>Version:</dt>
<dd>$Revision$</dd>
<dt>Since:</dt>
<dd>2.0</dd>
</dl>
<hr>
<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type">protected \Doctrine\DBAL\Connection</td>
<td class="description"><p class="name"><a href="#_conn">$_conn</a></p><p class="description">Holds instance of the Doctrine connection for this schema manager</p></td>
</tr>
<tr>
<td class="type">protected \Doctrine\DBAL\Platforms\AbstractPlatform</td>
<td class="description"><p class="name"><a href="#_platform">$_platform</a></p><p class="description">Holds instance of the database platform used for this schema manager</p></td>
</tr>
</table>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#AbstractSchemaManager()">AbstractSchemaManager</a>(\Doctrine\DBAL\Connection conn)</p><p class="description">Constructor. </p></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>(<a href="../../../doctrine/dbal/schema/tablediff.html">TableDiff</a> tableDiff)</p><p class="description">Alter an existing tables schema</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#createConstraint()">createConstraint</a>(<a href="../../../doctrine/dbal/schema/constraint.html">Constraint</a> constraint, string|Table table)</p><p class="description">Create a constraint on a table</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#createDatabase()">createDatabase</a>(string database)</p><p class="description">Creates a new database.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#createForeignKey()">createForeignKey</a>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> foreignKey, string|Table table)</p><p class="description">Create a new foreign key</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#createIndex()">createIndex</a>(<a href="../../../doctrine/dbal/schema/index.html">Index</a> index, string table)</p><p class="description">Create a new index on a table</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/dbal/schema/schema.html">Schema</a></td>
<td class="description"><p class="name"><a href="#createSchema()">createSchema</a>()</p><p class="description">Create a schema instance for the current database.</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/dbal/schema/schemaconfig.html">SchemaConfig</a></td>
<td class="description"><p class="name"><a href="#createSchemaConfig()">createSchemaConfig</a>()</p><p class="description">Create the configuration for this schema.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#createSequence()">createSequence</a>(<a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a> sequence)</p><p class="description">Create a new sequence</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#createTable()">createTable</a>(<a href="../../../doctrine/dbal/schema/table.html">Table</a> table, int createFlags)</p><p class="description">Create a new table.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#createView()">createView</a>(<a href="../../../doctrine/dbal/schema/view.html">View</a> view)</p><p class="description">Create a new view</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropAndCreateConstraint()">dropAndCreateConstraint</a>(<a href="../../../doctrine/dbal/schema/constraint.html">Constraint</a> constraint, string table)</p><p class="description">Drop and create a constraint</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropAndCreateDatabase()">dropAndCreateDatabase</a>(string database)</p><p class="description">Drop and creates a new database.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropAndCreateForeignKey()">dropAndCreateForeignKey</a>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> foreignKey, string|Table table)</p><p class="description">Drop and create a new foreign key</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropAndCreateIndex()">dropAndCreateIndex</a>(<a href="../../../doctrine/dbal/schema/index.html">Index</a> index, string|Table table)</p><p class="description">Drop and create a new index on a table</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropAndCreateSequence()">dropAndCreateSequence</a>(<a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a> sequence)</p><p class="description">Drop and create a new sequence</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropAndCreateTable()">dropAndCreateTable</a>(<a href="../../../doctrine/dbal/schema/table.html">Table</a> table)</p><p class="description">Drop and create a new table.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropAndCreateView()">dropAndCreateView</a>(<a href="../../../doctrine/dbal/schema/view.html">View</a> view)</p><p class="description">Drop and create a new view</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropConstraint()">dropConstraint</a>(<a href="../../../doctrine/dbal/schema/constraint.html">Constraint</a> constraint, string table)</p><p class="description">Drop the constraint from the given table</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropDatabase()">dropDatabase</a>(string database)</p><p class="description">Drops a database.
</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#dropForeignKey()">dropForeignKey</a>(mixed foreignKey, ForeignKeyConstraint|string table, Table|string name)</p><p class="description">Drops a foreign key from a table.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropIndex()">dropIndex</a>(Index|string index, string|Table table)</p><p class="description">Drop the index from the given table</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropSequence()">dropSequence</a>(string name)</p><p class="description">Drops a sequence with a given name.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#dropTable()">dropTable</a>(string table)</p><p class="description">Drop the given table</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#dropView()">dropView</a>(string name)</p><p class="description">Drop a view</p></td>
</tr>
<tr>
<td class="type"> \Doctrine\DBAL\Platform\AbstractPlatform</td>
<td class="description"><p class="name"><a href="#getDatabasePlatform()">getDatabasePlatform</a>()</p><p class="description">Return associated platform.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#listDatabases()">listDatabases</a>()</p><p class="description">List the available databases for this connection</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/dbal/schema/sequence.html">Sequence[]</a></td>
<td class="description"><p class="name"><a href="#listSequences()">listSequences</a>(mixed database)</p><p class="description">List the available sequences for this connection</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/dbal/schema/column.html">Column[]</a></td>
<td class="description"><p class="name"><a href="#listTableColumns()">listTableColumns</a>(string table)</p><p class="description">List the columns for a given table.
</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/dbal/schema/table.html">Table</a></td>
<td class="description"><p class="name"><a href="#listTableDetails()">listTableDetails</a>(string tableName)</p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint[]</a></td>
<td class="description"><p class="name"><a href="#listTableForeignKeys()">listTableForeignKeys</a>(string table, mixed database)</p><p class="description">List the foreign keys for the given table</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/dbal/schema/index.html">Index[]</a></td>
<td class="description"><p class="name"><a href="#listTableIndexes()">listTableIndexes</a>(string table)</p><p class="description">List the indexes for a given table returning an array of Index instances.
</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#listTableNames()">listTableNames</a>()</p><p class="description">Return a list of all tables in the current database</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/dbal/schema/table.html">Table[]</a></td>
<td class="description"><p class="name"><a href="#listTables()">listTables</a>()</p><p class="description">List the tables for this connection</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/dbal/schema/view.html">View[]</a></td>
<td class="description"><p class="name"><a href="#listViews()">listViews</a>()</p><p class="description">List the views this connection has</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#renameTable()">renameTable</a>(string name, string newName)</p><p class="description">Rename a given table to another name</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#tryMethod()">tryMethod</a>()</p><p class="description">Try any method on the schema manager. </p></td>
</tr>
</table>
<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 48</div>
<h3 id="_conn">_conn</h3>
<code class="signature">protected \Doctrine\DBAL\Connection <strong>$_conn</strong></code>
<div class="details">
<p>Holds instance of the Doctrine connection for this schema manager</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 55</div>
<h3 id="_platform">_platform</h3>
<code class="signature">protected \Doctrine\DBAL\Platforms\AbstractPlatform <strong>$_platform</strong></code>
<div class="details">
<p>Holds instance of the database platform used for this schema manager</p></div>
<hr>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 62</div>
<h3 id="AbstractSchemaManager()">AbstractSchemaManager</h3>
<code class="signature">public <strong>AbstractSchemaManager</strong>(\Doctrine\DBAL\Connection conn)</code>
<div class="details">
<p>Constructor. Accepts the Connection instance to manage the schema for</p></div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 512</div>
<h3 id="alterTable()">alterTable</h3>
<code class="signature">public void <strong>alterTable</strong>(<a href="../../../doctrine/dbal/schema/tablediff.html">TableDiff</a> tableDiff)</code>
<div class="details">
<p>Alter an existing tables schema</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 383</div>
<h3 id="createConstraint()">createConstraint</h3>
<code class="signature">public void <strong>createConstraint</strong>(<a href="../../../doctrine/dbal/schema/constraint.html">Constraint</a> constraint, string|Table table)</code>
<div class="details">
<p>Create a constraint on a table</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 349</div>
<h3 id="createDatabase()">createDatabase</h3>
<code class="signature">public void <strong>createDatabase</strong>(string database)</code>
<div class="details">
<p>Creates a new database.</p><dl>
<dt>Parameters:</dt>
<dd>database - The name of the database to create.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 405</div>
<h3 id="createForeignKey()">createForeignKey</h3>
<code class="signature">public void <strong>createForeignKey</strong>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> foreignKey, string|Table table)</code>
<div class="details">
<p>Create a new foreign key</p><dl>
<dt>Parameters:</dt>
<dd>foreignKey - ForeignKey instance</dd>
<dd>table - name of the table on which the foreign key is to be created</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 394</div>
<h3 id="createIndex()">createIndex</h3>
<code class="signature">public void <strong>createIndex</strong>(<a href="../../../doctrine/dbal/schema/index.html">Index</a> index, string table)</code>
<div class="details">
<p>Create a new index on a table</p><dl>
<dt>Parameters:</dt>
<dd></dd>
<dd>table - name of the table on which the index is to be created</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 750</div>
<h3 id="createSchema()">createSchema</h3>
<code class="signature">public <a href="../../../doctrine/dbal/schema/schema.html">Schema</a> <strong>createSchema</strong>()</code>
<div class="details">
<p>Create a schema instance for the current database.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 766</div>
<h3 id="createSchemaConfig()">createSchemaConfig</h3>
<code class="signature">public <a href="../../../doctrine/dbal/schema/schemaconfig.html">SchemaConfig</a> <strong>createSchemaConfig</strong>()</code>
<div class="details">
<p>Create the configuration for this schema.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 372</div>
<h3 id="createSequence()">createSequence</h3>
<code class="signature">public void <strong>createSequence</strong>(<a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a> sequence)</code>
<div class="details">
<p>Create a new sequence</p><dl>
<dt>Throws:</dt>
<dd>if something fails at database level</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 360</div>
<h3 id="createTable()">createTable</h3>
<code class="signature">public void <strong>createTable</strong>(<a href="../../../doctrine/dbal/schema/table.html">Table</a> table, int createFlags)</code>
<div class="details">
<p>Create a new table.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 415</div>
<h3 id="createView()">createView</h3>
<code class="signature">public void <strong>createView</strong>(<a href="../../../doctrine/dbal/schema/view.html">View</a> view)</code>
<div class="details">
<p>Create a new view</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 430</div>
<h3 id="dropAndCreateConstraint()">dropAndCreateConstraint</h3>
<code class="signature">public void <strong>dropAndCreateConstraint</strong>(<a href="../../../doctrine/dbal/schema/constraint.html">Constraint</a> constraint, string table)</code>
<div class="details">
<p>Drop and create a constraint</p><dl>
<dt>See Also:</dt>
<dd>dropConstraint()</dd>
<dd>createConstraint()</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 488</div>
<h3 id="dropAndCreateDatabase()">dropAndCreateDatabase</h3>
<code class="signature">public void <strong>dropAndCreateDatabase</strong>(string database)</code>
<div class="details">
<p>Drop and creates a new database.</p><dl>
<dt>Parameters:</dt>
<dd>database - The name of the database to create.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 454</div>
<h3 id="dropAndCreateForeignKey()">dropAndCreateForeignKey</h3>
<code class="signature">public void <strong>dropAndCreateForeignKey</strong>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> foreignKey, string|Table table)</code>
<div class="details">
<p>Drop and create a new foreign key</p><dl>
<dt>Parameters:</dt>
<dd>foreignKey - associative array that defines properties of the foreign key to be created.</dd>
<dd>table - name of the table on which the foreign key is to be created</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 442</div>
<h3 id="dropAndCreateIndex()">dropAndCreateIndex</h3>
<code class="signature">public void <strong>dropAndCreateIndex</strong>(<a href="../../../doctrine/dbal/schema/index.html">Index</a> index, string|Table table)</code>
<div class="details">
<p>Drop and create a new index on a table</p><dl>
<dt>Parameters:</dt>
<dd>table - name of the table on which the index is to be created</dd>
<dd></dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 466</div>
<h3 id="dropAndCreateSequence()">dropAndCreateSequence</h3>
<code class="signature">public void <strong>dropAndCreateSequence</strong>(<a href="../../../doctrine/dbal/schema/sequence.html">Sequence</a> sequence)</code>
<div class="details">
<p>Drop and create a new sequence</p><dl>
<dt>Throws:</dt>
<dd>if something fails at database level</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 477</div>
<h3 id="dropAndCreateTable()">dropAndCreateTable</h3>
<code class="signature">public void <strong>dropAndCreateTable</strong>(<a href="../../../doctrine/dbal/schema/table.html">Table</a> table)</code>
<div class="details">
<p>Drop and create a new table.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 499</div>
<h3 id="dropAndCreateView()">dropAndCreateView</h3>
<code class="signature">public void <strong>dropAndCreateView</strong>(<a href="../../../doctrine/dbal/schema/view.html">View</a> view)</code>
<div class="details">
<p>Drop and create a new view</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 304</div>
<h3 id="dropConstraint()">dropConstraint</h3>
<code class="signature">public void <strong>dropConstraint</strong>(<a href="../../../doctrine/dbal/schema/constraint.html">Constraint</a> constraint, string table)</code>
<div class="details">
<p>Drop the constraint from the given table</p><dl>
<dt>Parameters:</dt>
<dd></dd>
<dd>table - The name of the table</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 268</div>
<h3 id="dropDatabase()">dropDatabase</h3>
<code class="signature">public void <strong>dropDatabase</strong>(string database)</code>
<div class="details">
<p>Drops a database.</p><p>NOTE: You can not drop the database this SchemaManager is currently connected to.</p><dl>
<dt>Parameters:</dt>
<dd>database - The name of the database to drop</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 316</div>
<h3 id="dropForeignKey()">dropForeignKey</h3>
<code class="signature">public boolean <strong>dropForeignKey</strong>(mixed foreignKey, ForeignKeyConstraint|string table, Table|string name)</code>
<div class="details">
<p>Drops a foreign key from a table.</p><dl>
<dt>Parameters:</dt>
<dd>table - The name of the table with the foreign key.</dd>
<dd>name - The name of the foreign key.</dd>
<dt>Returns:</dt>
<dd>$result</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 289</div>
<h3 id="dropIndex()">dropIndex</h3>
<code class="signature">public void <strong>dropIndex</strong>(Index|string index, string|Table table)</code>
<div class="details">
<p>Drop the index from the given table</p><dl>
<dt>Parameters:</dt>
<dd>index - The name of the index</dd>
<dd>table - The name of the table</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 326</div>
<h3 id="dropSequence()">dropSequence</h3>
<code class="signature">public void <strong>dropSequence</strong>(string name)</code>
<div class="details">
<p>Drops a sequence with a given name.</p><dl>
<dt>Parameters:</dt>
<dd>name - The name of the sequence to drop.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 278</div>
<h3 id="dropTable()">dropTable</h3>
<code class="signature">public void <strong>dropTable</strong>(string table)</code>
<div class="details">
<p>Drop the given table</p><dl>
<dt>Parameters:</dt>
<dd>table - The name of the table to drop</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 337</div>
<h3 id="dropView()">dropView</h3>
<code class="signature">public boolean <strong>dropView</strong>(string name)</code>
<div class="details">
<p>Drop a view</p><dl>
<dt>Parameters:</dt>
<dd>name - The name of the view</dd>
<dt>Returns:</dt>
<dd>$result</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 73</div>
<h3 id="getDatabasePlatform()">getDatabasePlatform</h3>
<code class="signature">public \Doctrine\DBAL\Platform\AbstractPlatform <strong>getDatabasePlatform</strong>()</code>
<div class="details">
<p>Return associated platform.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 109</div>
<h3 id="listDatabases()">listDatabases</h3>
<code class="signature">public array <strong>listDatabases</strong>()</code>
<div class="details">
<p>List the available databases for this connection</p><dl>
<dt>Returns:</dt>
<dd>$databases</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 123</div>
<h3 id="listSequences()">listSequences</h3>
<code class="signature">public <a href="../../../doctrine/dbal/schema/sequence.html">Sequence[]</a> <strong>listSequences</strong>(mixed database)</code>
<div class="details">
<p>List the available sequences for this connection</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 148</div>
<h3 id="listTableColumns()">listTableColumns</h3>
<code class="signature">public <a href="../../../doctrine/dbal/schema/column.html">Column[]</a> <strong>listTableColumns</strong>(string table)</code>
<div class="details">
<p>List the columns for a given table.</p><p>In contrast to other libraries and to the old version of Doctrine,
this column definition does try to contain the 'primary' field for
the reason that it is not portable accross different RDBMS. Use
listTableIndexes($tableName) to retrieve the primary key
of a table. We're a RDBMS specifies more details these are held
in the platformDetails array.</p><dl>
<dt>Parameters:</dt>
<dd>table - The name of the table.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 209</div>
<h3 id="listTableDetails()">listTableDetails</h3>
<code class="signature">public <a href="../../../doctrine/dbal/schema/table.html">Table</a> <strong>listTableDetails</strong>(string tableName)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 248</div>
<h3 id="listTableForeignKeys()">listTableForeignKeys</h3>
<code class="signature">public <a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint[]</a> <strong>listTableForeignKeys</strong>(string table, mixed database)</code>
<div class="details">
<p>List the foreign keys for the given table</p><dl>
<dt>Parameters:</dt>
<dd>table - The name of the table</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 165</div>
<h3 id="listTableIndexes()">listTableIndexes</h3>
<code class="signature">public <a href="../../../doctrine/dbal/schema/index.html">Index[]</a> <strong>listTableIndexes</strong>(string table)</code>
<div class="details">
<p>List the indexes for a given table returning an array of Index instances.</p><p>Keys of the portable indexes list are all lower-cased.</p><dl>
<dt>Parameters:</dt>
<dd>table - The name of the table</dd>
<dt>Returns:</dt>
<dd>$tableIndexes</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 179</div>
<h3 id="listTableNames()">listTableNames</h3>
<code class="signature">public array <strong>listTableNames</strong>()</code>
<div class="details">
<p>Return a list of all tables in the current database</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 193</div>
<h3 id="listTables()">listTables</h3>
<code class="signature">public <a href="../../../doctrine/dbal/schema/table.html">Table[]</a> <strong>listTables</strong>()</code>
<div class="details">
<p>List the tables for this connection</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 233</div>
<h3 id="listViews()">listViews</h3>
<code class="signature">public <a href="../../../doctrine/dbal/schema/view.html">View[]</a> <strong>listViews</strong>()</code>
<div class="details">
<p>List the views this connection has</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 528</div>
<h3 id="renameTable()">renameTable</h3>
<code class="signature">public void <strong>renameTable</strong>(string name, string newName)</code>
<div class="details">
<p>Rename a given table to another name</p><dl>
<dt>Parameters:</dt>
<dd>name - The current name of the table</dd>
<dd>newName - The new name of the table</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Schema/AbstractSchemaManager.php at line 90</div>
<h3 id="tryMethod()">tryMethod</h3>
<code class="signature">public mixed <strong>tryMethod</strong>()</code>
<div class="details">
<p>Try any method on the schema manager. Normally a method throws an
exception when your DBMS doesn't support it or if an error occurs.
This method allows you to try and method on your SchemaManager
instance and will return false if it does not work or is not supported.</p><p><code>
$result = $sm->tryMethod('dropView', 'view_name');
</code></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/abstractschemamanager.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>
Reference in New Issue View Git Blame Copy Permalink