Skip to content

cdm コマンド

概要

cdm は、Codatum の機能をターミナルから操作するための CLI です。認証、データソースの参照、SQL の実行、仕様ドキュメントの取得に加え、ノートブックをマークダウン(*.cnb.md)でローカル編集してサーバと同期する機能も適用します。

本ドキュメントサイトの CLI リファレンスでは、マークダウン版ノートブック向けのコマンドを中心に説明します。cdm が提供するコマンドは次のとおりです。

コマンド用途
cdm updatecdm 本体を最新版に更新
cdm auth認証情報の管理
cdm docドキュメントの取得
cdm notebookノートブックファイルの操作
cdm connectionコネクション情報の取得
cdm catalogカタログの検索
cdm sqlSQL の実行

共通事項

認証

内部的に API 呼び出しを伴うコマンドは、cdm auth で登録した PAT (Personal Access Token) を利用します。

  • profile は --profile <name> フラグで指定します。未指定時はデフォルト profile が使われます。
  • CI 環境などでは CDM_PAT / CDM_PROFILE 環境変数によるオーバーライドが可能です。詳細は 環境変数によるオーバーライド を参照してください。

終了コードと出力先

cdm の各コマンドは、以下の方針で出力先と終了コードを使い分けます。

  • stdout: コマンドの主たるデータ出力(JSON / SQL / マークダウン等)
  • stderr: 進捗・サマリ・エラー等のメッセージ出力
  • exit 0: コマンドの正常終了(cdm sql run のSQLの実行エラー等は exit 0 で扱います)
  • exit 1: コマンドの異常終了(引数エラー、認証エラー、ネットワークエラー等)