schemaspy
v6.2.4
SchemaSpy 는 데이터베이스 메타데이터 분석기입니다. 이는 데이터베이스 관리자와 개발자가 데이터 모델을 시각화, 탐색 및 이해하는 데 도움이 됩니다. 사용하기 쉬운 HTML 기반 보고서를 사용하면 엔터티 관계 다이어그램을 탐색하는 것이 그 어느 때보다 간단해졌습니다. 당사의 제품 쇼케이스는 http://schemaspy.org/sample/index.html에서 확인할 수 있습니다.
SchemaSpy는 GUI가 없는 독립형 애플리케이션입니다. 최신 JAR 파일이나 Docker 이미지를 다운로드하면 바로 사용할 수 있습니다! Maven에서 SchemaSpy를 사용하려면 아래 Maven 장을 참조하세요.
# replace '6.2.4' with latest version
curl -L https://github.com/schemaspy/schemaspy/releases/download/v6.2.4/schemaspy-6.2.4.jar
--output ~/Downloads/schemaspy.jar
아직 출시되지 않은 버그 수정 및 진행 중인 기능을 보려면 스냅샷 JAR을 다운로드하거나 Docker 태그
snapshot사용하세요.
SchemaSpy는 베어본 JAR과 모든 종속성을 포함하는 Fat JAR의 두 가지 유형의 JAR 파일을 릴리스합니다. 두 JAR 모두 Maven Central에 게시됩니다. Fat JAR은 GitHub 릴리스에도 첨부되어 있습니다. 이 페이지 상단의 "maven Central" 배지를 누르면 Maven Central의 최신 버전으로 바로 이동됩니다.
두 아티팩트의 Maven GAV는 다음과 같습니다.
org.schemaspy:schemaspy:<version>org.schemaspy:schemaspy:<version>:app ← app 분류자를 참고하세요.PostgreSQL(11 이상)을 사용하고 있다고 가정해 보겠습니다. 먼저 JDBC 드라이버를 다운로드하세요.
curl -L https://jdbc.postgresql.org/download/postgresql-42.5.4.jar
--output ~/Downloads/jdbc-driver.jar
그런 다음 데이터베이스에 대해 SchemaSpy를 실행하면 DIRECTORY/index.html 에서 검색할 준비가 됩니다.
java -jar ~/Downloads/schemaspy.jar
-t pgsql11
-dp ~/Downloads/jdbc-driver.jar
-db DATABASE
-host SERVER
-port 5432
-u USER
-p PASSWORD
-o DIRECTORY
PostgreSQL을 사용하지 않더라도 당황하지 마세요! 기본적으로 SchemaSpy는 12개 이상의 다양한 데이터베이스를 지원합니다. -dbhelp 사용하여 나열하십시오. 아직 충분하지 않나요? 데이터베이스에 JDBC 드라이버가 있으면 이를 SchemaSpy에 연결할 수 있습니다.
우리는 문서 읽기에서 문서를 호스팅합니다. 일반적인 문제 해결에 관한 섹션을 확인하세요.
SchemaSpy는 데이터베이스 분석 및 문서화에 대한 많은 사용 사례를 다룹니다. 이 README의 뒷부분에서 커뮤니티에서 제공하는 가이드를 확인하세요.
데이터베이스를 문서화하는 데 선호되는 방법은 엔터티-관계(ER) 다이어그램을 사용하는 것입니다. 그러나 이러한 다이어그램을 수동으로 그리는 것은 시간이 많이 걸리고 오류가 발생하기 쉬운 프로세스이므로 실제로 그리는 경우가 거의 없습니다. 다이어그램을 그릴 때 최신 상태로 유지되는 경우는 거의 없습니다. SchemaSpy를 사용하면 더 이상 문제가 되지 않습니다. 다이어그램은 CI/CD 워크플로우의 일부로 신속하게 생성되어 항상 최신 상태를 유지할 수 있습니다.
SchemaSpy는 데이터베이스 구조의 모양과 형태를 설명하기 위해 다양한 종류의 흥미로운 통계를 수집할 수 있습니다. 보고서에서 직접 이러한 통계를 더 자세히 살펴보거나 추가 QA 분석을 위해 Excel 또는 CSV로 내보낼 수 있습니다.
오늘날 기업의 데이터는 가장 귀중한 자산이 될 수 있습니다. SchemaSpy는 구조적 정보만 읽기 때문에 빈 데이터베이스 복제본에서도 잘 작동합니다. 이는 제3자 분석을 위해 두려움 없이 보고서를 공유할 수 있음을 의미합니다.
SchemaSpy는 데이터베이스 설계의 모범 사례에 대한 지식을 통합합니다. 누락된 인덱스, 묵시적 관계, 고아 테이블과 같은 이상 현상을 찾아 보고할 수 있습니다.
SchemaSpy 커뮤니티에 오신 것을 환영합니다! 이 파일을 읽거나 도구를 사용한다는 것은 귀하가 우리 커뮤니티의 일원이 되고 프로젝트의 미래에 기여한다는 것을 의미합니다. 우리와 함께해주셔서 감사합니다!
일부 커뮤니티 회원은 SchemaSpy를 더 많은 사람들과 공유하기 위해 추가 노력을 기울이고, 회사에 재정적 지원을 요청하거나 소프트웨어를 개선하기로 결정했습니다. 모든 Github 스타, 트윗 또는 기타 활동은 우리의 작업이 감사하다는 것을 상기시켜주기 때문에 여러분 각자에게 개별적으로 감사할 수 있는 공간이 있었으면 좋겠습니다.
SchemaSpy의 처음 5개 버전을 생성하려면:
그 이후로 SchemaSpy를 영속시키기 위해:
커뮤니티를 위한 튜토리얼 및 가이드를 생성하려면:
우리는 SchemaSpy가 연구자들의 작업을 지원한다는 사실을 자랑스럽게 생각합니다.
SchemaSpy를 인용하려면 다음을 사용하십시오.
SchemaSpy Team (2024) SchemaSpy: Database documentation built easy. SchemaSpy. URL https://schemaspy.org/
LaTeX 사용자를 위한 BibTeX 항목은 다음과 같습니다.
@Manual{schemaspy,
title = {SchemaSpy: Database documentation built easy},
author = {{SchemaSpy Team}},
organization = {SchemaSpy},
year = {2024},
url = {https://schemaspy.org/}
}
SchemaSpy는 maven을 사용하여 구축되었으며 우리는 maven 래퍼를 활용합니다.
Windows mvnw.cmd package
리눅스 ./mvnw package
결과 애플리케이션은 target 에서 찾을 수 있습니다.
자신만의 SonarQube가 필요합니다:
https://hub.docker.com/_/sonarqube/
Windows mvnw.cmd -P sonar clean verify -Dsonar.host.url=http://$(boot2docker ip):9000 -Dsonar.jdbc.url="jdbc:h2:tcp://$(boot2docker ip)/sonar"
Linux ./mvnw -P sonar clean verify
결과 보기:
리눅스 http://localhost:9000
윈도우 http://$(boot2docker ip):9000
Python을 사용하여 구축
Venv 생성
종속성 설치 pip install -r docs/requirements.txt
docs 로 이동
Windows make.bat clean && make.bat html
리눅스는 make clean html
결과 문서는 docs/build/html 에서 찾을 수 있습니다.
