aviat/Query
1
1
Fork 0
Code Issues 1 Pull Requests Releases 2 Activity
33bb440bd2
Query/apiDocumentation/classes/Query_Drivers_Sqlite_SQL.html

336 lines
16 KiB
HTML
Raw Normal View History

Add updated documentation
2018-01-24 15:31:27 -05:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Query\Drivers\Sqlite\SQL</title>
<link rel="stylesheet" type="text/css" href="../css/style.css" media="screen"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="../index.html">Overview</a>
</li>
<li class="separator">
<a href="../namespaces.html">Namespaces</a>
</li>
<li>
<a href="../interfaces.html">Interfaces</a>
</li>
<li>
<a href="../classes.html">Classes</a>
</li>
<li class="separator">
<a href="../source/index.html">Source</a>
</li>
</ul>
</nav>
<div id="mainstage">
<div class="box">
<ul class="breadcrumb">
<li>
<a href="../index.html">Overview</a>
</li>
<li class="separator">
<a href="../classes.html">Classes</a>
</li>
<li class="separator">
<a href="../classes.html#Query_Drivers_Sqlite">Query\Drivers\Sqlite</a>
</li>
<li class="separator">SQL</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#hierarchy">Hierarchy</a>
</li>
<li>
<a href="#coverage">Coverage</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
<li>
<a href="#history">History</a>
</li>
<li>
<a href="../source/Drivers/Sqlite/SQL.php.html#line22">Source</a>
</li>
</ul>
</nav>
<section>
<h1 id="introduction"><small>Query\Drivers\Sqlite\</small>SQL</h1>
<h4>SQLite Specific SQL</h4>
<p/>
<ul/>
<h2 id="synopsis">Synopsis</h2>
<div class="synopsis">class SQL
extends <a title="Query\Drivers\AbstractSQL" href="../classes/Query_Drivers_AbstractSQL.html">AbstractSQL</a>
{<br/><ul class="none"><li>// methods</li><li>public string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/explain.html">explain</a>()
</li><li>public string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/random.html">random</a>()
</li><li>public string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/dbList.html">dbList</a>()
</li><li>public string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/tableList.html">tableList</a>()
</li><li>public array <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/systemTableList.html">systemTableList</a>()
</li><li>public string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/viewList.html">viewList</a>()
</li><li>public string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/triggerList.html">triggerList</a>()
</li><li>public ?string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/functionList.html">functionList</a>()
</li><li>public ?string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/procedureList.html">procedureList</a>()
</li><li>public ?string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/sequenceList.html">sequenceList</a>()
</li><li>public array <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/typeList.html">typeList</a>()
</li><li>public string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/columnList.html">columnList</a>()
</li><li>public string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/fkList.html">fkList</a>()
</li><li>public string <a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/indexList.html">indexList</a>()
</li></ul><ul class="none"><li>// Inherited methods from <span title="Query\Drivers\AbstractSQL">AbstractSQL</span></li><li>public string <a title="Query\Drivers\AbstractSQL" href="../classes/Query_Drivers_AbstractSQL/limit.html">limit</a>()
</li></ul>
}<br/></div>
<h2 id="hierarchy">Hierarchy</h2>
<div class="styled">
<h4>Extends</h4>
<ul>
<li>
<a title="Query\Drivers\AbstractSQL" href="../classes/Query_Drivers_AbstractSQL.html">Query\Drivers\AbstractSQL</a>
</li>
</ul>
</div>
<h2 id="coverage">Coverage</h2>
<table class="styled">
<tr>
<td>Methods</td>
<td class="percent">0%</td>
<td class="nummeric">0 / 14</td>
</tr>
<tr>
<td>Lines</td>
<td class="percent">0%</td>
<td class="nummeric"> / </td>
</tr>
</table>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>
<ul>
<li id="columnList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/columnList.html">columnList()</a>
— SQL to show information about columns in a table</li>
<li id="dbList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/dbList.html">dbList()</a>
— Returns sql to list other databases</li>
<li id="explain"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/explain.html">explain()</a>
— Get the query plan for the sql query</li>
<li id="fkList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/fkList.html">fkList()</a>
— Get the list of foreign keys for the current table</li>
<li id="functionList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/functionList.html">functionList()</a>
— Return sql to list functions</li>
<li id="indexList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/indexList.html">indexList()</a>
— Get the list of indexes for the current table</li>
<li id="procedureList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/procedureList.html">procedureList()</a>
— Return sql to list stored procedures</li>
<li id="random"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/random.html">random()</a>
— Random ordering keyword</li>
<li id="sequenceList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/sequenceList.html">sequenceList()</a>
— Return sql to list sequences</li>
<li id="systemTableList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/systemTableList.html">systemTableList()</a>
— List the system tables</li>
<li id="tableList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/tableList.html">tableList()</a>
— Returns sql to list tables</li>
<li id="triggerList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/triggerList.html">triggerList()</a>
— Returns sql to list triggers</li>
<li id="typeList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/typeList.html">typeList()</a>
— SQL to show list of field types</li>
<li id="viewList"><a title="Query\Drivers\Sqlite\SQL" href="../classes/Query_Drivers_Sqlite_SQL/viewList.html">viewList()</a>
— Returns sql to list views</li>
</ul>
<h3>Inherited from <a title="Query\Drivers\AbstractSQL" href="../classes/Query_Drivers_AbstractSQL.html">Query\Drivers\AbstractSQL</a></h3>
<h4>public</h4>
<ul>
<li id="limit"><a title="Query\Drivers\AbstractSQL" href="../classes/Query_Drivers_AbstractSQL/limit.html">limit()</a>
— Limit clause</li>
</ul>
</div>
<h2 id="history">History</h2>
<ul class="styled history">
<li>
<h3>2018-01-24T18:14:03+00:00 (commit #<span title="1d583bcc23524ad8840e4be580e549e8d6e549f4">1d583bc</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Add more type hinting</pre>
</div>
</li>
<li>
<h3>2018-01-19T20:47:34+00:00 (commit #<span title="369ca6eb0439091697ee9cbc34c83e9a4bdaace3">369ca6e</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Flatten source structure a bit</pre>
</div>
</li>
<li>
<h3>2018-01-19T18:43:19+00:00 (commit #<span title="c735c27559da47b4d53867da59cd706e8048f4a0">c735c27</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Update file headers</pre>
</div>
</li>
<li>
<h3>2016-10-14T01:55:23+00:00 (commit #<span title="b8d4768b1bfe0f38d6b65f0d4acd982793c0e9ee">b8d4768</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">camelCase methods and properties</pre>
</div>
</li>
<li>
<h3>2016-10-13T02:12:25+00:00 (commit #<span title="6740aaef79540842110b2f162d17a9373d2c30da">6740aae</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">PHP7 or bust!</pre>
</div>
</li>
<li>
<h3>2016-09-07T21:39:19+00:00 (commit #<span title="ca601623ba0b2a5879c01597efbf55bbde3a34fa">ca60162</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Miscellaneous cleanup and refactoring</pre>
</div>
</li>
<li>
<h3>2016-09-07T17:17:17+00:00 (commit #<span title="24f3b1d7011b6087a549e190582386c2669da8ce">24f3b1d</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Update header comments</pre>
</div>
</li>
<li>
<h3>2016-09-07T17:10:03+00:00 (commit #<span title="bb382131cc0d34c5ef725a27b7133c595d11825e">bb38213</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Code Style fixes</pre>
</div>
</li>
<li>
<h3>2015-11-11T01:59:03+00:00 (commit #<span title="2613a1c8a44d7b94f427dce703114a25f38b15e8">2613a1c</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Update lots of comments</pre>
</div>
</li>
<li>
<h3>2015-11-10T15:12:23+00:00 (commit #<span title="b5a141ffc741a4f271bf4e110814ac8861a2312f">b5a141f</span>)</h3>
<div>
<p>
Author: Timothy J Warren (tim@timshomepage.net) /
Commiter: Timothy J Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Make class names Pascal Case</pre>
</div>
</li>
<li>
<h3>2015-07-29T20:51:17+00:00 (commit #<span title="8511c6a445e935547b59a1d3736e7c08cf9633ea">8511c6a</span>)</h3>
<div>
<p>
Author: Timothy J. Warren (tim@timshomepage.net) /
Commiter: Timothy J. Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Move library into src folder, fix simpletest test runner</pre>
</div>
</li>
<li>
<h3>2015-07-16T20:56:13+00:00 (commit #<span title="bfc3ea33ca5c8ddc8500b3d2d8857b9f95304417">bfc3ea3</span>)</h3>
<div>
<p>
Author: Timothy J. Warren (tim@timshomepage.net) /
Commiter: Timothy J. Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Reorganize drivers into a more modern layout</pre>
</div>
</li>
<li>
<h3>2014-08-08T18:02:14+00:00 (commit #<span title="e51fe2be5fbdc0c9ab9bd1cad4927bc48736ff6f">e51fe2b</span>)</h3>
<div>
<p>
Author: Scrutinizer Auto-Fixer (auto-fixer@scrutinizer-ci.com) /
Commiter: Scrutinizer (auto-fixer@scrutinizer-ci.com)
</p>
<pre class="wrapped">Scrutinizer Auto-Fixes
This patch was automatically generated as part of the following inspection:
https://scrutinizer-ci.com/g/timw4mail/Query/inspections/d131279f-a838-49e5-bbfb-20c256a06153
Enabled analysis tools:
- PHP Analyzer</pre>
</div>
</li>
<li>
<h3>2014-04-24T19:32:09+00:00 (commit #<span title="17354ee87eae48b1ca3f852f61543487d79573d3">17354ee</span>)</h3>
<div>
<p>
Author: Timothy J. Warren (tim@timshomepage.net) /
Commiter: Timothy J. Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Move SQL and Util classes to their own namespaces</pre>
</div>
</li>
<li>
<h3>2014-04-23T20:27:43+00:00 (commit #<span title="fddd92a3751edafaf51ca54e7ae8ea7af153f8df">fddd92a</span>)</h3>
<div>
<p>
Author: Timothy J. Warren (tim@timshomepage.net) /
Commiter: Timothy J. Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Fix some more docblocks</pre>
</div>
</li>
<li>
<h3>2014-04-10T19:54:43+00:00 (commit #<span title="32696a53ff1b75dc798735d6b4f566cfc662a9ee">32696a5</span>)</h3>
<div>
<p>
Author: Timothy J. Warren (tim@timshomepage.net) /
Commiter: Timothy J. Warren (tim@timshomepage.net)
</p>
<pre class="wrapped">Flesh out the table builder a bit, and add some missing driver methods to SQLite</pre>
</div>
</li>
</ul>
</section>
</div>
<footer>
<span>Generated using phpDox 0.11.0-dev - Copyright (C) 2010 - 2018 by Arne Blankerts and Contributors</span>
</footer>
</body>
</html>
Reference in New Issue Copy Permalink