쓰리래빗츠 북으로 데이터베이스 테이블 정의서를 작성하는 방법을 설명합니다.

데이터베이스 연결 만들기

데이터베이스 연결 설정

다음 순서로 JDBC API를 이용해서 데이터베이스 연결을 설정합니다.

1. JDBC 드라이버 라이브러리를 3RABBIZ_HOME/tomcat/lib 디렉터리에 복사합니다.

2. 쓰리래빗츠 북을 재시작합니다.

쓰리래빗츠 북을 재시작한 후 <2테스트> 링크를 클릭합니다.

JDBC 연결에 성공하면 테이블 목록이 보입니다.

DB 속성

데이터베이스 연결이 가능해지면 데이터베이스 속성 표가 나타납니다. 데이터베이스 이름과 버전 등을 확인할 수 있습니다.

접근 권한 설정

다음 순서로 특정 데이터베이스에 접근할 수 있는 사용자 또는 그룹을 설정합니다.

1. <1접근 권한 변경> 링크를 클릭합니다.

2. 그룹 또는 사용자를 선택한 후 <저장> 버튼을 클릭합니다.

   • 글 쓰기 권한이 있는 사용자만 목록에 나타납니다.

데이터베이스 연결 삭제

데이터베이스 연결을 삭제하려면 <1삭제> 링크를 클릭합니다.

테이블 정의서 만들기

먼저 문서를 만듭니다. 문서를 만드는 자세한 방법은 쓰리래빗츠 북 사용자 가이드를 참고합니다.

1. <대시보드> 메뉴에서 <책 만들기>를 선택합니다.

2. 내용을 입력한 후 저장합니다.

3. 차례 패널에서 <장 만들기> 링크를 클릭합니다.

4. 내용을 입력한 후 저장합니다.

5. 장의 <내용 편집> 링크를 클릭해서 에디터를 엽니다.

테이블을 가져오는 방법입니다.

1. 에디터 오른쪽 위에 있는 <1외부 시스템> 버튼을 클릭합니다.

2. 2데이터베이스 연결 이름을 선택합니다. 연결을 설정하지 않았거나 접근 권한이 없다면 <DB: 쓰리래빗츠>만이 보입니다(쓰리래빗츠 북 테이블 정보 제공).

   • 접근 권한을 설정하는 방법은 접근 권한 설정을 참고합니다.

3. 테이블 정의서를 만들 테이블을 선택한 후 <3가져오기> 버튼을 클릭합니다.

표에 시스템 아이디와 테이블 이름 라벨이 붙습니다. 테이블 정의서를 업데이트할 때 사용합니다.

테이블 가져오기와 관련해서 다음을 참고합니다.

• 쓰리래빗츠 북 에디터의 다른 기능을 모두 사용할 수 있습니다. 예를 들어 다른 단락으로 자세한 설명을 추가할 수 있습니다.

• 내용을 편집하면서 표의 셀을 합치거나 분리하면 업데이트할 수 없습니다.

• 표의 열은 필요에 따라 정의할 수 있습니다. 설정 방법은 칼럼 속성 설정 정의를 참고합니다.

• 표의 행으로 테이블 칼럼을 표시합니다. 일반적으로 칼럼이 만들어진 순서를 따르며 ORDINAL_POSITION 값으로 정렬합니다.

• 웹 뷰어 차례를 위해 제목 1 유형으로 테이블 이름을 추가합니다. 자세한 사항은 테이블 제목 단락 유형 설정을 참고합니다.

테이블 정의서 업데이트

SQL의 ALTER TABLE 등의 명령어로 테이블을 변경했다면 그 내용을 쓰리래빗츠 북으로 만든 테이블 정의서에도 반영할 수 있습니다.

1. 에디터를 엽니다.

2. 에디터 오른쪽 위에 있는 <1외부 시스템> 버튼을 클릭합니다.

3. <2외부 시스템 단락 업데이트> 버튼을 클릭합니다.

업데이트와 관련해서 다음을 참고합니다.

• 이력 비교로 변경 내역을 확인할 수 있습니다.

• 접근 권한이 없는 데이터베이스의 테이블은 업데이트하지 않습니다.

• 더 이상 존재하지 않는 테이블에 해당하는 표 단락을 자동으로 삭제하지 않습니다. 직접 해당 단락을 삭제 합니다.

• 테이블 이름은 바꿀 수 없기에 제목 단락은 없데이트 대상이 아닙니다.

• 셀을 합치거나 나눈 표는 업데이트하지 않습니다.

• JDBC 표준 칼럼 속성 값을 쓰리래빗츠 북에서 수정했다면 JDBC가 제공하는 값으로 다시 바뀝니다. 따라서 JDBC 표준 칼럼 속성 값은 변경하지 않습니다.

• 테이블에는 존재하는 칼럼을 쓰리래빗츠 북에서만 삭제했다면 다시 나타납니다.

• 사용자 정의 칼럼 속성은 쓰리래빗츠 북에서 바뀐 내용을 유지합니다.

칼럼 속성 설정 정의

표의 칼럼 속성을 정의하는 방법은 웹 페이지를 참고합니다.

부록

테이블 유형 제한하기

다음 순서로 테이블 목록에 특정 테이블 유형만이 보이도록 설정합니다.

1. <외부 시스템 변경> 링크를 클릭합니다.

2. JDBC 속성에 jdbc_table_types 값을 추가하고 저장합니다.

3. <테스트> 링크를 클릭해서 결과를 확인합니다.

DB 속성에서 데이터베이스가 지원하는 테이블 유형을 확인할 수 있습니다.

여러 유형을 지원하려면 쉼표를 구분자로 입력합니다. 예를 들어 테이블과 뷰만을 표시하려면 다음과 같이 입력합니다.

jdbc_table_types=TABLE,VIEW

테이블 이름 필터하기

다음 순서로 테이블 목록에 특정 이름 패턴의 테이블만 보이도록 설정합니다.

1. <외부 시스템 변경> 링크를 클릭합니다.

2. JDBC 속성에 jdbc_table_name_pattern 값을 추가하고 저장합니다.

3. <테스트> 링크를 클릭해서 결과를 확인합니다.

예를 들어 오라클 데이터베이스에서 이름이 R_로 시작하는 테이블만을 보여주려면 다음과 같이 설정합니다.

jdbc_table_name_pattern=R/_%

SQL에서 %는 글자 수와 상관없이 모든 글자를, _는 아무 글자 하나를 의미합니다. 따라서 R_%로 설정하면 R_이 아닌 R로 시작하는 테이블이 나타납니다. R_%는 R%로 설정한 것과 거의 같습니다(이름이 R인 테이블만 제외).

따라서 _ 글자 앞에 탈출문자(Escape Character)를 붙여야 합니다. SQL에서 탈출문자는 데이터베이스마다 다릅니다. DB 속성에서 확인할 수 있습니다.

오라클의 탈출문자는 /입니다. 그래서 R_로 시작하는 테이블만을 보여주려면 _앞에 /를 붙여 R/_%로 설정합니다.

카탈로그 이름으로 필터하기

다음 순서로 테이블 목록에 특정 카탈로그의 테이블만 보이도록 설정합니다.

1. <외부 시스템 변경> 링크를 클릭합니다.

2. JDBC 속성에 jdbc_catalog 값을 추가하고 저장합니다.

3. <테스트> 링크를 클릭해서 결과를 확인합니다.

스키마 이름으로 필터하기

다음 순서로 테이블 목록에 특정 카탈로그의 테이블만 보이도록 설정합니다.

1. <외부 시스템 변경> 링크를 클릭합니다.

2. JDBC 속성에 jdbc_schema 값을 추가하고 저장합니다.

3. <테스트> 링크를 클릭해서 결과를 확인합니다.

테이블 제목 단락 유형 설정

다음 순서로 테이블 제목 단락 유형을 설정합니다. 기본 값은 heading1(제목 1)입니다.

1. <외부 시스템 변경> 링크를 클릭합니다.

2. JDBC 속성에 jdbc_table_name_type를 설정한 후 저장합니다.

다음 값을 사용할 수 있습니다.

heading1

제목 1 단락

heading2

제목 2 단락

heading3

제목 3 단락

heading4

제목 4 단락

heading5

제목 5 단락

headline

헤드라인 단락

noraml

보통 단락

none

none으로 설정하면 제목 단락을 만들지 않습니다.

예를 들어 제목 단락을 생략하려면 JDBC 속성에 다음과 같이 입력합니다.

jdbc_table_name_type=none

오라클 DESC 값 가져오기

오라클에서 DESC 명령어로 설정한 칼럼 설명은 JDBC API의 REMARKS 칼럼 속성에 대응합니다. 하지만 기본적으로 DESC 값이 있어도 null을 반환합니다. 다음 순서로 이 값이 보이도록 설정합니다.

1. <외부 시스템 변경> 링크를 클릭합니다.

2. JDBC 속성에 remarksReporting을 다음과 같이 추가한 후 저장합니다.

remarksReporting=true

커넥션 풀링 미사용

계속 사용하는 기능이 아니기에 불필요한 자원 낭비를 막기 위해 커넥션 풀링을 하지 않습니다. 연결할 때마다 JDBC 커넥션을 새로 만들고 사용이 끝나면 바로 닫습니다.