Query/apiDocumentation/interfaces/Query_Drivers_SQLInterface/explain.html
2020-04-17 15:05:37 -04:00

99 lines
2.9 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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\SQLInterface::explain</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">Query\Drivers</a>
</li>
<li class="separator">
<a title="Query\Drivers\SQLInterface" href="../../interfaces/Query_Drivers_SQLInterface.html">SQLInterface</a>
</li>
<li class="separator">explain</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#parameter">Parameter</a>
</li>
<li>
<a href="#return">Return</a>
</li>
<li>
<a href="../../source/Drivers/SQLInterface.php.html#line39">Source</a>
</li>
</ul>
</nav>
<section>
<h1><small>Query\Drivers\SQLInterface::</small>explain</h1>
<h4>Modify the query to get the query plan</h4>
<p/>
<ul/>
<h2 id="signature">Signature</h2>
<div class="styled synopsis">
<code>public function explain(string
$sql )
</code>
</div>
<h2 id="parameterlist">Parameters</h2>
<dl class="styled">
<dt><code>$sql</code>
string</dt>
<dd/>
</dl>
<h2 id="return">Returns</h2>
<dl class="styled">
<dt>string</dt>
<dd/>
</dl>
</section>
</div>
<footer>
<span>Generated using phpDox 0.12.0-dev - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors</span>
</footer>
</body>
</html>