스키마 문서화
정상 동작레포지토리나 위키에 바로 쓸 수 있게 데이터베이스 스키마의 Markdown 문서를 생성합니다.
생성 마크다운 데이터베이스 스키마 문서를 한 단계로 작성: 작업을 선택하고, 저장 위치를 선택하면 완료됩니다. 의도적으로 설정할 것은 없으며, 문서는 SQLly가 IntelliSense용으로 이미 로드한 스키마 모델에서 생성되므로 추가 서버 왕복이 필요 없고 앱이 알고 있는 내용을 정확히 반영합니다.
출력은 연결과 데이터베이스를 머리글로 하는 데이터 사전이며, 다음 섹션으로 나뉩니다 테이블, 뷰, 프로시저, 함수, 그리고 기타 객체각 테이블에는 열 그리드, 이름, 타입, NULL 허용 여부, 기본값, 키 주석(기본 키, identity, FK → 대상) - 외래 키를 리스트로 포함; 루틴은 매개변수 시그니처와 반환 타입을 가져옵니다. 매우 큰 스키마는 자동으로 인덱스 파일과 스키마별 파일 하나로 분할되어, 결과가 저장소나 위키에서 탐색 가능하게 유지됩니다.


데이터 사전 작성
- 연결하고 스키마 모델이 로드되기를 잠시 기다리세요(자동 완성을 구동하는 바로 그 모델입니다). 아직 로드되지 않았다면 SQLly가 상태 표시줄로 알려주고 아무 일도 하지 않습니다.
- 탐색기에서 데이터베이스를 마우스 오른쪽 버튼으로 클릭하고 스키마 › 스키마 문서화(Markdown)..., 또는 다음을 실행하세요 스키마 문서화 (Markdown)… 에서 명령 팔레트. 탐색기에서 열면 먼저 그 데이터베이스가 활성 데이터베이스로 바뀝니다.
- 저장 대화 상자가 열리며
schema-docs.md이 제안이 나타납니다. 폴더와 이름을 선택하세요. - 상태 표시줄에 어디에 저장되었는지, 그리고 스키마를 분할했을 때 파일이 몇 개 만들어졌는지 확인해 줍니다.
Markdown이 어떻게 보이는지
객체는 섹션 순으로, 그다음 이름 순으로 정렬됩니다. 작은 스키마에서는 대략 다음과 같이 나타납니다:
# Data Dictionary — Shop / sales Generated by SQLLY from the loaded schema model. 2 objects. ## Tables ### dbo.Orders | Column | Type | Nullable | Default | Key | |---|---|---|---|---| | OrderId | int | no | | PK, identity | | CustomerId | int | no | | FK → dbo.Customers | | Total | decimal | yes | | | - Foreign key (CustomerId) → dbo.Customers (CustomerId) ## Procedures ### dbo.PlaceOrder | Parameter | Type | Mode | Default | |---|---|---|---| | @CustomerId | int | in | |
- 테이블 - 열마다 한 행씩. NULL 허용 입니다
yes,no, 또는?모델이 모를 때. 그 키 셀은 다음을 결합합니다PK,FK → target, 그리고identity. - 뷰 - 열/타입 그리드, 또는 스키마 모델에 기록되지 않은 열들 모델이 뷰의 이름만 알고 있을 때.
- 프로시저와 함수 - 매개변수 / 타입 / 모드 / 기본값 그리드(모드는
in,out, 또는in/out), 매개변수 없음. 없을 때, 그리고 반환값: 줄은 함수용입니다. - 기타 객체 - 동의어는 그 대상을 보여 주고, 나머지는 이름으로 나열한 뒤 구조 세부 정보가 기록되지 않았습니다.
값 안의 파이프 문자는 이스케이프되고 줄바꿈은 한 줄로 합쳐져, 기본값과 타입이 테이블 레이아웃을 깨뜨리지 않습니다.
대규모 스키마
지정한 파일 하나에 최대 2,000개의 객체까지 담습니다. 그 이상이면 SQLly는 그 파일을
인덱스 모든 스키마를 개체 수와 링크와 함께 나열하고, 그 옆에 스키마마다 파일을 하나씩 만들며 그 이름은 내 파일 이름을 딴 것입니다: schema-docs.sales.md,
schema-docs.audit.md, 스키마 이름은 파일 이름에 안전한 형태로 바뀌고, 충돌할 두 스키마는 서로 덮어쓰지 않도록 숫자 접미사를 받습니다. 어느 것도 잘리지 않습니다.
알아두어야 할 사항
- SQLly가 연결하는 모든 엔진에서 작동하며, 엔진 특정 카탈로그 대신 SQLly 자체 모델을 읽기 때문에 가능합니다.
- 문서는 로드된 모델만큼만 완전합니다. 모델이 어떤 뷰의 열을 기록하지 않았다면, 문서에서는 추측하지 않고 그렇다고 명시합니다.
- 저장 시 파일에 바로 쓰며, 같은 이름의 기존 파일은 덮어씁니다.
- 브라우저 미리보기에서는 파일로 저장할 수 없습니다. 데스크톱 앱을 사용하세요.