Docs/Quickstart

Quickstart

Connect to a SQL Server instance, choose an object, run the analysis, and open your first evidence-backed report.

First 15 Minutes

If you want the shortest successful first run, follow this order. It avoids the most common beginner mistake: trying to analyze before the app has both a working SQL connection and a working AI provider.

  1. Open Settings and complete AI / LLM first, so analysis features have a working model backend.
  2. Add one saved SQL Server connection in Settings > Database.
  3. Test the connection, save it, then click Connect.
  4. Start with Dashboard to confirm the instance is reachable and metrics are loading.
  5. Move to Query Statistics or Object Explorer for your first deeper analysis.
Add A New Database Connection

In this product, Add Connection means add a saved connection profile. It does not create a new SQL database on the server.

  1. Open Settings > Database.
  2. Click Add Connection.
  3. Enter a clear Connection Name.
  4. Enter Server / Instance and confirm the correct Port.
  5. Choose the Default Database you want the profile to open first.
  6. Select SQL Server Authentication or Windows Authentication.
  7. If you chose SQL authentication, enter Username and Password.
  8. Leave ODBC Driver on auto-select unless your DBA requires a specific driver.
  9. Keep Encrypt Connection enabled unless you have a documented reason not to.
  10. Enable Trust Server Certificate only when your environment explicitly requires it.
  11. Click Test Connection.
  12. If the test succeeds, click Save, then select the profile and click Connect.
Tip
If you use Windows Authentication, run the app with the Windows account that already has the required SQL permissions. Do not expect the dialog to impersonate a different Windows user by typing credentials.
Add Local AI With Ollama

Choose this path if you want model traffic to stay local. Make sure Ollama is already running and the model is already installed before you test it inside the app.

ollama serve
ollama pull codellama
  1. Open Settings > AI / LLM > Providers.
  2. Click Add AI Model.
  3. Choose Provider = Ollama.
  4. Enter a clear Name such as Local Ollama - SQL.
  5. Enter Host as your Ollama URL, usually http://localhost:11434.
  6. Enter the exact installed model name, for example codellama.
  7. Click Test. If the test succeeds, click Add.
  8. Select the provider in the list, click Set Default, then click Save Settings.
Add A Cloud LLM

Choose this path if your team already uses a managed provider or if you want a centralized model backend. The exact fields vary by provider, but the workflow stays almost the same.

  1. Open Settings > AI / LLM > Providers and click Add AI Model.
  2. Choose a cloud provider such as OpenAI, Azure OpenAI, Anthropic, or DeepSeek.
  3. Enter a clear Name so you can distinguish production and test providers later.
  4. Enter the target Model value exactly as required by that provider.
  5. Enter the API key or credential field.
  6. If you use Azure OpenAI, also fill in Endpoint and Deployment.
  7. Click Test. If the test succeeds, click Add.
  8. Select the provider, click Set Default, then click Save Settings.
Typical OpenAI Style Fields
  • API Key
  • Model
Typical Azure OpenAI Style Fields
  • API Key
  • Endpoint
  • Deployment
  • Model label used by your deployment policy
Your First Real Check
  1. After you connect, open Dashboard first.
  2. Confirm that CPU, memory, IO, and TempDB metrics are populated.
  3. Then open Query Statistics for query-level evidence.
  4. If you want to inspect one procedure, function, or table, open Object Explorer.
Common First-Run Problems
Connection Test Fails
  • Re-check server name, port, and authentication mode.
  • Confirm the account has the expected SQL permissions.
  • Review encryption and certificate settings with your DBA.
AI Provider Test Fails
  • For Ollama, confirm the service is running and the model is installed.
  • For cloud providers, re-check the API key, model, endpoint, or deployment fields.
  • Do not forget to click Save Settings after the provider test and add flow succeed.
Query Statistics Looks Too Empty
  • Check whether Query Store is enabled for the target database.
  • Remember that DMV fallback has less historical depth.
  • Ask the DBA to enable Query Store if the database is new to the platform.
You Changed Settings But Nothing Happened
  • Click Save Settings after changing providers or connection defaults.
  • Some settings affect only future connections or future analyses.
  • Retry the action after saving instead of assuming the setting is already active.