Machbase NeoのWorksheetで使い方とノウハウを共有する
概要
Machbase Neoは、Machbaseの時系列データベースを基盤に、使いやすさを追求したオールインワンのソリューションです。
Machbase Neoの詳細は公式ドキュメントをご覧ください。
Neoには、文書を作成できるWorksheet機能があります。静的な説明文だけでなく、SQLなどをその場で実行して結果を文書内に表示できるため、操作しながら内容を理解できます。
作成したWorksheetを共有すれば、Neoの使い方やノウハウをユーザー同士で交換することもできます。

Machbase NeoのWorksheet起動メニュー
Worksheetの記述言語:Markdown
Worksheetの説明文にはMarkdownを使います。Markdownは、プレーンテキストに簡単な記号を加えて見出しやリストなどの構造を表す軽量マークアップ言語です。少し学ぶだけで、書式のある文書を作成できます。
GitHub、Notion、Discordなどのサービスで利用されており、多くのテキストエディターで作成・編集できます。
画像やファイルそのものをMarkdown本文に埋め込むわけではないため、参照先でアクセスできる場所に配置し、そのURLを文書に記載します。
NeoでのMarkdownと実行セル
一般的なMarkdownの記法は、Markdown Guideの基本構文を参照してください。
Machbase Neoでは、SQLを実行するボタンが用意されています。クエリを実行すると、Neoの時系列データベースに問い合わせ、その結果を画面に表示します。

WorksheetでSQLを実行した画面の例
例えば入力欄にSQLを書き、セルの種類をMarkdownではなくSQLにします。実行アイコンをクリックするとSQLが実行され、下部に結果が表示されます。説明を読むだけでなく、実際のデータベースとやり取りしながら動作を確認できます。
SQLに加え、Neoが提供するTQLも直接実行して、結果を画面に表示できます。
Worksheetの管理
作成したWorksheetを保存すると、Neo側の保存先に拡張子 .wrk のファイルとして格納されます。
ファイルをほかのユーザーに共有すると、相手もNeoのWorksheetで開いて内容を確認できます。Neoに用意されているチュートリアル文書も、Worksheetとして読むことができます。

Machbase Neoに付属するWorksheetの例
Neoのメイン画面にある「Drop&Open」領域へファイルをドラッグ&ドロップすると、文書が開きます。
まとめ
Machbase NeoのWorksheetを使えば、Markdownで文書を簡単に作成・管理できます。
使い方やガイドをWorksheetにまとめて共有すれば、読者は説明を読みながら操作を試せます。特にSQLやTQLは文書内から実行して結果を確認できるため、初めてのユーザーも実際に動かしながらNeoを学べます。


