https://www.askyourdatabase.com/_next/static/chunks/pages/docs-0205b5a6e24bf671.js

1(self.webpackChunk_N_E=self.webpackChunk_N_E||[]).push([[3172],{2778:function(e,a,t){(window.__NEXT_P=window.__NEXT_P||[]).push(["/docs",function(){return t(88448)}])},44475:function(e,a,t){"use strict";var o=t(11527),n=t(70965),s=t.n(n),r=t(32715),i=t(21035);let d={logo:(0,o.jsxs)("div",{style:{flex:1,display:"flex",alignItems:"center",gap:16},children:[(0,o.jsx)(s(),{src:"/logo-light.png",alt:"AskYourDatabase logo",width:"30",height:"30",className:"mr-4 rounded-sm p-1"}),(0,o.jsx)("p",{style:{fontWeight:"bold",fontSize:16},children:"AskYourDatabase"})]}),chat:{link:"https://discord.com/invite/AZ2WnRxTD8"},footer:{text:"AskYourDatabase \xa9 2023"},useNextSeoProps(){let{asPath:e}=(0,r.useRouter)(),a=e.split(/[?#]/)[0].replace(/\/$/,"")||"/";return{canonical:"https://www.askyourdatabase.com".concat(a),titleTemplate:"%s – AskYourDatabase"}},head:()=>{let{asPath:e,defaultLocale:a,locale:t}=(0,r.useRouter)(),{frontMatter:n}=(0,i.ZR)(),s="https://www.askyourdatabase.com"+(a===t?e:"/".concat(t).concat(e)).split(/[?#]/)[0].replace(/\/$/,"");return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("meta",{property:"og:url",content:s}),(0,o.jsx)("meta",{property:"og:title",content:n.title||"AskYourDatabase"}),(0,o.jsx)("meta",{property:"og:description",content:n.description||"AskYourDatabase - the ChatGPT for SQL"})]})},i18n:[{locale:"en-US",text:"English"}]};a.Z=d},88448:function(e,a,t){"use strict";t.r(a),t.d(a,{__toc:function(){return d}});var o=t(11527),n=t(94482),s=t(21035),r=t(44475);t(15954);var i=t(12175);let d=[{depth:2,value:"Three Main Use Cases",id:"three-main-use-cases"},{depth:3,value:"Customer-facing BI Chatbot",id:"customer-facing-bi-chatbot"},{depth:3,value:"Dashboard Builder",id:"dashboard-builder"},{depth:3,value:"Internal Tools",id:"internal-tools"},{depth:2,value:"Learn more",id:"learn-more"}];function c(e){let a=Object.assign({h1:"h1",h2:"h2",p:"p",h3:"h3",a:"a",ul:"ul",li:"li",ol:"ol"},(0,i.a)(),e.components);return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(a.h1,{children:"Getting Started"}),"\n",(0,o.jsx)(a.h2,{id:"three-main-use-cases",children:"Three Main Use Cases"}),"\n",(0,o.jsx)(a.p,{children:"As you know, AskYourDatabase is a tool that allows you to query your database using natural language. Currently, we have three main use cases for AskYourDatabase:"}),"\n",(0,o.jsx)(a.h3,{id:"customer-facing-bi-chatbot",children:"Customer-facing BI Chatbot"}),"\n",(0,o.jsx)(a.p,{children:"If you need to provide a BI dashboard for your customers, their needs vary, making it hard to create a dashboard that fits all customers' needs."}),"\n",(0,o.jsx)(a.p,{children:"Continuously adding features to a BI dashboard will make it more complex and harder to use, and your engineers will become busier."}),"\n",(0,o.jsx)(a.p,{children:"With AskYourDatabase Chatbot, you can provide a chatbot to your customers enabling them to ask for ad-hoc queries, freeing your engineers and providing a better user experience."}),"\n",(0,o.jsxs)(a.p,{children:["For how to create a chatbot, please refer to ",(0,o.jsx)(a.a,{href:"/docs/chatbot",children:"this doc"}),"."]}),"\n",(0,o.jsx)(a.h3,{id:"dashboard-builder",children:"Dashboard Builder"}),"\n",(0,o.jsx)(a.p,{children:"If you need to create real-time, interactive dashboards, AskYourDatabase Dashboard Builder allows you to build them using natural language. Key features include:"}),"\n",(0,o.jsxs)(a.ul,{children:["\n",(0,o.jsx)(a.li,{children:"Build dashboards by describing what you want in plain English"}),"\n",(0,o.jsx)(a.li,{children:"Real-time data operations (CRUD)"}),"\n",(0,o.jsx)(a.li,{children:"Rich components like tables, charts, and forms"}),"\n",(0,o.jsx)(a.li,{children:"Share with team members or embed in your website"}),"\n"]}),"\n",(0,o.jsx)(a.p,{children:"You can create professional dashboards without writing any SQL or complex queries. The AI will generate the dashboard based on your database structure and description."}),"\n",(0,o.jsxs)(a.p,{children:["For how to create dashboards, please refer to ",(0,o.jsx)(a.a,{href:"/docs/dashboard",children:"this doc"}),"."]}),"\n",(0,o.jsx)(a.h3,{id:"internal-tools",children:"Internal Tools"}

1),"\n",(0,o.jsxs)(a.p,{children:["For desktop analysis, ",(0,o.jsx)(a.a,{href:"/download",children:"download AskYourDatabase for macOS or Windows"}),". The download guide covers account sign-in, database access, and a first query to validate your setup."]}),"\n",(0,o.jsx)(a.p,{children:"You must need an admin dashboard to manage or monitor your business, and you may use tools like PowerBI or Retool to build the app and consume it."}),"\n",(0,o.jsx)(a.p,{children:"But with AskYourDatabase, you typically don't have to build any internal tools. You just have to connect to your database, and you are ready to go for various tasks including:"}),"\n",(0,o.jsxs)(a.ol,{children:["\n",(0,o.jsx)(a.li,{children:"Business intelligence"}),"\n",(0,o.jsx)(a.li,{children:"Inserting data"}),"\n",(0,o.jsx)(a.li,{children:"Updating data"}),"\n",(0,o.jsx)(a.li,{children:"Reporting"}),"\n",(0,o.jsx)(a.li,{children:"Data analysis"}),"\n"]}),"\n",(0,o.jsxs)(a.p,{children:["For how to connect to your database, please refer to ",(0,o.jsx)(a.a,{href:"/docs/connect",children:"this doc"}),". You can also view videos created by community members, like ",(0,o.jsx)(a.a,{href:"https://www.youtube.com/watch?v=wQOoOw6RARo&t=355s",children:"this one"}),"."]}),"\n",(0,o.jsx)(a.h2,{id:"learn-more",children:"Learn more"}),"\n",(0,o.jsx)(a.p,{children:"Frequently read docs are:"}),"\n",(0,o.jsxs)(a.ol,{children:["\n",(0,o.jsx)(a.li,{children:(0,o.jsx)(a.a,{href:"/docs/connect",children:"Prepare Your Database Connection String"})}),"\n",(0,o.jsx)(a.li,{children:(0,o.jsx)(a.a,{href:"/docs/tips",children:"Get Better Answer"})}),"\n",(0,o.jsx)(a.li,{children:(0,o.jsx)(a.a,{href:"/docs/train",children:"Training for Better Answers"})}),"\n",(0,o.jsx)(a.li,{children:(0,o.jsx)(a.a,{href:"/docs/dashboard",children:"Dashboard Builder Guide"})}),"\n"]})]})}let l={MDXContent:function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},{wrapper:a}=Object.assign({},(0,i.a)(),e.components);return a?(0,o.jsx)(a,{...e,children:(0,o.jsx)(c,{...e})}):c(e)},pageOpts:{filePath:"pages/docs/index.mdx",route:"/docs",timestamp:1789698706e3,pageMap:[{kind:"Meta",data:{index:{type:"page",title:"Nextra",display:"hidden",theme:{layout:"raw"}},docs:{type:"page",title:"Documentation"}}},{kind:"Folder",name:"docs",route:"/docs",children:[{kind:"Meta",data:{"-- Tutorial":{type:"separator",title:"Tutorial"},index:"Getting Started",tips:"Get better answer",train:"Train to get better answer",connect:"Prepare Database Connection String","sample-db":"Sample Databases",webhook:"Webhook","-- Privacy, Data Protection, and Security":{type:"separator",title:"Privacy, Data Protection, and Security"},security:"Security Portal","privacy-policy":"Privacy Policy","terms-and-conditions":"Terms and Conditions",subprocessors:"Sub-processors","-- Website Chatbot":{type:"separator",title:"Website Chatbot"},chatbot:"Getting Started","access-control":"Access control","chatbot-custom-style":"Custom Style","chatbot-embed":"Embed Chatbot","chatbot-db-switching":"Database Switching (Multiple Tenants)","ban-chatbot-user":"Ban/Unban Chatbot User","-- WhatsApp Integration":{type:"separator",title:"WhatsApp Integration"},"whatsapp-setup":"WhatsApp Business Setup","-- Dashboard":{type:"separator",title:"Dashboard"},dashboard:"Getting Started","dashboard-embed":"Embed Dashboard","-- API Reference":{type:"separator",title:"API Reference"},"api-authentication":"API Authentication","api-ask":"Ask API","api-messages":"Messages API","api-new-chat":"New Chat API","-- Enterprise":{type:"separator",title:"Enterprise"},"on-prem":"On-Premise Deployment","-- Changelog":{type:"separator",title:"Changelog"},"v1.1.13":"v1.1.13","v1.1.121":"v1.1.121"}},{kind:"MdxPage",name:"access-control",route:"/docs/access-control"},{kind:"MdxPage",name:"api-ask",route:"/docs/api-ask"},{kind:"MdxPage",name:"api-authentication",route:"/docs/api-authentication"},{kind:"MdxPage",name:"api-messages",route:"/docs/api-messages"},{kind:"MdxPage",name:"api-new-chat",route:"/docs/api-new-chat"},{kind:"MdxPage",name:"ban-chatbot-user",route:"/docs/ban-chatbot-user"},{kind:"MdxPage",name:"chatbot-custom-style",route:"/docs/chatbot-custom-style"},{kind:"MdxPage",name:"chatbot-db-switching",route:"/docs/chatbot-db-switching"},{kind:"MdxPage",name:"chatbot-embed",route:"/docs/chatbot-embed"},{kind:"MdxPage",name:"chatbot",route:"/docs/chatbot"},{kind:"MdxPage",name:"connect",route:"/docs/connect"},{kind:"MdxPage",name:"dashboard-embed",route:"/docs/dashboard-embed"},{kind:"MdxPage",name:"dashboard",route:"/docs/dashboard"},{kind:"MdxPage",name:"index",route:"/docs"},{kind:"MdxPage",name:"on-prem",route:"/docs/on-prem"},{kind:"MdxPage",name:"privacy-policy",route:"/docs/privacy-policy"},{kind:"MdxPage",name:"sample-db",route:"/docs/sample-db"},{kind:"MdxPage",name:"security",route:"/docs/security"},{kind:"MdxPage",name:"subprocessors",route:"/docs/subprocessors"},{kind:"MdxPage",name:"terms-and-conditions",route:"/docs/terms-and-conditions"},{kind:"MdxPage",name:"tips",route:"/docs/tips"},{kind:"MdxPage",name:"train",route:"/docs/train"},{kind:"MdxPage",name:"v1.1.121",route:"/docs/v1.1.121"},{kind:"MdxPage",name:"v1.1.124",route:"/docs/v1.1.124"},{kind:"MdxPage",name:"v1.1.13",route:"/docs/v1.1.13"},{kind:"MdxPage",name:"v1.1.135",route:"/docs/v1.1.135"},{kind:"MdxPage",name:"v1.1.136",route:"/docs/v1.1.136"},{kind:"MdxPage",name:"webhook",route:"/docs/webhook"},{kind:"MdxPage",name:"whatsapp-setup",route:"/docs/whatsapp-setup"}]}],flexsearch:{codeblocks:!0},title:"Getting Started",headings:d},pageNextRoute:"/docs",nextraLayout:s.ZP,themeConfig:r.Z};a.default=(0,n.j)(l)},45184:function(){}},function(e){e.O(0,[4478,2888,9774,179],function(){return e(e.s=2778)}),_N_E=e.O()}]);