スクリプト開発 / コネクターオブジェクト DFF.CONN / 概要

コネクターを作成した後、コード内で DFF.CONN(connector_id, **kwargs) を呼び出して、指定したコネクターの操作オブジェクトを取得できます。

パラメータ	型	必須 / デフォルト値	説明
connector_id	str	必須	コネクター ID
**kwargs	-	-	この操作オブジェクトの一部設定を上書きします。サポート範囲はコネクタータイプによって異なります。

値が None または空白文字列であるオプションパラメータは無視されます。オプションパラメータを渡さない場合、操作オブジェクトはコネクターに保存されている設定またはコードのデフォルト値を使用します。

@DFF.API('InfluxDB 操作デモ')
def influxdb_demo():
    db = DFF.CONN('demo_influxdb')
    return db.query('SELECT * FROM demo LIMIT 3')

各コネクターでサポートされているオプションパラメータは次のとおりです。

コネクタータイプ	オプションパラメータ	説明
GuanceCloud、TrueWatch	timeout	HTTPリクエストのタイムアウト時間。デフォルトは 10 秒
DataKit	source、timeout、split_size	Source、リクエストタイムアウト時間、バッチ分割サイズを上書き
DataWay	token、timeout、split_size	Token、リクエストタイムアウト時間、バッチ分割サイズを上書き
DataFlux Func Sidecar	timeout	HTTPリクエストのタイムアウト時間。デフォルトは 10 秒
InfluxDB	database	デフォルトのデータベースを上書き
MySQL	database	デフォルトのデータベースを上書き
Redis	database、client_name	データベース番号とRedisクライアント名を上書き
Memcached	-	オプションパラメータなし
ClickHouse	database	デフォルトのデータベースを上書き
Oracle Database	database	サービス名を上書き
Microsoft SQL Server	database	デフォルトのデータベースを上書き
PostgreSQL	database	デフォルトのデータベースを上書き
MongoDB	database	デフォルトのデータベースを上書き
Elasticsearch	timeout	HTTPリクエストのタイムアウト時間。デフォルトは 10 秒
NSQ	timeout	HTTPリクエストのタイムアウト時間。デフォルトは 10 秒
MQTT Broker、Kafka	-	オプションパラメータなし
Prometheus	timeout	HTTPリクエストのタイムアウト時間。デフォルトは 10 秒
Alibaba Cloud ログサービス SLS	-	オプションパラメータなし
LLM	model、timeout	デフォルトのモデルを上書き。リクエストタイムアウト時間のデフォルトは 60 秒

上記の表に記載されているパラメータのみが対応する操作オブジェクトに影響します。その他の追加パラメータは呼び出しエントリで受け取ることはできますが、コネクター実装では使用されません。

データベースの上書き

データベース系コネクターにデフォルトのデータベースが設定されている場合、クエリはデフォルトのデータベースで実行されます。今回の操作で他のデータベースを使用する必要がある場合は、コネクター操作オブジェクトを取得するときに database を渡します。

db = DFF.CONN('demo_influxdb', database='my_database')

database パラメータをサポートするコネクターはパラメータ表に従います。このパラメータをサポートしないコネクターで他のデータベースを操作する必要がある場合は、別のコネクターを作成する必要があります。

DataWay Token の上書き

DataWayは、操作オブジェクトを取得するときにコネクターに保存されているTokenを上書きできます。

dataway = DFF.CONN('df_dataway', token='xxxxx')

異なるタイプのコネクターが返す操作オブジェクトには異なるメソッドがあります。具体的なインターフェースは、対応するコネクターのドキュメントを参照してください。