コンテンツにスキップ

Func カスタムクエリ関数

この記事では、DataFlux Func を使用してカスタムクエリ関数を作成し、外部データを処理して、チャートの要件に合わせて返却結果を構成する方法を説明します。QueryHub のネイティブクエリと DQL Like はサーバー側で結果が処理されるため、Func のチャートデータ構造にラップする必要はありません。

コネクタを設定する

Func の開発 > コネクタで、対象データソースのタイプと一致するコネクタを作成し、接続先アドレスと認証情報を入力して、接続をテストします。

以下の例では、ID が mysql の MySQL コネクタが作成済みであることを前提とします:

mysql = DFF.CONN('mysql')

スクリプトで Guance の API も呼び出す必要がある場合は、対応するコネクタとワークスペース API キーを別途設定できます。データベースコネクタと API コネクタでは認証情報の用途が異なります。設定の入り口についてはFunc 経由での接続を参照してください。

データクエリ関数を作成する

category='dataPlatform.dataQueryFunc' を使用して、データクエリで使用できる関数を登録します。

以下の例は my_table テーブルを読み取るもので、次の条件を前提とします:

  • createTime は Unix タイムスタンプを秒単位で保存します。
  • reqCost はリクエストの所要時間です。
  • チャートから渡される time_range には開始時刻と終了時刻が含まれ、単位はミリ秒です。
@DFF.API('查询请求耗时', category='dataPlatform.dataQueryFunc')
def query_request_cost(time_range):
    mysql = DFF.CONN('mysql')

    sql = '''
        SELECT createTime, reqCost
        FROM my_table
        WHERE createTime >= ? AND createTime < ?
        ORDER BY createTime
        LIMIT 100
    '''
    parameters = [
        int(time_range[0] / 1000),
        int(time_range[1] / 1000),
    ]
    rows = mysql.query(sql, parameters)

    return {
        'series': [[{
            'columns': ['time', 'req_cost'],
            'tags': {},
            'values': [
                [row['createTime'] * 1000, row['reqCost']]
                for row in rows
            ],
        }]],
    }

コネクタ ID、テーブル名、フィールド名は置き換えてください。また、実際のデータの時間単位に合わせて換算を調整してください。この例の SQL パラメータは ? の出現順にバインドされ、文字列連結によって時間値が埋め込まれることはありません。

返却構造を理解する

フィールド 意味
series クエリ表示に使用するデータシリーズ。この例では外側に 2 階層の配列を保持します
columns 各行の値のフィールド順。この例では 1 列目が time、2 列目が req_cost です
tags 現在のシリーズのタグ。タグの組み合わせが異なる場合は、それぞれ別のシリーズとして構成する必要があります
values columns と対応する 2 次元データ。この例では時間列を統一してミリ秒で出力します

これは Func チャートの返却構造であり、スクリプトが QueryHub の DQL Like 式を実行していることを示すものではありません。

チャートタイプ別に結果を構成する

チャートの種類によって、シリーズ、時間列、タグに関する要件が異なります。詳細な形式については以下を参照してください:

関数の設定と呼び出しについては、Function 外部関数設定およびチャートデータソースクエリも参照してください。

フィードバック

このページは役に立ちましたか?