1 line
12 KiB
JavaScript
1 line
12 KiB
JavaScript
"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[23],{6986:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>a,frontMatter:()=>d,metadata:()=>t,toc:()=>h});const t=JSON.parse('{"id":"classes/awsql","title":"awSQL","description":"This is the default exported module that holds all Instances and manages them.","source":"@site/docs/classes/awsql.md","sourceDirName":"classes","slug":"/classes/awsql","permalink":"/awSQL/classes/awsql","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"defaultSidebar","previous":{"title":"Classes","permalink":"/awSQL/category/classes"},"next":{"title":"Instance","permalink":"/awSQL/classes/instance"}}');var i=s(4848),r=s(8453);const d={sidebar_position:1},c="awSQL",l={},h=[{value:"Methods",id:"methods",level:2},{value:"createInstance()",id:"createinstance",level:3},{value:"getInstance()",id:"getinstance",level:3},{value:"listInstances()",id:"listinstances",level:3},{value:"deleteInstance()",id:"deleteinstance",level:3}];function o(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"awsql",children:"awSQL"})}),"\n",(0,i.jsx)(n.p,{children:"This is the default exported module that holds all Instances and manages them."}),"\n",(0,i.jsx)(n.p,{children:"It does not provide any functionality on top of managing instances globally."}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"createinstance",children:"createInstance()"}),"\n",(0,i.jsxs)(n.p,{children:["\u2192 (",(0,i.jsx)(n.code,{children:"hostname"})," = ",(0,i.jsx)(n.strong,{children:"String"}),", ",(0,i.jsx)(n.code,{children:"username"})," = ",(0,i.jsx)(n.strong,{children:"String"}),", ",(0,i.jsx)(n.code,{children:"password"})," = ",(0,i.jsx)(n.strong,{children:"String"}),", ",(0,i.jsx)(n.code,{children:"options"}),"? = {",(0,i.jsx)(n.code,{children:"charset"}),"?: ",(0,i.jsx)(n.strong,{children:"String"}),", ",(0,i.jsx)(n.code,{children:"defaultDatabase"}),"?: ",(0,i.jsx)(n.strong,{children:"String"}),", ",(0,i.jsx)(n.code,{children:"multipleStatements"}),"?: ",(0,i.jsx)(n.strong,{children:"Boolean"}),", ",(0,i.jsx)(n.code,{children:"insecureAuth"}),"?: ",(0,i.jsx)(n.strong,{children:"Boolean"}),", ",(0,i.jsx)(n.code,{children:"customIdentifier"}),"?: ",(0,i.jsx)(n.strong,{children:"String"}),", ",(0,i.jsx)(n.code,{children:"isDefault"}),"?: ",(0,i.jsx)(n.strong,{children:"Boolean"}),"}) \u2192 ",(0,i.jsx)(n.a,{href:"./instance",children:"Instance"})]}),"\n",(0,i.jsx)(n.p,{children:"Creates a new instance to connect to a database."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Parameters"})}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Parameter"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"hostname"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"String"})}),(0,i.jsx)(n.td,{children:"The hostname where the database is hosted"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"username"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"String"})}),(0,i.jsx)(n.td,{children:"Username to connect with"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"password"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"String"})}),(0,i.jsx)(n.td,{children:"Password"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:[(0,i.jsx)(n.code,{children:"options"})," ",(0,i.jsx)(n.strong,{children:"optional"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"Object"})}),(0,i.jsx)(n.td,{children:"Additional options"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:["\u2192 ",(0,i.jsx)(n.code,{children:"options.charset"})," ",(0,i.jsx)(n.strong,{children:"optional"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"String"})}),(0,i.jsx)(n.td,{children:"The charset to use"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:["\u2192 ",(0,i.jsx)(n.code,{children:"options.defaultDatabase"})," ",(0,i.jsx)(n.strong,{children:"optional"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"String"})}),(0,i.jsx)(n.td,{children:"The default database to select for queries"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:["\u2192 ",(0,i.jsx)(n.code,{children:"options.multipleStatements"})," ",(0,i.jsx)(n.strong,{children:"optional"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"Boolean"})}),(0,i.jsxs)(n.td,{children:["Whether to allow multiple statements in a single query. Defaults to ",(0,i.jsx)(n.code,{children:"false"})]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:["\u2192 ",(0,i.jsx)(n.code,{children:"options.insecureAuth"})," ",(0,i.jsx)(n.strong,{children:"optional"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"Boolean"})}),(0,i.jsxs)(n.td,{children:["Whether insecure authentication methods should be allowed. Defaults to ",(0,i.jsx)(n.code,{children:"false"})]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:["\u2192 ",(0,i.jsx)(n.code,{children:"options.customIdentifier"})," ",(0,i.jsx)(n.strong,{children:"optional"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"String"})}),(0,i.jsxs)(n.td,{children:["Sets a custom identifier for this instance. Instances can be fetched by ",(0,i.jsx)(n.a,{href:"#getInstance",children:"getInstance()"}),' with this identifier. If not set, the identifier will be "',(0,i.jsx)(n.code,{children:"username"}),"@",(0,i.jsx)(n.code,{children:"hostname"}),'" by default.']})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:["\u2192 ",(0,i.jsx)(n.code,{children:"options.isDefault"})," ",(0,i.jsx)(n.strong,{children:"optional"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"Boolean"})}),(0,i.jsxs)(n.td,{children:["Whether this instance is returned by default via ",(0,i.jsx)(n.a,{href:"#getInstance",children:"getInstance()"})," if the given identifier is empty or not retrievable"]})]})]})]}),"\n",(0,i.jsxs)(n.admonition,{title:"Possible errors",type:"warning",children:[(0,i.jsx)(n.p,{children:"This might crash if either of these situations happen:"}),(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"password"})," is empty"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"username"})," is empty"]}),"\n",(0,i.jsxs)(n.li,{children:["An instance with the same ",(0,i.jsx)(n.code,{children:"identifier"})," already exists"]}),"\n"]})]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Returns"})}),"\n",(0,i.jsxs)(n.p,{children:["\u2192 ",(0,i.jsx)(n.a,{href:"./instance",children:"Instance"})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"getinstance",children:"getInstance()"}),"\n",(0,i.jsxs)(n.p,{children:["\u2192 (",(0,i.jsx)(n.code,{children:"identifier"}),"? = ",(0,i.jsx)(n.strong,{children:"String"}),") \u2192 ",(0,i.jsx)(n.a,{href:"./instance",children:"Instance"})," / ",(0,i.jsx)(n.strong,{children:"undefined"})]}),"\n",(0,i.jsxs)(n.p,{children:["Returns an already defined instance with the given ",(0,i.jsx)(n.code,{children:"identifier"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["If a default instance was set it returns said instance if the ",(0,i.jsx)(n.code,{children:"identifier"})," is empty."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Parameters"})}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Parameter"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsx)(n.tbody,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:[(0,i.jsx)(n.code,{children:"identifier"})," ",(0,i.jsx)(n.strong,{children:"optional"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"String"})}),(0,i.jsxs)(n.td,{children:["The instance name to retrieve. Note: If not set with ",(0,i.jsx)(n.code,{children:"options.customIdentifier"}),' upon creation instances will be identified by "',(0,i.jsx)(n.code,{children:"username"}),"@",(0,i.jsx)(n.code,{children:"hostname"}),'".',(0,i.jsx)("br",{})," If not given it returns the defined default instance."]})]})})]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Returns"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"./instance",children:"Instance"})," - Instance was found"]}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"undefined"})}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"listinstances",children:"listInstances()"}),"\n",(0,i.jsxs)(n.p,{children:["\u2192 () \u2192 ",(0,i.jsx)(n.strong,{children:"Array"}),"<",(0,i.jsx)(n.strong,{children:"String"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"Returns a list of defined instance identifiers"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Returns"})}),"\n",(0,i.jsxs)(n.p,{children:["\u2192 ",(0,i.jsx)(n.strong,{children:"Array"}),"<",(0,i.jsx)(n.strong,{children:"String"}),">"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"deleteinstance",children:"deleteInstance()"}),"\n",(0,i.jsxs)(n.p,{children:["\u2192 (",(0,i.jsx)(n.code,{children:"identifier"})," = ",(0,i.jsx)(n.strong,{children:"String"}),") \u2192 ",(0,i.jsx)(n.strong,{children:"true"})]}),"\n",(0,i.jsx)(n.p,{children:"Deletes an instance and closes any open connection"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Parameters"})}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Parameter"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsx)(n.tbody,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:[(0,i.jsx)(n.code,{children:"identifier"})," ",(0,i.jsx)(n.strong,{children:"optional"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:"String"})}),(0,i.jsxs)(n.td,{children:["The instance to delete. Note: If not set with ",(0,i.jsx)(n.code,{children:"options.customIdentifier"}),' upon creation instances will be identified by "',(0,i.jsx)(n.code,{children:"username"}),"@",(0,i.jsx)(n.code,{children:"hostname"}),'".']})]})})]}),"\n",(0,i.jsxs)(n.admonition,{title:"Possible crash",type:"warning",children:[(0,i.jsx)(n.p,{children:"This might crash if either of these situations happen:"}),(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"identifier"})," is empty","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["To delete the default instance you must provide the ",(0,i.jsx)(n.code,{children:"identifier"})," of the default instance."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"identifier"})," is not of type ",(0,i.jsx)(n.strong,{children:"String"})]}),"\n",(0,i.jsxs)(n.li,{children:["No instance with the given ",(0,i.jsx)(n.code,{children:"identifier"})," was found"]}),"\n"]})]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Returns"})}),"\n",(0,i.jsxs)(n.p,{children:["\u2192 ",(0,i.jsx)(n.strong,{children:"true"})]}),"\n",(0,i.jsx)(n.admonition,{type:"info",children:(0,i.jsx)(n.p,{children:"Always returns true, as it will throw if any error happens to be sure any deletion was intended and correctly called."})})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>c});var t=s(6540);const i={},r=t.createContext(i);function d(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); |