65 lines
19 KiB
HTML
65 lines
19 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/awsql" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.7.0">
|
||
<title data-rh="true">awSQL | 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/awsql"><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="awSQL | awSQL Documentation"><meta data-rh="true" name="description" content="The default exported module that holds and manages all database instances globally."><meta data-rh="true" property="og:description" content="The default exported module that holds and manages all database instances globally."><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/awsql"><link data-rh="true" rel="alternate" href="https://your-docusaurus-site.example.com/awSQL/classes/awsql" hreflang="en"><link data-rh="true" rel="alternate" href="https://your-docusaurus-site.example.com/awSQL/classes/awsql" 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 menu__link--active" aria-current="page" 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" 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">awSQL</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>awSQL</h1></header>
|
||
<p>The default exported module that holds and manages all database instances globally.</p>
|
||
<p>It does not provide any additional functionality beyond managing instances.</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="createinstance">createInstance()<a href="#createinstance" class="hash-link" aria-label="Direct link to createInstance()" title="Direct link to createInstance()"></a></h3>
|
||
<p>→ (<code>hostname</code> = <strong>String</strong>, <code>username</code> = <strong>String</strong>, <code>password</code> = <strong>String</strong>, <code>options</code>? = {<code>charset</code>?: <strong>String</strong>, <code>defaultDatabase</code>?: <strong>String</strong>, <code>multipleStatements</code>?: <strong>Boolean</strong>, <code>insecureAuth</code>?: <strong>Boolean</strong>, <code>customIdentifier</code>?: <strong>String</strong>, <code>isDefault</code>?: <strong>Boolean</strong>}) → <a href="/awSQL/classes/instance">Instance</a></p>
|
||
<p>Creates a new database connection instance.</p>
|
||
<p><strong>Parameters</strong></p>
|
||
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>hostname</code></td><td><strong>String</strong></td><td>The database hostname.</td></tr><tr><td><code>username</code></td><td><strong>String</strong></td><td>The username for authentication.</td></tr><tr><td><code>password</code></td><td><strong>String</strong></td><td>The password for authentication.</td></tr><tr><td><code>options</code> <strong>optional</strong></td><td><strong>Object</strong></td><td>Additional settings for the instance.</td></tr><tr><td>→ <code>options.charset</code> <strong>optional</strong></td><td><strong>String</strong></td><td>The character set to use.</td></tr><tr><td>→ <code>options.defaultDatabase</code> <strong>optional</strong></td><td><strong>String</strong></td><td>Default database for queries.</td></tr><tr><td>→ <code>options.multipleStatements</code> <strong>optional</strong></td><td><strong>Boolean</strong></td><td>Allow multiple SQL statements in a single query (default: <code>false</code>).</td></tr><tr><td>→ <code>options.insecureAuth</code> <strong>optional</strong></td><td><strong>Boolean</strong></td><td>Enables insecure authentication methods (default: <code>false</code>).</td></tr><tr><td>→ <code>options.customIdentifier</code> <strong>optional</strong></td><td><strong>String</strong></td><td>Custom instance identifier. Defaults to <code>username@hostname</code>.</td></tr><tr><td>→ <code>options.isDefault</code> <strong>optional</strong></td><td><strong>Boolean</strong></td><td>Marks this instance as the default when no identifier is provided in <a href="#getinstance">getInstance()</a>.</td></tr></tbody></table>
|
||
<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>This method <strong>may crash</strong> if:</p><ul>
|
||
<li><code>password</code> or <code>username</code> is empty.</li>
|
||
<li>An instance with the same <code>identifier</code> already exists.</li>
|
||
</ul></div></div>
|
||
<p><strong>Returns</strong></p>
|
||
<p>→ <a href="/awSQL/classes/instance">Instance</a></p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="getinstance">getInstance()<a href="#getinstance" class="hash-link" aria-label="Direct link to getInstance()" title="Direct link to getInstance()"></a></h3>
|
||
<p>→ (<code>identifier</code>? = <strong>String</strong>) → <a href="/awSQL/classes/instance">Instance</a> / <strong>undefined</strong></p>
|
||
<p>Retrieves an existing database instance by its <code>identifier</code>.</p>
|
||
<p>If no identifier is provided and a default instance exists, it returns the default instance.</p>
|
||
<p><strong>Parameters</strong></p>
|
||
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>identifier</code> <strong>optional</strong></td><td><strong>String</strong></td><td>The name of the instance to retrieve. If no explicitly set with <code>customIdentifier</code>, instances are identified as <code>username@hostname</code>.</td></tr></tbody></table>
|
||
<p><strong>Returns</strong></p>
|
||
<ul>
|
||
<li><a href="/awSQL/classes/instance">Instance</a> - if found.</li>
|
||
<li><strong>undefined</strong> - if no instance matches the identifier.</li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="listinstances">listInstances()<a href="#listinstances" class="hash-link" aria-label="Direct link to listInstances()" title="Direct link to listInstances()"></a></h3>
|
||
<p>→ () → <strong>Array</strong><<strong>String</strong>></p>
|
||
<p>Returns a list of all defined instance identifiers.</p>
|
||
<p><strong>Returns</strong></p>
|
||
<p>→ <strong>Array</strong><<strong>String</strong>> - A list of instance identifiers.</p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="deleteinstance">deleteInstance()<a href="#deleteinstance" class="hash-link" aria-label="Direct link to deleteInstance()" title="Direct link to deleteInstance()"></a></h3>
|
||
<p>→ (<code>identifier</code> = <strong>String</strong>) → <strong>true</strong></p>
|
||
<p>Deletes an existing instance and closes its database connection.</p>
|
||
<p><strong>Parameters</strong></p>
|
||
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>identifier</code> <strong>optional</strong></td><td><strong>String</strong></td><td>The identifier of the instance to delete. If <code>customIdentifier</code> was not set, use <code>username@hostname</code>.</td></tr></tbody></table>
|
||
<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 Error</div><div class="admonitionContent_BuS1"><p>This method <strong>may crash</strong> if:</p><ul>
|
||
<li><code>identifier</code> is empty.<!-- -->
|
||
<ul>
|
||
<li>To delete the default instance, provide its <code>identifier</code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>identifier</code> is not a <code>String</code>.</li>
|
||
<li>No instance with the given <code>identifier</code> exists.</li>
|
||
</ul></div></div>
|
||
<p><strong>Returns</strong></p>
|
||
<p>→ <strong>true</strong> - Awayls returns <code>true</code>. Errors will cause an exception instead.</p>
|
||
<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/category/classes"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Classes</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/awSQL/classes/instance"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Instance</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="#createinstance" class="table-of-contents__link toc-highlight">createInstance()</a></li><li><a href="#getinstance" class="table-of-contents__link toc-highlight">getInstance()</a></li><li><a href="#listinstances" class="table-of-contents__link toc-highlight">listInstances()</a></li><li><a href="#deleteinstance" class="table-of-contents__link toc-highlight">deleteInstance()</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> |