morph-dbutils

What is morphdb-utils

概要

morphdb-utils は、Morphプラットフォーム上でデータを操作し、可視化するためのPythonライブラリです。このライブラリは、データの読み込み、SQLクエリの実行、ファイルデータの取得、可視化をサポートする一連の関数とデコレータを提供します。各機能は、ユーザーがMorphのPythonセル内でデータを効率的に操作し、結果を視覚的に表示することを目的として設計されています。

主な機能

  • データ読み込みと変換: SQLクエリやファイルデータを pandas.DataFrame に変換して読み込む機能。
  • データの可視化: データを図表として描画し、HTML形式で出力するデコレータ。
  • エラーハンドリング: APIリクエストやデータ処理中に発生する可能性のあるエラーを適切に処理し、明確なエラーメッセージを提供。

利用方法

ライブラリ内の関数やデコレータは、直接呼び出すことができ、MorphのPythonセルで直接使用することが可能です。また、各関数は環境変数から設定を読み取ることができるため、設定の柔軟性が保たれています。

主な関数

  • ref: 指定されたセル名から関連情報を取得。
  • execute_sql: SQLクエリを実行し、結果をDataFrameとして返す。
  • load_file_data: 指定されたファイルからデータを読み込み、DataFrameとして返す。
  • load_data: 指定されたデータソースタイプに基づきデータを読み込み、DataFrameとして返す。
  • generate_report: セルから可視化されたデータを集めて、集約されたレポートを生成します。

デコレータ

  • transform: データ変換関数が pandas.DataFrame を返すことを保証。
  • visualize: 可視化関数が図表を生成し、それをMorphダッシュボード上で表示。
  • report: テキストを整形して表示し、セルのレポーティング機能をサポート。

利用例

詳細な使用例は、関数ごとのドキュメントを参照してください。

データを公開する@transform