kr-address-db-updater

kr-address-db-updater는 혼재된 국내 주소체계 데이터를 안정적이고 효율적으로 제공하기 위해 국내 주소체계 데이터베이스 구축 및 최신화를 자동화하는 시스템을 Node.js로 구현하는 프로젝트입니다.

🇱🇷 English Guide

빠른 시작

이 프로젝트는 Node.js, Docker 및 docker-compose 의존성으로 가집니다. 의존성이 설치되어있지 않을 경우 실행할 수 없으니 설치가 필요합니다.

• Node.js 다운로드
• Docker 다운로드
• docker-compose 다운로드

# 이 예제는 Linux 서버에서 시스템을 구축하는 예제를 구현합니다.

###
# 1. 레포지토리 클론
###

$ git clone https://github.com/SWM-SparkPlus/kr-address-db-updater.git
$ cd kr-address-db-updater

###
# 2. 환경변수 설정
###

# .env 파일의 DATABASE_URL, MYSQL_HOST, MYSQL_PORT, MYSQL_DATABASE, MYSQL_USER, MYSQL_PASSWORD, MYSQL_ROOT_PASSWORD 를 채워야 합니다.
# 예제에서는 .env.example의 예제 환경변수를 그대로 사용합니다.

$ cat .env.example > .env

###
# 3. 프로젝트 의존성 설치
###

$ npm install

###
# 4. 주소 데이터베이스 전체 및 변동분 다운 - MySQL 컨테이너 생성 - 데이터베이스 스키마 생성 및 구축
###

$ npm run setup:all

###
# 옵션 1. Spark+를 활성화하려면 데이터 참조를 위한 통합 테이블을 생성합니다.
###

$ npm run setup:integrated:address

###
# 옵션 2. 일일 변동분을 업데이트 합니다.
###

$ npm run update:address:daily

특징

1. 국내 최초의 한국 주소체계 데이터베이스 자동화 구축 및 최신화 시스템
2. AMD64 아키텍처 기반 UNIX 서버 최적화(4 Core CPU 기준)

• 전체구축: 10분 내 구축
• 누적 업데이트: 15일분 데이터 1분 내 모두 업데이트
• 일일 업데이트: 변동분의 데이터 크기에 따라 10초 내외 소요

아키텍처

Spark+ 전체 아키텍처

db-updater 아키텍처

도로명주소 데이터베이스 테이블 관계도

출처: 도로명주소 개발자센터

도로명코드 테이블(roadname_code)

테이블명: roadname_code

순번	컬럼명	실제컬럼명	크기	형식	PK	비고
1	도로명코드	roadname_code	12	문자	PK1	법정시도코드(2) + 법정시군구코드(3) + 도로명번호(7)
2	도로명	roadname	80	문자
3	도로명 로마자	roadname_eng	80	문자
4	읍면동일련번호	eupmyeondong_serial_number	2	문자	PK2
5	시도명	sido	20	문자
6	시도명 로마자	sido_eng	40	문자
7	시군구명	sigungu	20	문자
8	시군구명 로마자	sigungu_eng	40	문자
9	읍면동명	eupmyeondong	20	문자
10	읍면동명 로마자	eupmyeondong_eng	40	문자
11	읍면동구분	eupmyeondong_type	1	문자		0: 읍면, 1: 동, 2: 미부여
12	읍면동코드	eupmyeondong_code	3	문자		법정동기준읍면동코드
13	사용여부	is_using	1	문자		0: 사용, 1: 미사용
14	변경사유	change_reason	1	문자		0: 도로명변경, 1: 도로명폐지, 2: 시도시군구변경, 3: 읍면동변경, 4: 영문도로명변경, 9: 기타
15	변경이력정보	change_history	14	문자		도로명코드(12) + 읍면동일련번호(2). 신규일 경우 "신규"로 표시
16	고시일자	declare_date	8	문자		YYYYMMDD 형식 준수
17	말소일자	expire_date	8	문자		YYYYMMDD 형식 준수

도로명주소 테이블

테이블명: roadname_address_SIDO

순번	컬럼명	실제컬럼명	크기	형식	PK	비고
1	관리번호	manage_number	25	문자	PK	법정동코드(10) + 산여부(1) + 지번본번(4) + 지번부번(4) + 시스템번호(6)
2	도로명코드	roadname_code	12	문자		FK1, 법정시도코드(2) + 법정시군구코드(3) + 도로명번호(7)
3	읍면동일련번호	eupmyeondong_serial_number	2	문자		FK2
4	지하여부	is_basement	1	문자		0: 지상, 1: 지하
5	건물본번	building_primary_number	5	숫자
6	건물부번	building_secondary_number	5	숫자
7	기초구역번호	basic_state_number	5	문자
8	변경사유코드	change_reason_code	2	문자		월별/일일변동분에 한함. 31: 신규, 34: 변경, 63: 폐지
9	고시일자	notice_date	8	문자		NULL
10	변경전 도로명주소	previous_roadname_address	25	문자		NULL
11	상세주소 부여여부	has_detail	1	문자		0: 미부여, 1: 부여

지번주소 테이블

테이블명: jibun_address_SIDO

순번	컬럼명	실제컬럼명	크기	형식	비고
1	관리번호	manage_number	25	문자	PK1, FK, 법정동코드(10) + 산여부(1) + 지번본번(4) + 지번부번(4) + 시스템번호(6)
2	일련번호	serial_number	3	숫자	PK2
3	법정동코드	bupjungdong_code	10	문자	법정시도코드(2) + 시군구코드(3) + 읍면동(3) + 00
4	시도명	sido	20	문자
5	시군구명	sigungu	20	문자
6	법정읍면동명	bupjungeupmyeondong	20	문자
7	법정리명	bupjungli	20	문자
8	산여부	is_mountain	1	문자	0: 대지, 1: 산
9	지번본번(번지)	jibun_primary_number	4	숫자
10	지번부번(호)	jibun_secondary_number	4	숫자
11	대표여부	is_representation	1	문자	0: 관련지번, 1: 대표지번
12	변경사유코드	change_reason_code	2	문자	월별/일일변동분에 한함. 31: 신규, 34: 변경, 63: 폐지

부가정보 테이블

테이블명: additional_info_SIDO

순번	컬럼명	실제컬럼명	크기	형식	PK	비고
1	관리번호	manage_number	25	문자	PK	FK
2	행정동코드	hangjungdong_code	10	문자		참고용
3	행정동명	hangjungdong	20	문자		참고용
4	우편번호	zipcode	5	문자
5	우편번호 일련번호	zipcode_serial_number	3	문자
6	다량배달처명	bulk_delivery_building_name	40	문자
7	건축물대장 건물명	master_building_name	40	문자
8	시군구 건물명	sigungu_building_name	40	문자
9	공동주택여부	is_apt	1	문자		0: 비공동주택, 1: 공동주택

통합주소 테이블

테이블명: integrated_address_SIDO

Spark+에서 주소검색, 우편번호 맵핑 등에 사용하기 위한 데이터만 뽑은 테이블입니다.

순번	컬럼명	실제컬럼명	크기	형식	PK	비고
1	관리번호	manage_number	25	문자	PK	FK
2	도로명코드	roadname_code	12	문자		도로명주소 테이블. 참고용
3	우편번호	zipcode	5	문자		도로명주소 테이블(기초구역번호). 우편번호 맵핑용
4	시도명	sido	20	문자		도로명코드 테이블. 도로명주소 생성용
5	시군구명	sigungu	20	문자		도로명코드 테이블. 도로명주소 생성용
6	읍면동명	eupmyeondong	20	문자		지번주소 테이블(법정읍면동). 도로명주소 생성용.
7	법정리명	bupjungli	20	문자		지번주소 테이블. 도로명주소 생성용
8	도로명	roadname	80	문자		도로명코드 테이블. 도로명주소 생성용
9	지하여부	is_basement	1	문자		도로명주소 테이블. 도로명주소 생성용
10	건물본번	building_primary_number	5	숫자		도로명주소 테이블. 도로명주소 생성용
11	건물부번	building_secondary_number	5	숫자		도로명주소 테이블. 도로명주소 생성용
12	지번본번	jibun_primary_number	5	숫자		도로명주소 테이블. 지번주소 생성용
13	지번부번	jibun_secondary_number	5	숫자		도로명주소 테이블. 지번주소 생성용
14	법정동코드	bupjungdong_code	10	문자		지번주소 테이블. 도로명주소 생성용

LICENSE

MIT