NeoSQL 사용 가이드
NeoSQL의 설치부터 주요 기능까지, 단계별로 안내합니다.
Windows 설치
Windows에 NeoSQL 데스크톱 애플리케이션을 설치합니다.
설치 파일 다운로드
NeoSQL 공식 사이트 또는 GitHub Releases에서 Windows용 설치 파일(NeoSQL-win-x64-Setup.exe)을 다운로드합니다.
설치 프로그램 실행
다운로드한 설치 파일을 실행합니다. Windows SmartScreen 경고가 나타나면 '추가 정보' → '실행'을 클릭합니다.
설치 완료
설치가 완료되면 NeoSQL이 자동으로 실행됩니다. 바탕화면과 시작 메뉴에 바로가기가 생성됩니다.
Windows 10 이상을 권장합니다. 64비트 운영체제가 필요합니다.
macOS 설치
macOS에 NeoSQL 데스크톱 애플리케이션을 설치합니다.
DMG 파일 다운로드
NeoSQL 공식 사이트에서 macOS용 DMG 파일을 다운로드합니다. Apple Silicon(M1/M2/M3/M4)과 Intel 버전이 따로 제공됩니다.
애플리케이션 설치
DMG 파일을 열고 NeoSQL 아이콘을 Applications 폴더로 드래그합니다.
보안 설정 (Apple Silicon)
처음 실행 시 '확인되지 않은 개발자' 경고가 나타날 수 있습니다. 시스템 설정 → 개인정보 보호 및 보안에서 '확인 없이 열기'를 클릭합니다.
Apple Silicon Mac을 사용하는 경우 arm64 버전을 다운로드하세요. Intel Mac은 x64 버전을 사용합니다.
처음 실행하기
NeoSQL을 처음 실행하면 사용 모드를 선택하는 화면이 나타납니다.
온라인 모드
회원가입 후 로그인하여 사용합니다. 클라우드 동기화를 통해 여러 기기에서 동일한 프로젝트에 접근할 수 있습니다. 웹 버전과 데이터가 동기화됩니다.
오프라인 모드
로그인 없이 바로 사용합니다. 모든 데이터는 로컬 파일 시스템(.neosql 디렉토리)에 저장됩니다. 인터넷이 없는 폐쇄망 환경에 적합합니다.
온라인 모드에서도 대부분의 작업은 로컬에서 수행되며, 데이터는 백그라운드에서 동기화됩니다.
회원가입 / 로그인
온라인 모드를 사용하려면 NeoSQL 계정이 필요합니다.
회원가입
아이디, 이름, 이메일, 비밀번호를 입력하여 계정을 생성합니다. 소셜 로그인(Google, GitHub)도 지원합니다.
로그인
생성한 계정으로 로그인합니다. '아이디 저장' 옵션으로 다음 로그인 시 아이디를 자동 입력할 수 있습니다.
소셜 로그인
Google 또는 GitHub 계정으로 간편하게 로그인할 수 있습니다.
프로젝트 생성
NeoSQL에서 모든 작업은 프로젝트 단위로 관리됩니다.
새 프로젝트 만들기
대시보드에서 '새 프로젝트' 버튼을 클릭합니다.
프로젝트 정보 입력
프로젝트 이름과 설명을 입력합니다.
프로젝트 열기
생성된 프로젝트를 클릭하여 작업 화면으로 이동합니다.
하나의 프로젝트에 여러 데이터베이스 연결을 추가할 수 있습니다.
데이터베이스 연결
프로젝트에 데이터베이스를 연결하여 테이블 정보를 가져옵니다.
연결 추가
사이드바에서 '+' 버튼을 클릭하여 새 데이터베이스 연결을 추가합니다.
연결 정보 입력
데이터베이스 유형(MySQL, PostgreSQL, Oracle 등), 호스트, 포트, 데이터베이스명, 사용자, 비밀번호를 입력합니다.
연결 테스트
'테스트' 버튼으로 연결이 정상적인지 확인한 후 저장합니다.
스키마 탐색
연결이 완료되면 사이드바 트리에서 스키마, 테이블, 뷰 등을 탐색할 수 있습니다.
지원 데이터베이스: MySQL, MariaDB, PostgreSQL, Oracle, SQL Server, H2
웹 버전에서는 Embedded Server를 통해 데이터베이스에 연결합니다. 보안을 위해 연결 정보는 암호화되어 저장됩니다.
ERD 설계
비주얼 ERD 에디터로 데이터베이스 구조를 설계하고 시각화합니다.
ERD 생성
프로젝트 내에서 새 ERD를 생성합니다. 빈 ERD에서 시작하거나, 기존 데이터베이스에서 ERD를 자동 추출할 수 있습니다.
Reverse Engineering
기존 데이터베이스의 테이블 구조를 읽어와 ERD를 자동으로 생성합니다. 테이블 간 FK 관계도 자동으로 연결됩니다.
Forward Engineering
ERD에서 설계한 테이블 구조를 CREATE TABLE DDL로 자동 변환합니다. 생성된 DDL을 직접 실행하여 데이터베이스에 반영할 수 있습니다.
ERD 편집
드래그 앤 드롭으로 테이블 위치를 조정하고, 테이블을 더블클릭하여 상세 편집할 수 있습니다. 줌, 팬, 자동 정렬 등 다양한 편집 도구를 제공합니다.
ERD에서 테이블을 더블클릭하면 테이블 상세 편집 탭이 열립니다.
테이블 관리
테이블의 모든 속성을 스프레드시트처럼 직관적으로 편집합니다.
컬럼 편집
컬럼명, 데이터 타입, NULL 허용, 기본값, 코멘트를 인라인으로 편집합니다. 드래그로 컬럼 순서를 변경할 수 있습니다.
인덱스 관리
Primary Key, Unique, Index를 시각적으로 관리합니다.
외래 키 (FK)
테이블 간 참조 관계를 설정하고 관리합니다.
DDL 변경 추적
테이블 구조를 변경하면 NeoSQL이 자동으로 변경 사항을 감지하여 ALTER TABLE DDL을 생성합니다. 변경 전/후 diff를 확인할 수 있습니다.
변경 사항은 'Apply' 버튼을 누르기 전까지 데이터베이스에 반영되지 않습니다. 안심하고 편집하세요.
SQL 에디터
강력한 SQL 에디터로 쿼리를 작성하고 실행합니다.
주요 기능
- 구문 강조 및 자동완성
- SELECT, DML(INSERT/UPDATE/DELETE), DDL 실행
- 쿼리 결과를 테이블 형태로 즉시 확인
- 여러 쿼리를 탭으로 관리
Manual Commit / Rollback
DML(INSERT, UPDATE, DELETE) 실행 시 자동 커밋되지 않습니다. 결과를 확인한 후 수동으로 Commit 또는 Rollback할 수 있어 실수로 인한 데이터 변경을 방지합니다.
Ctrl+Enter(Cmd+Enter)로 현재 커서 위치의 쿼리를 실행할 수 있습니다.
코드 생성
테이블 스키마 정보를 기반으로 소스코드를 자동 생성합니다.
테이블 선택
코드를 생성할 테이블을 선택합니다.
템플릿 선택
사용할 코드 생성 템플릿을 선택합니다. Java, Kotlin, TypeScript 등 다양한 언어와 프레임워크를 지원합니다.
코드 생성 및 다운로드
데스크톱 앱에서는 지정한 경로에 직접 파일을 생성하고, 웹에서는 ZIP 파일로 다운로드합니다.
Velocity 템플릿 엔진을 사용하여 원하는 형태의 코드 템플릿을 자유롭게 작성할 수 있습니다.
팀에서 사용하는 코딩 컨벤션에 맞는 커스텀 템플릿을 만들어 공유하면, 모든 팀원이 일관된 코드를 생성할 수 있습니다.
템플릿 팩
코드 생성에 사용되는 템플릿을 팩 단위로 관리하고 공유합니다.
템플릿 팩 관리
여러 템플릿 파일을 하나의 팩으로 묶어 관리합니다. 프로젝트별로 다른 템플릿 팩을 적용할 수 있습니다.
템플릿 스토어
다른 사용자가 공유한 템플릿 팩을 스토어에서 찾아 설치할 수 있습니다. 직접 만든 템플릿 팩을 스토어에 공유할 수도 있습니다.
Spring Boot + JPA, MyBatis, Vue.js 등 주요 프레임워크용 기본 템플릿 팩이 제공됩니다.
AI(MCP) 연동
MCP(Model Context Protocol)를 통해 AI 개발 도구와 NeoSQL을 연동합니다.
MCP란?
MCP는 AI 모델이 외부 도구와 통신하는 표준 프로토콜입니다. Claude, Cursor, VS Code 등 AI 개발 도구에서 NeoSQL의 기능을 직접 사용할 수 있습니다.
설정 방법
AI 도구의 MCP 설정 파일에 NeoSQL 서버 정보를 추가합니다. 프로젝트 ID만 설정하면 되며, DB 접속 정보는 NeoSQL에서 안전하게 관리됩니다.
지원 기능
- ERD 기반 스키마 설계 및 변경
- SQL 쿼리 실행 (Manual Commit/Rollback)
- 테이블 구조 조회
- 코드 생성
보안
DB 접속 정보가 AI 설정 파일에 노출되지 않습니다. 프로젝트 ID 기반 간접 참조 방식으로, 설정 파일이 유출되어도 데이터베이스에 접근할 수 없습니다.
MCP 연동 시 DML은 자동 커밋되지 않습니다. SQL Editor에서 직접 Commit/Rollback을 결정합니다.