tbls로 BigQuery 데이터 세트에 대한 문서 생성

이 항목에서는 tbls 에서 BigQuery 데이터세트의 문서를 생성할 때까지 소개합니다.

"이미 GCP에서 프로젝트와 데이터 세트가 생성되었습니다"라는 점에서 설명하고 싶습니다.

다만, 이번에는 GCP가 공개하고 있는 프로젝트 bigquery-public-data 와 그 데이터 세트의 하나 census_bureau_international 를 이용하므로, 반드시 데이터 세트를 준비할 필요는 없습니다.

1. 서비스 계정 생성 및 키 파일 다운로드

tbls에서 BigQuery 데이터세트에 액세스할 때 구성 파일 tbls.yml에서 다음과 같이 DSN을 지정합니다.

# tbls.yml
dsn: bq://bigquery-public-data/census_bureau_international?creds=/path/to/google_application_credentials.json

먼저 위의 ?creds=/path/to/google_application_credentials.json 자격 증명 파일 google_application_credentials.json를 만듭니다.



먼저 콘솔의 IAM 및 관리 > 서비스 계정에서 서비스 계정 만들기를 클릭합니다.



서비스 계정 세부정보를 입력합니다.



서비스 계정의 권한은 'BigQuery 메타데이터 뷰어'에서 좋습니다.
(덧붙여서, 자세한 인용에 필요한 Permission를 들으면 bigquery.datasets.get bigquery.tables.get bigquery.tables.list의 3개입니다)



키 만들기를 클릭합니다.



키 유형은 "JSON"입니다.

그래서 다운로드 된 JSON을, 이번에는

"google_application_credentials.json 에 파일 이름을 변경하고 /path/to/google_application_credentials.json 에 넣었다"

라고 합시다.

2. tbls 설치

Mac 사용자는 Homebrew로 설치하는 것이 좋습니다.

$ brew install k1LoW/tap/tbls

다른 OS를 사용하는 경우 tbls의 README #install을 참조하여 적절한 설치 방법을 선택하십시오.

3. tbls.yml 만들기

임의의 디렉토리에서 tbls.yml 파일을 작성하십시오.

# tbls.yml
dsn: bq://bigquery-public-data/census_bureau_international?creds=/path/to/google_application_credentials.json

4. 문서 만들기

문서를 만듭니다. tbls.yml이 있는 디렉토리에서 다음 명령을 실행하십시오.

$ tbls doc -f

dbdoc 디렉토리가 작성되어 그 안에 Markdown 형식으로 문서가 생성되고 있다고 생각합니다.

GitHub 리포지토리에 커밋하면 그냥 느낌입니다.

덤. Excel 테이블 정의의 출력

tbls.yml이 있는 디렉토리에서 다음 명령을 실행하십시오.

$ tbls out -t xlsx -o tbls.xlsx

출력됩니다.
Columns 이나 Name 를 일본어로 하고 싶은 경우는 tbls.yml의 dict : 설정을 추가해보십시오.

이상, tbls 에서의 BigQuery의 데이터 세트의 문서 생성의 소개였습니다.