86 lines
34 KiB
HTML
86 lines
34 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-classes/instance" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.7.0">
|
||
<title data-rh="true">Instance | awSQL Documentation</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://your-docusaurus-site.example.com/awSQL/classes/instance"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Instance | awSQL Documentation"><meta data-rh="true" name="description" content="Handles connection data and serves as the gateway for performing queries."><meta data-rh="true" property="og:description" content="Handles connection data and serves as the gateway for performing queries."><link data-rh="true" rel="icon" href="/awSQL/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://your-docusaurus-site.example.com/awSQL/classes/instance"><link data-rh="true" rel="alternate" href="https://your-docusaurus-site.example.com/awSQL/classes/instance" hreflang="en"><link data-rh="true" rel="alternate" href="https://your-docusaurus-site.example.com/awSQL/classes/instance" hreflang="x-default"><link rel="stylesheet" href="/awSQL/assets/css/styles.e478e7bb.css">
|
||
<script src="/awSQL/assets/js/runtime~main.4e405e56.js" defer="defer"></script>
|
||
<script src="/awSQL/assets/js/main.761e9406.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/awSQL/img/logo512_transparent.png"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><a class="navbar__brand" href="/awSQL/"><div class="navbar__logo"><img src="/awSQL/img/logo512_transparent.png" alt="awSQL Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/awSQL/img/logo512_transparent.png" alt="awSQL Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">awSQL Documentation</b></a></div><div class="navbar__items navbar__items--right"><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/awSQL/">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/awSQL/category/classes">Classes</a><button aria-label="Collapse sidebar category 'Classes'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/awSQL/classes/awsql">awSQL</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/awSQL/classes/instance">Instance</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/awSQL/classes/select">Select</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/awSQL/classes/insert">Insert</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/awSQL/classes/delete">Delete</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/awSQL/classes/update">Update</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/awSQL/classes/structure">Structure</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/awSQL/classes/create-table">CreateTable</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/awSQL/classes/alter-table">AlterTable</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/awSQL/category/typedefs">Typedefs</a><button aria-label="Expand sidebar category 'Typedefs'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/awSQL/category/example-database">Example Database</a><button aria-label="Expand sidebar category 'Example Database'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/awSQL/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/awSQL/category/classes"><span itemprop="name">Classes</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Instance</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Instance</h1></header>
|
||
<p>Handles connection data and serves as the gateway for performing queries.</p>
|
||
<p>Instances can be managed globally via <a href="/awSQL/classes/awsql">awSQL</a>.</p>
|
||
<hr>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="methods">Methods<a href="#methods" class="hash-link" aria-label="Direct link to Methods" title="Direct link to Methods"></a></h2>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="connect">connect()<a href="#connect" class="hash-link" aria-label="Direct link to connect()" title="Direct link to connect()"></a></h3>
|
||
<p><code>Promise</code> → () → <strong>String</strong></p>
|
||
<p>Establishes a connection to the database.</p>
|
||
<div class="theme-admonition theme-admonition-warning admonition_xJq3 alert alert--warning"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>Possible Errors</div><div class="admonitionContent_BuS1"><p>Throws an error if the connection fails.</p></div></div>
|
||
<p><strong>Returns</strong></p>
|
||
<p>→ <strong>String</strong> - Connection confirmation in the format: <code>"Connected to host with user user"</code></p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="destroy">destroy()<a href="#destroy" class="hash-link" aria-label="Direct link to destroy()" title="Direct link to destroy()"></a></h3>
|
||
<p>→ () → <strong>true</strong></p>
|
||
<p>Destroys the connection and releases resources.</p>
|
||
<p><strong>Returns</strong></p>
|
||
<p>→ <strong>true</strong> - Always returns <code>true</code> unless an error occurs.</p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="queryraw">queryRaw()<a href="#queryraw" class="hash-link" aria-label="Direct link to queryRaw()" title="Direct link to queryRaw()"></a></h3>
|
||
<p><code>async</code> → (<code>queryString</code> = <strong>String</strong>, <code>values</code>? = <strong>Array</strong><<strong>any</strong>>) → <strong>any</strong></p>
|
||
<p>Executes a raw SQL query.</p>
|
||
<div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>Security Tip</div><div class="admonitionContent_BuS1"><p>Use <code>?</code> placeholders and pass values seperately to prevent SQL injection.</p></div></div>
|
||
<p><strong>Parameters</strong></p>
|
||
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>queryString</code></td><td><strong>String</strong></td><td>SQL query to execute.</td></tr><tr><td><code>values</code></td><td><strong>Array</strong><<strong>any</strong>></td><td>Values for placeholders (<code>?</code>), in left-to-right order.</td></tr></tbody></table>
|
||
<p><strong>Returns</strong></p>
|
||
<p>→ <strong>any</strong> - Query Result</p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="getdatabases">getDatabases()<a href="#getdatabases" class="hash-link" aria-label="Direct link to getDatabases()" title="Direct link to getDatabases()"></a></h3>
|
||
<p><code>async</code> → (<code>excludeSchema</code>? = <strong>Boolean</strong>) → <strong>Array</strong><<strong>String</strong>></p>
|
||
<p>Retrieves a list of databases accessible to the user.</p>
|
||
<p><strong>Parameters</strong></p>
|
||
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>excludeSchema</code> <strong>option</strong></td><td><strong>Boolean</strong></td><td>Excludes <code>information_schema</code> if <code>true</code></td></tr></tbody></table>
|
||
<p><strong>Returns</strong></p>
|
||
<p>→ <strong>Array</strong><<strong>String</strong>> - List of database names.</p>
|
||
<p><strong>Example</strong></p>
|
||
<div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-js codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv codeBlockLinesWithNumbering_o6Pm"><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> databases </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword control-flow" style="color:#00009f">await</span><span class="token plain"> instance</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">getDatabases</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"></span><span class="token console class-name">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">databases</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// ['awSQL_dev','information_schema']</span></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_Ktv7">Excluding default database 'information_schema'</div><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-js codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv codeBlockLinesWithNumbering_o6Pm"><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> databasesWithoutSchema </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword control-flow" style="color:#00009f">await</span><span class="token plain"> instance</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">getDatabases</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"></span><span class="token console class-name">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">databasesWithoutSchema</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// ['awSQL_dev']</span></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="selectdatabase">selectDatabase()<a href="#selectdatabase" class="hash-link" aria-label="Direct link to selectDatabase()" title="Direct link to selectDatabase()"></a></h3>
|
||
<p>→ (<code>name</code> = <strong>String</strong>) → <code>this</code></p>
|
||
<p>Sets a default database for future queries.</p>
|
||
<p><strong>Parameters</strong></p>
|
||
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>name</code></td><td><strong>String</strong></td><td>The database to select</td></tr></tbody></table>
|
||
<p><strong>Returns</strong></p>
|
||
<p>→ <code>this</code></p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="gettables">getTables()<a href="#gettables" class="hash-link" aria-label="Direct link to getTables()" title="Direct link to getTables()"></a></h3>
|
||
<p>→ (<code>database</code>? = <strong>String</strong>) → <strong>Array</strong><<strong>String</strong>></p>
|
||
<p>Retrieves a list of tables in the selected database.</p>
|
||
<div class="theme-admonition theme-admonition-warning admonition_xJq3 alert alert--warning"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>Possible Errors</div><div class="admonitionContent_BuS1"><p>Requires <code>options.multipleStatements</code> set to <code>true</code> at instance creation.</p></div></div>
|
||
<p><strong>Returns</strong></p>
|
||
<p>→ <strong>Array</strong><<strong>String</strong>></p>
|
||
<p><strong>Example Usage</strong></p>
|
||
<div class="language-js codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-js codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv codeBlockLinesWithNumbering_o6Pm"><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> tables </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword control-flow" style="color:#00009f">await</span><span class="token plain"> instance</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">getTables</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">"awSQL_dev"</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"></span><span class="token console class-name">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">tables</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_Ktv7">Result</div><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv codeBlockLinesWithNumbering_o6Pm"><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"></span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> 'Categories'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> 'Customers'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> 'Employees'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> 'OrderDetails'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> 'Orders'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> 'Products'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> 'Shippers'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"> 'Suppliers'</span></span><br></span><span class="token-line codeLine_lJS_" style="color:#393A34"><span class="codeLineNumber_Tfdd"></span><span class="codeLineContent_feaV"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">]</span></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="query-builders">Query Builders<a href="#query-builders" class="hash-link" aria-label="Direct link to Query Builders" title="Direct link to Query Builders"></a></h3>
|
||
<p>These methods return specialized query objects that allow for structured queries:</p>
|
||
<table><thead><tr><th>Method</th><th>Description</th><th>Returns</th></tr></thead><tbody><tr><td><code>.select(from, ...columns?)</code></td><td>Prepare a <code>SELECT</code> query.</td><td><a href="/awSQL/classes/select">Select</a></td></tr><tr><td><code>.insert(into)</code></td><td>Prepare an <code>INSERT</code> query.</td><td><a href="/awSQL/classes/insert">Insert</a></td></tr><tr><td><code>.delete(from)</code></td><td>Prepare a <code>DELETE</code> query.</td><td><a href="/awSQL/classes/delete">Delete</a></td></tr><tr><td><code>.update(table)</code></td><td>Prepare an <code>UPDATE</code> query.</td><td><a href="/awSQL/classes/update">Update</a></td></tr></tbody></table>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="database--table-management">Database & Table Management<a href="#database--table-management" class="hash-link" aria-label="Direct link to Database & Table Management" title="Direct link to Database & Table Management"></a></h3>
|
||
<table><thead><tr><th>Method</th><th>Description</th><th>Returns</th></tr></thead><tbody><tr><td><code>.dropDatabase(database)</code></td><td>Deletes an entire database (<em>requires admin privileges</em>).</td><td><a href="/awSQL/typedefs/okpacket">OkPacket</a></td></tr><tr><td><code>.dropTable(table)</code></td><td>Deletes a table (<em>default database must be set</em>).</td><td><a href="/awSQL/typedefs/okpacket">OkPacket</a></td></tr><tr><td><code>.createDatabase(name)</code></td><td>Creates a new database (<em>fails if it already exists</em>).</td><td><a href="/awSQL/typedefs/okpacket">OkPacket</a></td></tr><tr><td><code>.createTable(name)</code></td><td>Prepares a new table creation query.</td><td><a href="/awSQL/classes/create-table">CreateTable</a></td></tr><tr><td><code>.alterTable(name)</code></td><td>Prepares a table modification query.</td><td><a href="/awSQL/classes/alter-table">AlterTable</a></td></tr></tbody></table>
|
||
<div class="theme-admonition theme-admonition-danger admonition_xJq3 alert alert--danger"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"></path></svg></span>Potential Errors</div><div class="admonitionContent_BuS1"><ul>
|
||
<li>Creating a database requires <strong>admin privileges</strong>.</li>
|
||
<li>Dropping a table reqeuires <strong>a default database to be selected</strong>.</li>
|
||
</ul></div></div>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="structure-management">Structure Management<a href="#structure-management" class="hash-link" aria-label="Direct link to Structure Management" title="Direct link to Structure Management"></a></h3>
|
||
<table><thead><tr><th>Method</th><th>Description</th><th>Returns</th></tr></thead><tbody><tr><td><code>.createStructure()</code></td><td>Creates a structure object.</td><td><a href="/awSQL/classes/structure">Structure</a></td></tr><tr><td><code>.getStructure(table, database?)</code></td><td>Retrieves the structure of a table.</td><td><a href="/awSQL/classes/structure">Structure</a></td></tr><tr><td><code>.checkStructure(table, desiredStructure, database?)</code></td><td>Compares a table's structure with the expected one.</td><td><code>{ errors: [], passed: [] }</code> <br>✅ If errors.length === 0, the structure is correct.</td></tr></tbody></table>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="utility-methods">Utility Methods<a href="#utility-methods" class="hash-link" aria-label="Direct link to Utility Methods" title="Direct link to Utility Methods"></a></h3>
|
||
<table><thead><tr><th>Method</th><th>Description</th><th>Returns</th></tr></thead><tbody><tr><td><code>.total(table)</code></td><td>Counts total rows in a table. (<em>Requires a default database</em>).</td><td><code>Number</code></td></tr><tr><td><code>.isConnected()</code></td><td>Checks if the instance is connected.</td><td><code>Boolean</code></td></tr></tbody></table>
|
||
<hr></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/awSQL/classes/awsql"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">awSQL</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/awSQL/classes/select"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Select</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#methods" class="table-of-contents__link toc-highlight">Methods</a><ul><li><a href="#connect" class="table-of-contents__link toc-highlight">connect()</a></li><li><a href="#destroy" class="table-of-contents__link toc-highlight">destroy()</a></li><li><a href="#queryraw" class="table-of-contents__link toc-highlight">queryRaw()</a></li><li><a href="#getdatabases" class="table-of-contents__link toc-highlight">getDatabases()</a></li><li><a href="#selectdatabase" class="table-of-contents__link toc-highlight">selectDatabase()</a></li><li><a href="#gettables" class="table-of-contents__link toc-highlight">getTables()</a></li><li><a href="#query-builders" class="table-of-contents__link toc-highlight">Query Builders</a></li><li><a href="#database--table-management" class="table-of-contents__link toc-highlight">Database & Table Management</a></li><li><a href="#structure-management" class="table-of-contents__link toc-highlight">Structure Management</a></li><li><a href="#utility-methods" class="table-of-contents__link toc-highlight">Utility Methods</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 awSQL by Sam</div></div></div></footer></div>
|
||
</body>
|
||
</html> |