JSON으로 칼럼 정의하기

외부 시스템으로 테이블 정의서를 작성할 때 테이블 정의서에서 칼럼의 어떤 속성을 보여줄 것인가를 웹 페이지로 설정합니다.

<도구 | 웹 페이지> 메뉴를 선택합니다.
탐색 패널에서 JSON 아래에 있는 “ES_TABLE”를 선택해서 에디터를 엽니다.
내용을 입력한 후 저장합니다.

저장과 함께 실시간으로 반영합니다.

별도로 설정하지 않으면 기본 설정을 따릅니다. 기본 설정은 다음과 같습니다.

{
    "columns": [
        {
            "key": "COLUMN_NAME",
            "name": {
              "en": "Name",
              "ko": "이름"
            }
        },
        {
            "key": "TYPE_NAME",
            "name": {
              "en": "Type",
              "ko": "유형"
            }
        },
        {
            "key": "COLUMN_SIZE",
            "name": {
              "en": "Size",
              "ko": "크기"
            },
            "align": "right"
        },
        {
            "key": "COLUMN_DEF",
            "name": {
              "en": "Default",
              "ko": "기본값"
            }
        },
        {
            "key": "IS_NULLABLE",
            "name": {
              "en": "Nullable",
              "ko": "NULL 허용"
            }
        },
        {
            "key": "@ALL",
            "name": {
              "en": "Constraint & Index",
              "ko": "제약 조건과 인덱스"
            }
        },
        {
            "key": "#DESCRIPTION",
            "name": {
              "en": "Description",
              "ko": "설명"
            },
            "code": false
        }
    ],
    "option": {
      "tableLayout": "20%,10%,10%,10%,10%,20%,20%"
    }
}

`key` 속성

첫 번째로 JDBC API가 제공하는 표준 칼럼 속성을 키로 사용합니다.

키	유형	설명
TABLE_CAT	문자열	테이블 카탈로그
TABLE_SCHEM	문자열	테이블 스키마
TABLE_NAME	문자열	테이블 이름
COLUMN_NAME	문자열	칼럼 이름
DATA_TYPE	숫자	`java.sql.Types`의 SQL 데이터 형식.
TYPE_NAME	문자열	데이터 형식의 이름
COLUMN_SIZE	숫자	칼럼의 자릿수
BUFFER_LENGTH	숫자	데이터의 전송 크기
DECIMAL_DIGITS	숫자	칼럼의 소수 자릿수
NUM_PREC_RADIX	숫자	칼럼의 기수
NULLABLE	숫자	칼럼이 null을 허용하는지 여부. 0이면 null을 허용하지 않고, 1이면 null을 허용합니다.
REMARKS	문자열	칼럼과 관련된 설명
COLUMN_DEF	문자열	칼럼 기본 값
SQL_DATA_TYPE	숫자
SQL_DATETIME_SUB	숫자
CHAR_OCTET_LENGTH	숫자	열의 최대 바이트 수
ORDINAL_POSITION	숫자	테이블 내의 열 인덱스
IS_NULLABLE	문자열	열에 null 값을 사용할 수 있는지 여부
SCOPE_CATALOG	문자열	참조하는 칼럼의 카탈로그. 참조하지 않는다면 null을 반환합니다.
SCOPE_SCHEMA	문자열	참조하는 칼럼의 스키마. 참조하지 않는다면 null을 반환합니다.
SCOPE_TABLE	문자열	참조하는 칼럼의 테이블. 참조하지 않는다면 null을 반환합니다.
SOURCE_DATA_TYPE	숫자
IS_AUTOINCREMENT	문자열	값을 자동으로 증가하는지 여부. YES 또는 NO를 반환합니다. 판단할 수 없으면 빈 값을 반환합니다.
IS_GENERATEDCOLUMN	문자열	값을 자동으로 계산하는지 여부. YES 또는 NO를 반환합니다. 판단할 수 없으면 빈 값을 반환합니다.

이 표는 JDBC API 문서를 기준으로 합니다. 데이터베이스와 JDBC 드라이버에 따라 별도의 키를 지원할 수도 있습니다.

칼럼 유형을 표시할 때 DATA_TYPE은 코드 값을 반환하기에 TYPE_NAME을 사용합니다.

{
    "key": "TYPE_NAME",
    "name": "유형"
}

두 번째로 업데이트할 때 쓰리래빗츠 북에서 편집한 내용을 유지할 수 있는 키가 있습니다. 칼럼 속성의 key가 #으로 시작하는 임의의 값을 사용합니다.

{
    "key": "#DESCRIPTION",
    "name": "설명"
}

세 번째로 기본 키(Primary Key), 외래 키(Foreign Key), 인덱스 등의 정보를 제공하는 키가 있습니다. 칼럼 속성의 key가 @으로 시작합니다.

@PK: 기본 키 정보를 보여줍니다.
@FK: 외래 키 정보를 보여줍니다.
@INDEX: 인덱스 정보를 보여줍니다.
@ALL: 기본 키, 외래 키, 인덱스 정보를 모두 보여줍니다. 표 너비 제한 때문에 기본 키, 외래 키, 인덱스를 따로 보여주기 어려울 때 사용합니다.

`name` 속성

name 속성으로 칼럼 속성 이름을 설정합니다. 없으면 key 속성을 이름으로 사용합니다.

{
    "key": "COLUMN_NAME",
    "name": "이름"
}

다양한 언어를 지원해야 한다면 다음과 같이 설정합니다. name 속성 값을 JSON 객체로 설정하고 각 언어를 키로 이름을 설정합니다.

{
    "key": "COLUMN_NAME",
    "name": {
        "ko": "이름",
        "en_US": "Name",
        "ja": "名前",
        "zh_CN": "名称"
    }
}

문서 언어에 따라 이름을 결정합니다.

`align` 속성

align 속성으로 좌우 정렬 방법을 설정합니다. left, right, center 등을 지원합니다. 기본 값은 left입니다.

{
    "key": "COLUMN_SIZE",
    "align": "right"
}

JSON으로 칼럼 정의하기

key 속성

name 속성

align 속성

`key` 속성

`name` 속성

`align` 속성