<!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-pgsql.html">Pgsql</a></li> </ul> <article class="phpdocumentor-element -class"> <h2 class="phpdocumentor-content__title"> Util <span class="phpdocumentor-element__extends"> extends <a href="classes/Query-Drivers-AbstractUtil.html"><abbr title="\Query\Drivers\AbstractUtil">AbstractUtil</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/Pgsql/Util.php"><a href="files/src-drivers-pgsql-util.html"><abbr title="src/Drivers/Pgsql/Util.php">Util.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">24</span> <a href="classes/Query-Drivers-Pgsql-Util.html#source-view.24" class="phpdocumentor-element-found-in__source" data-line="24" data-modal="source-view"></a> </aside> <p class="phpdocumentor-summary">Postgres-specific backup, import and creation methods</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-AbstractUtil.html#method___construct">__construct()</a> <span> : mixed </span> </dt> <dd>Save a reference to the connection object for later use</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/Query-Drivers-Pgsql-Util.html#method_backupData">backupData()</a> <span> : string </span> </dt> <dd>Create an SQL backup file for the current database's data</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/Query-Drivers-Pgsql-Util.html#method_backupStructure">backupStructure()</a> <span> : string </span> </dt> <dd>Create an SQL backup file for the current database's structure</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/Query-Drivers-AbstractUtil.html#method_createTable">createTable()</a> <span> : string </span> </dt> <dd>Convenience public function to generate sql for creating a db table</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/Query-Drivers-AbstractUtil.html#method_deleteTable">deleteTable()</a> <span> : string </span> </dt> <dd>Drop the selected table</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/Query-Drivers-AbstractUtil.html#method_getDriver">getDriver()</a> <span> : <a href="classes/Query-Drivers-DriverInterface.html"><abbr title="\Query\Drivers\DriverInterface">DriverInterface</abbr></a> </span> </dt> <dd>Get the driver object for the current connection</dd> </dl> <section class="phpdocumentor-methods"> <h3 class="phpdocumentor-elements__header" id="methods"> Methods <a href="classes/Query-Drivers-Pgsql-Util.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___construct"> __construct() <a href="classes/Query-Drivers-AbstractUtil.html#method___construct" 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/AbstractUtil.php"><a href="files/src-drivers-abstractutil.html"><abbr title="src/Drivers/AbstractUtil.php">AbstractUtil.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">26</span> <a href="classes/Query-Drivers-Pgsql-Util.html#source-view.26" class="phpdocumentor-element-found-in__source" data-line="26" data-modal="source-view"></a> </aside> <p class="phpdocumentor-summary">Save a reference to the connection object for later use</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-Drivers-DriverInterface.html"><abbr title="\Query\Drivers\DriverInterface">DriverInterface</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$connection</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$connection</span> : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-Drivers-DriverInterface.html"><abbr title="\Query\Drivers\DriverInterface">DriverInterface</abbr></a></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">mixed</span> — </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_backupData"> backupData() <a href="classes/Query-Drivers-Pgsql-Util.html#method_backupData" 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/Pgsql/Util.php"><a href="files/src-drivers-pgsql-util.html"><abbr title="src/Drivers/Pgsql/Util.php">Util.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">38</span> <a href="classes/Query-Drivers-Pgsql-Util.html#source-view.38" class="phpdocumentor-element-found-in__source" data-line="38" data-modal="source-view"></a> </aside> <p class="phpdocumentor-summary">Create an SQL backup file for the current database's data</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">backupData</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$exclude</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</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">$exclude</span> : <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span> = <span class="phpdocumentor-signature__argument__default-value">[]</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> — </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_backupStructure"> backupStructure() <a href="classes/Query-Drivers-Pgsql-Util.html#method_backupStructure" 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/Pgsql/Util.php"><a href="files/src-drivers-pgsql-util.html"><abbr title="src/Drivers/Pgsql/Util.php">Util.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">29</span> <a href="classes/Query-Drivers-Pgsql-Util.html#source-view.29" class="phpdocumentor-element-found-in__source" data-line="29" data-modal="source-view"></a> </aside> <p class="phpdocumentor-summary">Create an SQL backup file for the current database's structure</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">backupStructure</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> — </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_createTable"> createTable() <a href="classes/Query-Drivers-AbstractUtil.html#method_createTable" 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/AbstractUtil.php"><a href="files/src-drivers-abstractutil.html"><abbr title="src/Drivers/AbstractUtil.php">AbstractUtil.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">41</span> <a href="classes/Query-Drivers-Pgsql-Util.html#source-view.41" class="phpdocumentor-element-found-in__source" data-line="41" data-modal="source-view"></a> </aside> <p class="phpdocumentor-summary">Convenience public function to generate sql for creating a db table</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">createTable</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$constraints</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$ifNotExists</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</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">$name</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">$fields</span> : <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></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">$constraints</span> : <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span> = <span class="phpdocumentor-signature__argument__default-value">[]</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">$ifNotExists</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span> = <span class="phpdocumentor-signature__argument__default-value">TRUE</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> — </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_deleteTable"> deleteTable() <a href="classes/Query-Drivers-AbstractUtil.html#method_deleteTable" 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/AbstractUtil.php"><a href="files/src-drivers-abstractutil.html"><abbr title="src/Drivers/AbstractUtil.php">AbstractUtil.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">78</span> <a href="classes/Query-Drivers-Pgsql-Util.html#source-view.78" class="phpdocumentor-element-found-in__source" data-line="78" data-modal="source-view"></a> </aside> <p class="phpdocumentor-summary">Drop the selected table</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">deleteTable</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</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">$name</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> — </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_getDriver"> getDriver() <a href="classes/Query-Drivers-AbstractUtil.html#method_getDriver" 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/AbstractUtil.php"><a href="files/src-drivers-abstractutil.html"><abbr title="src/Drivers/AbstractUtil.php">AbstractUtil.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">33</span> <a href="classes/Query-Drivers-Pgsql-Util.html#source-view.33" class="phpdocumentor-element-found-in__source" data-line="33" data-modal="source-view"></a> </aside> <p class="phpdocumentor-summary">Get the driver object for the current connection</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">getDriver</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Query-Drivers-DriverInterface.html"><abbr title="\Query\Drivers\DriverInterface">DriverInterface</abbr></a></span></code> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type"><a href="classes/Query-Drivers-DriverInterface.html"><abbr title="\Query\Drivers\DriverInterface">DriverInterface</abbr></a></span> — </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/Pgsql/Util.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-Pgsql-Util.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>