aviat/Query
1
1
Fork 0
Code Issues 1 Pull Requests Releases 2 Activity
master
Query/apiDocumentation/classes/Query-Drivers-Sqlite-SQL.html

975 lines
45 KiB
HTML
Raw Permalink Normal View History

Cleanup docs
2023-01-20 11:30:51 -05:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/query.html" class="">Query</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/query-drivers.html" class="">Drivers</a>
</li>
<li>
<a href="namespaces/query-exception.html" class="">Exception</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Query.html" class="">Query</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="graphs/classes.html">Class Diagram</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/query.html">Query</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/query-drivers.html">Drivers</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/query-drivers-sqlite.html">Sqlite</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
SQL
<span class="phpdocumentor-element__extends">
extends <a href="classes/Query-Drivers-AbstractSQL.html"><abbr title="\Query\Drivers\AbstractSQL">AbstractSQL</abbr></a>
</span>
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Query.html">Query</a></li>
</ul>
</div>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">25</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.25" class="phpdocumentor-element-found-in__source" data-line="25" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">SQLite Specific SQL</p>
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_columnList">columnList()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>SQL to show information about columns in a table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_dbList">dbList()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns sql to list other databases. Meaningless for SQLite, as this
just returns the database(s) that we are currently connected to.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_explain">explain()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get the query plan for the sql query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_fkList">fkList()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get the list of foreign keys for the current
table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_functionList">functionList()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Return sql to list functions</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_indexList">indexList()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get the list of indexes for the current table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractSQL.html#method_limit">limit()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Limit clause</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_procedureList">procedureList()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Return sql to list stored procedures</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_random">random()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Random ordering keyword</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_sequenceList">sequenceList()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Return sql to list sequences</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_systemTableList">systemTableList()</a>
<span>
&nbsp;: array&lt;string|int, string&gt; </span>
</dt>
<dd>List the system tables</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_tableList">tableList()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns sql to list tables</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_triggerList">triggerList()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns sql to list triggers</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_typeList">typeList()</a>
<span>
&nbsp;: array&lt;string|int, string&gt; </span>
</dt>
<dd>SQL to show list of field types</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_viewList">viewList()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns sql to list views</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Query-Drivers-Sqlite-SQL.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_columnList">
columnList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_columnList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">143</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.143" class="phpdocumentor-element-found-in__source" data-line="143" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">SQL to show information about columns in a table</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">columnList</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_dbList">
dbList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_dbList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">47</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.47" class="phpdocumentor-element-found-in__source" data-line="47" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Returns sql to list other databases. Meaningless for SQLite, as this
just returns the database(s) that we are currently connected to.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">dbList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_explain">
explain()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_explain" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">30</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.30" class="phpdocumentor-element-found-in__source" data-line="30" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Get the query plan for the sql query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">explain</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$sql</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sql</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_fkList">
fkList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_fkList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">154</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.154" class="phpdocumentor-element-found-in__source" data-line="154" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Get the list of foreign keys for the current
table</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">fkList</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_functionList">
functionList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_functionList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">107</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.107" class="phpdocumentor-element-found-in__source" data-line="107" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Return sql to list functions</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">functionList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Query-Exception-NotImplementedException.html"><abbr title="\Query\Exception\NotImplementedException">NotImplementedException</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_indexList">
indexList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_indexList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">164</span>
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.164" class="phpdocumentor-element-found-in__source" data-line="164" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Get the list of indexes for the current table</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">indexList</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_limit">
limit()
<a href="classes/Query-Drivers-AbstractSQL.html#method_limit" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractSQL.php"><a href="files/src-drivers-abstractsql.html"><abbr title="src/Drivers/AbstractSQL.php">AbstractSQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">27</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.27" class="phpdocumentor-element-found-in__source" data-line="27" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Limit clause</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">limit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$sql</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limit</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$offset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sql</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$limit</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$offset</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_procedureList">
procedureList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_procedureList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">117</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.117" class="phpdocumentor-element-found-in__source" data-line="117" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Return sql to list stored procedures</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">procedureList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Query-Exception-NotImplementedException.html"><abbr title="\Query\Exception\NotImplementedException">NotImplementedException</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_random">
random()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_random" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">38</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.38" class="phpdocumentor-element-found-in__source" data-line="38" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Random ordering keyword</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">random</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_sequenceList">
sequenceList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_sequenceList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">125</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.125" class="phpdocumentor-element-found-in__source" data-line="125" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Return sql to list sequences</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">sequenceList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_systemTableList">
systemTableList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_systemTableList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">73</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.73" class="phpdocumentor-element-found-in__source" data-line="73" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">List the system tables</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">systemTableList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, string&gt;</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, string&gt;</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_tableList">
tableList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_tableList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">55</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.55" class="phpdocumentor-element-found-in__source" data-line="55" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Returns sql to list tables</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">tableList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_triggerList">
triggerList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_triggerList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">95</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.95" class="phpdocumentor-element-found-in__source" data-line="95" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Returns sql to list triggers</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">triggerList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_typeList">
typeList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_typeList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">135</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.135" class="phpdocumentor-element-found-in__source" data-line="135" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">SQL to show list of field types</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">typeList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, string&gt;</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, string&gt;</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_viewList">
viewList()
<a href="classes/Query-Drivers-Sqlite-SQL.html#method_viewList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Sqlite/SQL.php"><a href="files/src-drivers-sqlite-sql.html"><abbr title="src/Drivers/Sqlite/SQL.php">SQL.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">85</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-Drivers-Sqlite-SQL.html#source-view.85" class="phpdocumentor-element-found-in__source" data-line="85" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Returns sql to list views</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">viewList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Drivers/Sqlite/SQL.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">X</button>
</div>
</div>
<script type="text/javascript">
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};
xhr.send(null);
});
}
var modals = document.querySelectorAll("[data-modal]");
modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
</script>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/Query-Drivers-Sqlite-SQL.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink