당신의 개발 Know-how를 기록하는 새로운 방법

개요

Machbase Neo는 Machbase time series database를 기반으로 사용자 편의성을 극대화한 All-in-one package 솔루션입니다.

Machbase Neo에 대한 자세한 내용은 웹사이트 https://docs.machbase.com/neo을 참고하면 됩니다.

Machbase Neo 기능 중에 문서를 작성할 수 있는 worksheet 라는 기능이 있다. 단순히 정적인 문서를 작성하는 것이 아니라 SQL 구문 등은 직접 실행해서 결과를 문서상에 표시할 수 있기 때문에 Interactive 하게 내용을 이해할 수 있습니다.

또한 작성된 worksheet 을 통해 Machbase Neo 사용법 등을 사용자 간 공유할 수 있어서 서로 간의 정보교류의 수단으로도 활용할 수 있습니다.

< Machbase Neo worksheet 실행 메뉴 >

Worksheet 작성 언어 — Markdown

Markdown 문법을 이용하여 worksheet를 작성한다. Markdown은 일반 텍스트 기반의 경량 마크업 언어로 태그 등을 이용하여 문서나 데이터의 구조 등을 표시하는 언어이다. 주로 텍스트만으로 서식 있는 문서를 작성할 때 사용되며, 문법이 간단하고 쉬어서 약간의 학습으로 누구나 문서를 작성할 수 있습니다.

Markdown은 Github, Notion, Discord 등 다양한 서비스 플랫폼에서 지원하고 있으며 대부분의 텍스트 에디터 환경에서 작성 및 수정이 가능합니다.

다만 파일이나 이미지가 문서 내에 바로 임베딩되지 않기 때문에서 별도의 서버에 업로드하고 나서 파일 URL을 입력해야 합니다.

Neo Markdown 문법

일반적인 Markdown 문법은 여기 (https://www.markdownguide.org/basic-syntax/).

Machbase Neo에서는 SQL 구문을 실행할 수 있는 버튼이 있어 SQL쿼리문을 실행하면 실제로 Neo TSDB에서 SQL 쿼리문을 실행하고 그 결과를 화면에 표시할 수 있는 기능이 있습니다.

< Machbase Neo worksheet에서 SQL 구문 실행 화면 예시 >

예를 들어, 작성 입력창에서 SQL 구문을 작성하고 문서 타입을 Markdown이 아닌 SQL로 선택하면 됩니다. 그리고 실행 아이콘을 클릭하면 해당 SQL 문이 실제로 수행이 되고 그 결과값을 아랫부분에 표시하게 됩니다. 단순히 static 문서를 read 하는 것이 아니라 interactive 하게 TSDB와 연동해서 동작 여부를 확인할 수 있습니다.

SQL 문장뿐만 아니라 Machbase Neo에서 제공하는 TQL 문법도 바로 실행이 가능하고 그 결과를 화면에 표시하게 됩니다.

Worksheet 관리

작성된 Worksheet은 저장하게 되면 Neo가 설치된 경로에 wrk 확장자 파일로 저장됩니다.

작성된 파일을 다른 사용자에게 공유하면 Machbase Neo의 Worksheet에서 바로 오픈하여 읽어볼 수 있습니다. Machbase Neo를 설치하면 워크시트를 사용하여 이미 작성된 튜토리얼 문서를 볼 수 있습니다.

< Machbase Neo built-in worksheet example >

Machbase Neo 메인화면에서 Drop&Open 영역에 해당 파일을 마우스로 drag & drop 하면 문서가 오픈됩니다.

결론

Machbase Neo Worksheet 기능은 텍스트 기반의 Markdown 언어를 통해 간단하고 쉽게 문서를 작성하고 관리할 수 있는 기능이다.

Machbase Neo 사용법 또는 가이드 문서를 작성하고 다른 사용자가 worksheet 문서를 read 하면서 쉽게 따라 해볼 수 있다. 특히 SQL 구문, TQL 구문은 문서상에서 바로 실행해서 결과를 확인해 볼 수 있기 때문에 초보자도 Machbase Neo 상에서 쉽게 따라 해보면서 내용을 파악할 수 있다.