Query/docs/interfaces/Query_SQLInterface.html

134 lines
7.6 KiB
HTML
Raw Normal View History

2015-11-10 09:20: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>
2015-11-10 11:10:27 -05:00
<title>phpDox - Query\SQLInterface</title>
2015-11-10 09:20:27 -05:00
<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="../interfaces.html">Interfaces</a>
</li>
<li class="separator">
<a href="../interfaces.html#Query">Query</a>
</li>
2015-11-10 11:10:27 -05:00
<li class="separator">SQLInterface</li>
2015-11-10 09:20:27 -05:00
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#violations">Violations</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
<li>
2015-11-10 11:10:27 -05:00
<a href="../source/Query/SQLInterface.php.html#line24">Source</a>
2015-11-10 09:20:27 -05:00
</li>
</ul>
</nav>
<section>
2015-11-10 11:10:27 -05:00
<h1 id="introduction"><small>Query\</small>SQLInterface</h1>
2015-11-10 09:20:27 -05:00
<h4>parent for database manipulation subclasses</h4>
<p/>
<ul/>
<h2 id="synopsis">Synopsis</h2>
2015-11-10 11:10:27 -05:00
<div class="synopsis">interface SQLInterface
{<br/><ul class="none"><li>// methods</li><li>public string <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/limit.html">limit</a>()
</li><li>public string <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/explain.html">explain</a>()
</li><li>public string <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/random.html">random</a>()
</li><li>public string <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/db_list.html">db_list</a>()
</li><li>public string <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/table_list.html">table_list</a>()
</li><li>public string <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/system_table_list.html">system_table_list</a>()
</li><li>public string <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/view_list.html">view_list</a>()
</li><li>public string <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/trigger_list.html">trigger_list</a>()
</li><li>public NULL <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/function_list.html">function_list</a>()
</li><li>public string <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/procedure_list.html">procedure_list</a>()
</li><li>public string <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/sequence_list.html">sequence_list</a>()
</li><li>public string|array <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/type_list.html">type_list</a>()
</li><li>public string <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/column_list.html">column_list</a>()
</li><li>public array <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/fk_list.html">fk_list</a>()
</li><li>public array <a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/index_list.html">index_list</a>()
2015-11-10 09:20:27 -05:00
</li></ul>
}<br/></div>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>
<ul>
2015-11-10 11:10:27 -05:00
<li id="column_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/column_list.html">column_list()</a>
2015-11-10 09:20:27 -05:00
— Get information about the columns in the specified table</li>
2015-11-10 11:10:27 -05:00
<li id="db_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/db_list.html">db_list()</a>
2015-11-10 09:20:27 -05:00
— Returns sql to list other databases</li>
2015-11-10 11:10:27 -05:00
<li id="explain"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/explain.html">explain()</a>
2015-11-10 09:20:27 -05:00
— Modify the query to get the query plan</li>
2015-11-10 11:10:27 -05:00
<li id="fk_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/fk_list.html">fk_list()</a>
2015-11-10 09:20:27 -05:00
— Get the list of foreign keys for the current table</li>
2015-11-10 11:10:27 -05:00
<li id="function_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/function_list.html">function_list()</a>
2015-11-10 09:20:27 -05:00
— Return sql to list functions</li>
2015-11-10 11:10:27 -05:00
<li id="index_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/index_list.html">index_list()</a>
2015-11-10 09:20:27 -05:00
— Get the list of indexes for the current table</li>
2015-11-10 11:10:27 -05:00
<li id="limit"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/limit.html">limit()</a>
2015-11-10 09:20:27 -05:00
— Get database specific sql for limit clause</li>
2015-11-10 11:10:27 -05:00
<li id="procedure_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/procedure_list.html">procedure_list()</a>
2015-11-10 09:20:27 -05:00
— Return sql to list stored procedures</li>
2015-11-10 11:10:27 -05:00
<li id="random"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/random.html">random()</a>
2015-11-10 09:20:27 -05:00
— Get the sql for random ordering</li>
2015-11-10 11:10:27 -05:00
<li id="sequence_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/sequence_list.html">sequence_list()</a>
2015-11-10 09:20:27 -05:00
— Return sql to list sequences</li>
2015-11-10 11:10:27 -05:00
<li id="system_table_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/system_table_list.html">system_table_list()</a>
2015-11-10 09:20:27 -05:00
— Returns sql to list system tables</li>
2015-11-10 11:10:27 -05:00
<li id="table_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/table_list.html">table_list()</a>
2015-11-10 09:20:27 -05:00
— Returns sql to list tables</li>
2015-11-10 11:10:27 -05:00
<li id="trigger_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/trigger_list.html">trigger_list()</a>
2015-11-10 09:20:27 -05:00
— Returns sql to list triggers</li>
2015-11-10 11:10:27 -05:00
<li id="type_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/type_list.html">type_list()</a>
2015-11-10 09:20:27 -05:00
— Return sql to list database field types</li>
2015-11-10 11:10:27 -05:00
<li id="view_list"><a title="Query\SQLInterface" href="../interfaces/Query_SQLInterface/view_list.html">view_list()</a>
2015-11-10 09:20:27 -05:00
— Returns sql to list views</li>
</ul>
</div>
</section>
</div>
<footer>
<span>Generated using phpDox 0.8.2-dev - Copyright (C) 2010 - 2015 by Arne Blankerts</span>
</footer>
</body>
</html>