Getting started

Introducing NeoSQL

NeoSQL is a tool for designing and working with databases. You design tables in an ERD and apply them to a real database, bring an existing database into an ERD to document it, run SQL, and generate source code from table definitions. This page explains what you can do with NeoSQL and the order in which to read this guide.

What you can do with NeoSQL

FeatureWhat it doesMore
ERDDesign tables, columns, keys and relationships as a diagram. Drag database tables in to build an ERD (reverse engineering), and turn the design into DDL to apply it to the database (forward engineering).ERDs and the real database
SQL editorWrite and run SQL, with autocompletion, execution plans, transactions, and editing and exporting results.SQL editor
Object explorerView and change database objects such as schemas, tables, views and functions. Schema compare and table reports are also opened here.Object explorer
Data dictionaryDefine standard column types and properties (domains) and standard words, so tables are designed with the same names and types.Data dictionary
DashboardsGather SQL results as tiles and watch the state of a database on one screen.Dashboards
Code generationGenerate source code such as entities, DTOs and screens from table definitions with template packs (Velocity templates).Generating source code
AIWith an API key you register for an AI provider, turn natural language into SQL, ask how to improve a query, and generate sample data.AI and MCP
MCPLet external AI tools such as Claude, Codex, Gemini and Cursor build ERDs and run SQL in your projects through the desktop app. Desktop app only.AI and MCP

You work in projects. A project groups connections (the databases you connect to), ERDs, SQL and dashboards. Data dictionaries and template packs are managed outside projects and shared by several projects.

The supported databases are MySQL, MariaDB, PostgreSQL, Oracle, SQL Server, SQLite, H2, Snowflake, Databricks and BigQuery. Supabase is connected as PostgreSQL. The available features differ slightly between databases; the differences are explained in Database reference.

Who uses it

If your work is toFeatures you use in NeoSQL
Design the schema of a new service from scratchDesign in an ERD, apply it to the database and generate source code from the tables.
Analyze and document a database in operationBring an existing database into an ERD, compare schemas and create table reports.
Change a production database without mistakesConfirm dangerous SQL before it runs, and in account projects require DDL to be approved before it runs. See Safeguards for production databases.
Design together with your teamShare an account project with your team. Inviting others requires a paid plan. See Plans and features.
Keep project data inside your companyUse the desktop app without signing in, so projects are stored only on your PC. The app still exchanges some data with outside servers, so read Security and where your data goes first.

Web and desktop

NeoSQL comes as a web app you open in a browser and a desktop app you install on Windows or macOS. The screens are the same, but how they reach your database and whether you must sign in differ.

Web appDesktop app
InstallationNot neededInstall on Windows or macOS
Sign-inAlways requiredUse right away without signing in
Databases you can connect toDatabases that accept connections from the internetAny database this PC can reach (company network, behind a VPN, on this PC)
ProjectsAccount projectsLocal projects, and account projects too once you sign in

The differences and how to choose are explained in Web and desktop, and the difference between local and account projects in Sign-in and project types.

How to read this guide

  1. Getting started: install the app and create your first project in Install and update and First run. To use NeoSQL from an external AI such as Claude Code, read Install and connect MCP.
  2. Concepts: why things work the way they do, and where the boundaries are. Reading Sign-in and project types and ERDs and the real database first makes the rest easier.
  3. Walkthroughs: follow one typical task from start to finish. If you are new, start with Design your first ERD and apply it to a database.
  4. Screens: one page per screen, in this order: app, projects, connections and explorer, ERD, SQL editor, dashboards, data dictionary, code generation, and AI, MCP and security. Look here when you meet a screen you do not know. For example: Home.
  5. Account and subscription: sign-up, sign-in, workspaces and subscriptions on the website. For example: Sign-up and sign-in.
  6. Reference: differences between databases, keyboard shortcuts, MCP tools, template syntax, terms and troubleshooting. For example: Glossary.