テンプレート
Morphには、SQLやPythonのコードをより簡単に記述するためにテンプレートの機能があります。 テンプレートには2種類存在しています。
標準で用意されているテンプレート (Built-in Template)
ソースコードをワークスペース上で開くとMorphチームが作成した標準のテンプレートが右のサイドバーから確認することができます。 このテンプレートは、Morphのフレームワークのスニペットの役割をしており、コピーをすることですぐに分析部分の実装を開始することができます。
テンプレートの要望がある場合には、shibata@morphdb.io
まで是非リクエストください!
自作テンプレート (Custom Template)
templates
フォルダでは、ユーザー定義のテンプレートファイルを作成して管理することができます。
作成したテンプレートからmorph create
コマンドで新規ファイルを作ることができます。またmorph search
コマンドで検索することもできます。
テンプレートの作成手順
(手順1) テンプレートファイルの作成
テンプレートファイルはtemplatesディレクトリ配下に作成します。
作成時には以下のプレースホルダーを定義できます。(プレースホルダーで定義した値は後述するmorph createコマンドのオプションで指定することで、置換してファイルが作成されます。)
${MORPH_NAME}
: テンプレート名(旧エイリアス)に置換されます。(morph create
コマンドの--name
オプションの指定)${MORPH_DESCRIPTION}
: テンプレート説明に置換されます。(morph create
コマンドの—-description
オプションの指定)
E.g.)
(手順2) template.yamlの編集
templatesフォルダ直下のtemplate.yamlを編集します。Syntaxは以下の例を参考にしてください。
※srcはフルパスまたはtemplate.yamlからの相対パスで定義します。
E.g.)
(手順3) コンパイル
以下のコマンドでtemplate.yamlの妥当性をチェックすることができます。テンプレートファイルを作成してtemplate.yamlの編集まで終わったら、VSコードのターミナルから以下のコマンドを叩いてください。
テンプレートの利用方法
設定をしたテンプレートはワークスペースの右側のメニューやキャンバス内の新規作成時に使用することができます。
テンプレート一覧から選択
キャンバスから選択
CLIからテンプレートを利用する方法
以下のコマンドで作成できます。
※<テンプレート名>
はtemplate.yamlで定義したnameを指定します。また、テンプレートAPI が返却するnameを指定することで、グローバルのテンプレートを利用することもできます。