데이터베이스 사전
이 페이지는 GitLab의 데이터베이스 스키마를 문서화하여 데이터 분석가 및 기타 그룹이 특정 데이터베이스 테이블을 담당하는 기능 카테고리를 찾을 수 있도록 합니다.
위치
데이터베이스 사전 메타데이터 파일은 gitlab 프로젝트의 main 및 ci 데이터베이스에 대해 db/docs/에 저장됩니다. embedding 데이터베이스의 경우, 사전 파일은 ee/db/embedding/docs/에 저장됩니다. geo 데이터베이스의 경우, 사전 파일은 ee/db/geo/docs/에 저장됩니다.
사전 파일 예
---
table_name: terraform_states
classes:
- Terraform::State
feature_categories:
- infrastructure_as_code
description: Represents a Terraform state backend
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26619
milestone: '13.0'
gitlab_schema: gitlab_main
테이블 추가
스키마
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
table_name
| 문자열 | 예 | 데이터베이스 테이블 이름 |
classes
| 문자열 배열 | 아니요 | 이 테이블과 관련된 클래스 목록 |
feature_categories
| 문자열 배열 | 예 | 이 테이블을 사용하는 기능 카테고리 목록 |
description
| 문자열 | 아니요 | 테이블에 저장된 정보 및 목적에 대한 설명 |
introduced_by_url
| URL | 아니요 | 이 테이블을 도입한 병합 요청 또는 커밋의 URL |
milestone
| 문자열 | 예 | 이 테이블을 도입한 단계 |
gitlab_schema
| 문자열 | 예 | GitLab 스키마 이름 |
프로세스
테이블을 추가할 때 다음을 수행해야 합니다:
- 해당 디렉터리에 대한 새 파일을 생성하세요:
-
gitlab_main테이블:db/docs/ -
gitlab_ci테이블:db/docs/ -
gitlab_shared테이블:db/docs/ -
gitlab_embedding테이블:ee/db/embedding/docs/ -
gitlab_geo테이블:ee/db/geo/docs/
-
- 파일의 이름을
<table_name>.yml로 지정하고, 테이블에 대해 알고 있는 만큼의 정보를 포함시키세요. - 테이블을 생성하는 마이그레이션과 함께 해당 파일을 포함시키세요.
테이블 삭제
스키마
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
table_name
| 문자열 | 예 | 데이터베이스 테이블 이름 |
classes
| 문자열 배열 | 아니요 | 이 테이블과 관련된 클래스 목록 |
feature_categories
| 문자열 배열 | 예 | 이 테이블을 사용하는 기능 카테고리 목록 |
description
| 문자열 | 아니요 | 테이블에 저장된 정보 및 목적에 대한 설명 |
introduced_by_url
| URL | 아니요 | 이 테이블을 도입한 병합 요청 또는 커밋의 URL |
milestone
| 문자열 | 아니요 | 이 테이블을 도입한 단계 |
gitlab_schema
| 문자열 | 예 | GitLab 스키마 이름 |
removed_by_url
| 문자열 | 예 | 이 테이블을 삭제한 병합 요청 또는 커밋의 URL |
removed_in_milestone
| 문자열 | 예 | 이 테이블을 삭제한 단계 |
프로세스
테이블을 삭제할 때 다음을 수행해야 합니다:
- 해당 테이블의 사전 파일을
deleted_tables디렉터리로 이동하세요:-
gitlab_main테이블:db/docs/deleted_tables/ -
gitlab_ci테이블:db/docs/deleted_tables/ -
gitlab_shared테이블:db/docs/deleted_tables/ -
gitlab_embedding테이블:ee/db/embedding/docs/deleted_tables/ -
gitlab_geo테이블:ee/db/geo/docs/deleted_tables/
-
- 사전 파일에
removed_by_url및removed_in_milestone필드를 추가하세요. - 해당 변경 사항을 테이블을 삭제하는 마이그레이션과 함께 포함시키세요.
뷰 추가
스키마
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
table_name
| 문자열 | 예 | 데이터베이스 뷰 이름 |
classes
| 문자열 배열 | 아니요 | 이 뷰와 관련된 클래스 목록 |
feature_categories
| 문자열 배열 | 예 | 이 뷰를 사용하는 기능 카테고리 목록 |
description
| 문자열 | 아니요 | 뷰에 저장된 정보 및 목적에 대한 설명 |
introduced_by_url
| URL | 아니요 | 이 뷰를 도입한 병합 요청 또는 커밋의 URL |
milestone
| 문자열 | 아니요 | 이 뷰를 도입한 단계 |
gitlab_schema
| 문자열 | 예 | GitLab 스키마 이름 |
프로세스
새로운 뷰를 추가할 때 다음을 해야 합니다:
- 적절한 디렉토리에 이 뷰를 위한 새 파일을 생성합니다:
-
gitlab_main뷰:db/docs/views/ -
gitlab_ci뷰:db/docs/views/ -
gitlab_shared뷰:db/docs/views/ -
gitlab_embedding뷰:ee/db/embedding/docs/views/ -
gitlab_geo뷰:ee/db/geo/docs/views/
-
- 파일의 이름을
<뷰_이름>.yml로 지정하고, 뷰에 대해 알고 있는 정보를 가능한 한 많이 포함합니다. - 이 파일을 해당 뷰를 생성하는 마이그레이션과 함께 커밋에 포함시킵니다.
뷰 삭제
스키마
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
view_name
| 문자열 | 예 | 데이터베이스 뷰 이름입니다. |
classes
| 문자열 배열 | 아니요 | 이 뷰에 연결된 클래스 목록입니다. |
feature_categories
| 문자열 배열 | 예 | 이 뷰를 사용하는 기능 범주 목록입니다. |
description
| 문자열 | 아니요 | 뷰에 저장된 정보 및 목적에 대한 텍스트 설명입니다. |
introduced_by_url
| URL | 아니요 | 이 뷰를 소개한 머지 요청 또는 커밋의 URL입니다. |
milestone
| 문자열 | 아니요 | 이 뷰를 소개한 마일스톤입니다. |
gitlab_schema
| 문자열 | 예 | GitLab 스키마 이름입니다. |
removed_by_url
| 문자열 | 예 | 이 뷰를 삭제한 머지 요청 또는 커밋의 URL입니다. |
removed_in_milestone
| 문자열 | 예 | 이 뷰를 삭제한 마일스톤입니다. |
프로세스
뷰를 삭제할 때 다음을 해야 합니다:
- 이 테이블에 대한 사전 파일을
deleted_views디렉토리로 이동합니다:-
gitlab_main뷰:db/docs/deleted_views/ -
gitlab_ci뷰:db/docs/deleted_views/ -
gitlab_shared뷰:db/docs/deleted_views/ -
gitlab_embedding뷰:ee/db/embedding/docs/deleted_views/ -
gitlab_geo뷰:ee/db/geo/docs/deleted_views/
-
- 사전 파일에
removed_by_url및removed_in_milestone필드를 추가합니다. - 이 변경 사항을 해당 뷰를 삭제하는 마이그레이션과 함께 커밋에 포함시킵니다.
도움말