🦁

【dbt core】ドキュメントを作成する

2022/11/03に公開約1,100字

ことはじめ

dbt clouldのドキュメント機能がめちゃめちゃ便利だなと思ってましたが、dbt cliもドキュメント機能があるのかなと思い調べてみました。結果的にドキュメントつくれちゃいました!

dbt cliとは

dbt Core には、dbt プロジェクトを実行するためのコマンドライン インターフェイス (CLI) > が付属しています。dbt CLI は無料で使用でき、オープン ソース プロジェクトとして利用で> > きます。

dbt cliの概要

実施環境

Core: 1.3.0

実施手順

1. dbt docs generate

まずは下記コマンドを実行しドキュメントを作成します。何も問題なければさくさくとできると思います。

dbt docs generate

2. dbt docs serve

次に下記コマンドを実行し、ローカル環境にブラウザ上にドキュメントを展開します。

dbt docs serve

すると、下記のようにちゃんとブラウザ上にドキュメントが現れます。

最後に

今回作成したドキュメントですが、使用しているファイルは下記の3つになります。

  • index.html
  • catalog.json
  • manifest.json

スナップショットでドキュメントを保持したい場合は、下記の方法などを使用してある一時点のドキュメントを保持することも可能そうです。


dbt's documentation website was built to make it easy to host on the web. The site is "static,”. You can host your documentation in several ways:

  • Use dbt Cloud
  • Host on Amazon S3 (optionally with IP access restrictions)
  • Publish with Netlify
  • Use your own web server like Apache/Nginx

参考記事

Discussion

ログインするとコメントできます