시작하기

NeoSQL 소개

NeoSQL 은 데이터베이스를 설계하고 다루는 도구입니다. ERD 로 테이블을 설계해 DB 에 반영하거나, 기존 DB 를 ERD 로 가져와 문서화할 수 있습니다. SQL 실행과 테이블 기반 소스코드 생성도 지원합니다. 아래에서 NeoSQL 의 주요 기능과 가이드를 읽는 순서를 안내합니다.

NeoSQL 로 하는 일

기능하는 일자세한 설명
ERD테이블, 컬럼, 키, 관계를 그림으로 설계합니다. 기존 DB 의 테이블을 가져와 ERD 로 만들고(Reverse Engineering), 설계한 내용을 DDL 로 변환해 DB 에 반영합니다(Forward Engineering).ERD 와 실제 DB
SQL 편집기SQL 을 작성하고 실행합니다. 자동 완성, 실행 계획, 트랜잭션, 결과 편집과 내보내기를 지원합니다.SQL 편집기
객체 탐색기커넥션의 스키마, 테이블, 뷰, 함수 같은 DB 객체를 조회하고 수정합니다. 스키마 비교와 테이블 정의서도 여기서 만듭니다.객체 탐색기
데이터 사전표준 단어와 도메인(컬럼의 표준 타입, 속성)을 정해 두면, 테이블을 설계할 때 누구나 같은 이름과 타입을 사용하게 됩니다.데이터 사전
대시보드SQL 결과를 타일로 모아 DB 상태를 한 화면에서 모니터링합니다.대시보드
코드 생성테이블 정의와 템플릿 팩(Velocity 템플릿)으로 엔티티, DTO, 화면 같은 소스코드를 만듭니다.소스코드 생성
AI직접 등록한 AI 제공자의 API 키로 자연어를 SQL 로 변환하고, 쿼리 개선 방법을 제안받고, 샘플 데이터를 생성합니다.AI 와 MCP
MCPClaude, Codex, Gemini, Cursor 같은 외부 AI 도구가 데스크톱 앱을 통해 프로젝트의 ERD 를 만들고 SQL 을 실행하게 합니다. 데스크톱 앱에서만 지원합니다.AI 와 MCP

모든 작업은 프로젝트 단위로 합니다. 프로젝트는 커넥션(접속할 DB), ERD, SQL, 대시보드를 묶은 것입니다. 데이터 사전과 템플릿 팩은 프로젝트와 따로 관리하며 여러 프로젝트에서 함께 사용합니다.

지원하는 DBMS 는 MySQL, MariaDB, PostgreSQL, Oracle, SQL Server, SQLite, H2, Snowflake, Databricks, BigQuery 입니다. Supabase 는 PostgreSQL 로 접속합니다. 지원하는 기능은 DBMS 마다 조금씩 다르며, 차이는 DBMS 별 참고 에서 설명합니다.

작업별 활용 방법

하려는 일NeoSQL 에서 사용하는 기능
새 서비스의 스키마를 처음부터 설계합니다ERD 로 설계하고, DB 에 반영하고, 테이블에서 소스코드를 만듭니다.
운영 중인 DB 를 분석하고 문서로 남깁니다기존 DB 를 ERD 로 가져오고, 스키마를 비교하고, 테이블 정의서를 만듭니다.
운영 DB 를 실수 없이 수정해야 합니다위험한 SQL 은 실행 전에 한 번 더 확인합니다. 계정 프로젝트에서는 승인받은 DDL 만 실행할 수 있습니다. 운영 DB 안전장치 에서 설명합니다.
팀과 함께 설계합니다계정 프로젝트를 팀원과 공유합니다. 다른 사람을 초대하려면 유료 플랜이 필요합니다. 플랜과 기능 차이 에서 설명합니다.
프로젝트 데이터를 회사 외부에 둘 수 없습니다데스크톱 앱을 로그인 없이 사용하면 프로젝트가 기기에만 저장됩니다. 다만 앱이 외부와 주고받는 통신이 일부 있으니 보안과 데이터가 나가는 곳 을 먼저 읽으세요.

웹과 데스크톱

NeoSQL 은 브라우저에서 여는 웹 앱과 Windows, macOS 에 설치하는 데스크톱 앱, 두 가지 형태로 제공됩니다. 화면은 같지만 DB 에 접속하는 경로와 로그인 여부가 다릅니다.

웹 앱데스크톱 앱
설치필요 없습니다Windows, macOS 에 설치합니다
로그인항상 필요합니다로그인 없이 바로 사용할 수 있습니다
접속할 수 있는 DB인터넷에서 접속을 받는 DB기기에서 접속할 수 있는 모든 DB(사내망, VPN 너머, 기기의 DB)
프로젝트계정 프로젝트로컬 프로젝트. 로그인하면 계정 프로젝트도 사용할 수 있습니다

차이와 선택하는 기준은 웹과 데스크톱 에서, 로컬 프로젝트와 계정 프로젝트의 차이는 로그인과 프로젝트 종류 에서 설명합니다.

가이드 읽는 순서

  1. 시작하기: 설치와 업데이트 와 처음 실행하기 에서 앱을 설치하고 첫 프로젝트를 만듭니다. Claude Code 같은 외부 AI 에서 NeoSQL 을 사용하려면 MCP 설치와 연결 을 읽으세요.
  2. 핵심 개념: 왜 그렇게 동작하는지와 경계를 설명합니다. 로그인과 프로젝트 종류 와 ERD 와 실제 DB 를 먼저 읽으면 나머지가 쉬워집니다.
  3. 따라 하기: 대표 작업 하나를 처음부터 끝까지 따라 합니다. 처음이라면 데스크톱에서 첫 ERD 를 만들어 DB 에 반영하기 부터 시작하세요.
  4. 화면별 설명: 화면마다 한 페이지씩 설명합니다. 앱, 프로젝트, 연결과 탐색기, ERD, SQL 편집기, 대시보드, 데이터 사전, 코드 생성, AI, MCP, 보안 순서입니다. 앱을 사용하다가 모르는 화면이 나오면 화면별 설명을 찾으세요. 예: 홈.
  5. 계정과 구독: 홈페이지에서 하는 가입, 로그인, 워크스페이스, 구독을 설명합니다. 예: 가입과 로그인.
  6. 참고: DBMS 별 차이, 단축키, MCP 도구, 템플릿 문법, 용어, 문제 해결을 모았습니다. 예: 용어집.