aviat/Query
1
1
Fork 0
Code Issues 1 Pull Requests Releases 2 Activity
8e16cc0c19
Query/docs/classes/Firebird_Util.html

184 lines
9.4 KiB
HTML
Raw Normal View History

Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<!DOCTYPE html><html lang="en">
Updated generated docs
2012-09-13 11:45:27 -04:00
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Query » \Firebird_Util</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<span class="label label-info">0</span></a></li>
Updated generated docs
2012-09-13 11:45:27 -04:00
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<ul></ul></a></li>
Updated generated docs
2012-09-13 11:45:27 -04:00
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
<ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_backup_data" title="backup_data() :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li>
<li class="method public "><a href="#method_backup_structure" title="backup_structure() :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
<li class="method public "><a href="#method_create_table" title="create_table() :: Convienience public function to generate sql for creating a db table"><span class="description">Convienience public function to generate sql for creating a db table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#method_delete_table" title="delete_table() :: Drop the selected table"><span class="description">Drop the selected table</span><pre>delete_table()</pre></a></li>
Updated generated docs
2012-09-13 11:45:27 -04:00
</ul>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
</li></ul>
Updated generated docs
2012-09-13 11:45:27 -04:00
</div>
<div class="span8">
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<a id="\Firebird_Util"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/Firebird_Util.html">Firebird_Util</a>
</li>
</ul>
<div class="element class">
Updated generated docs
2012-09-13 11:45:27 -04:00
<p class="short_description">Firebird-specific backup, import and creation methods</p>
<div class="details">
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<div class="long_description"></div>
Updated generated docs
2012-09-13 11:45:27 -04:00
<table class="table table-bordered">
<tr>
<th>package</th>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<td><a href="../packages/Query.Drivers.html">Query</a></td>
Updated generated docs
2012-09-13 11:45:27 -04:00
</tr>
<tr>
<th>subpackage</th>
<td>Drivers</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
Updated generated docs
2012-09-13 11:45:27 -04:00
<h2>Save a reference to the current connection object</h2>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<pre>__construct($conn) : void</pre>
Updated generated docs
2012-09-13 11:45:27 -04:00
<div class="labels"></div>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
Updated generated docs
2012-09-13 11:45:27 -04:00
<h3>Parameters</h3>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<div class="subelement argument"><h4>$conn</h4></div>
Updated generated docs
2012-09-13 11:45:27 -04:00
</div></div>
</div>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse">
Updated generated docs
2012-09-13 11:45:27 -04:00
<h2>Create an SQL backup file for the current database's data</h2>
<pre>backup_data(array $exclude, bool $system_tables) : string</pre>
<div class="labels"></div>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
Updated generated docs
2012-09-13 11:45:27 -04:00
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$exclude</h4>
<code>array</code>
</div>
<div class="subelement argument">
<h4>$system_tables</h4>
<code>bool</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse">
Updated generated docs
2012-09-13 11:45:27 -04:00
<h2>Create an SQL backup file for the current database's structure</h2>
<pre>backup_structure() : string</pre>
<div class="labels"></div>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
Updated generated docs
2012-09-13 11:45:27 -04:00
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<a id="method_create_table"></a><div class="element clickable method public method_create_table" data-toggle="collapse" data-target=".method_create_table .collapse">
Updated generated docs
2012-09-13 11:45:27 -04:00
<h2>Convienience public function to generate sql for creating a db table</h2>
<pre>create_table(string $name, array $fields, array $constraints, array $indexes) : string</pre>
<div class="labels"></div>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
Updated generated docs
2012-09-13 11:45:27 -04:00
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$fields</h4>
<code>array</code>
</div>
<div class="subelement argument">
<h4>$constraints</h4>
<code>array</code>
</div>
<div class="subelement argument">
<h4>$indexes</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<a id="method_delete_table"></a><div class="element clickable method public method_delete_table" data-toggle="collapse" data-target=".method_delete_table .collapse">
Updated generated docs
2012-09-13 11:45:27 -04:00
<h2>Drop the selected table</h2>
<pre>delete_table(string $name) : string</pre>
<div class="labels"></div>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
Updated generated docs
2012-09-13 11:45:27 -04:00
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Fix some issues with the grouping commands, and greatly expand test coverage
2013-12-06 23:00:32 -05:00
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
</a> and<br>
Test and doc updates
2014-02-07 16:53:01 -05:00
generated on 2014-02-07T16:51:34-05:00.<br></footer></div>
Updated generated docs
2012-09-13 11:45:27 -04:00
</div>
</body>
</html>
Reference in New Issue Copy Permalink