1 line
3.7 KiB
JavaScript
1 line
3.7 KiB
JavaScript
"use strict";(self.webpackChunkdocusaurus=self.webpackChunkdocusaurus||[]).push([[976],{7879:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>t,toc:()=>d});const t=JSON.parse('{"id":"intro","title":"Introduction","description":"awSQL is a fast and reliable database query tool designed to:","source":"@site/docs/intro.md","sourceDirName":".","slug":"/","permalink":"/awSQL/","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"sidebar_position":1,"slug":"/"},"sidebar":"defaultSidebar","next":{"title":"Classes","permalink":"/awSQL/category/classes"}}');var i=s(4848),r=s(8453);const a={sidebar_position:1,slug:"/"},l="Introduction",o={},d=[{value:"Getting Started",id:"getting-started",level:2},{value:"Exports",id:"exports",level:2}];function c(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",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:"introduction",children:"Introduction"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.em,{children:"awSQL"})," is a fast and reliable database query tool designed to:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"\u2705 Minimize the risk of SQL injections"}),"\n",(0,i.jsx)(n.li,{children:"\u2705 Maximize usability and safety"}),"\n",(0,i.jsx)(n.li,{children:"\u2705 Prevent accidental bulk row modifications"}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["With awSQL, you can programmatically interact with databases in a clear and intuitive manner - ",(0,i.jsx)(n.em,{children:"no more writing complex SQL queries manually!"})]}),"\n",(0,i.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Requirements"})}),"\n",(0,i.jsx)(n.p,{children:"To begin, ensure you have:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["A ",(0,i.jsx)(n.em,{children:"hosted database"})]}),"\n",(0,i.jsxs)(n.li,{children:["Your ",(0,i.jsx)(n.em,{children:"database credentials"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Installation"})}),"\n",(0,i.jsxs)(n.p,{children:["Install ",(0,i.jsx)(n.code,{children:"awSQL"})," via ",(0,i.jsx)(n.strong,{children:"npm"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",metastring:"showLineNumbers",children:"npm i git+https://git.pwcca.eu/Sam/awSQL.git#release\n"})}),"\n",(0,i.jsx)(n.admonition,{title:"Important",type:"warning",children:(0,i.jsxs)(n.p,{children:["Always use the ",(0,i.jsx)(n.code,{children:"#release"})," branch to avoid downloading the development version."]})}),"\n",(0,i.jsx)(n.h2,{id:"exports",children:"Exports"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"awSQL"})," provides two core modules:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"./classes/awSQL",children:"awSQL"})," - The main database instance"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"./classes/structure",children:"Structure"})," - A module for defining table structures"]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>l});var t=s(6540);const i={},r=t.createContext(i);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); |