跳轉到

指令碼開發 / 聯結器物件 DFF.CONN / 總覽

在建立聯結器後,可以在程式碼中呼叫 DFF.CONN(connector_id, **kwargs) 獲取指定聯結器的操作物件。

引數 型別 必須 / 預設值 說明
connector_id str 必須 聯結器 ID
**kwargs - - 覆蓋本次操作物件的部分配置,支援範圍取決於聯結器型別

傳入值為 None 或空白字串的可選引數會被忽略。未傳入可選引數時,操作物件使用聯結器中儲存的配置或程式碼預設值。

示例
1
2
3
4
@DFF.API('InfluxDB 操作演示')
def influxdb_demo():
    db = DFF.CONN('demo_influxdb')
    return db.query('SELECT * FROM demo LIMIT 3')

各聯結器支援的可選引數如下:

聯結器型別 可選引數 說明
觀測雲、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 覆蓋服務名
Microsoft SQL Server database 覆蓋預設資料庫
PostgreSQL database 覆蓋預設資料庫
MongoDB database 覆蓋預設資料庫
Elasticsearch timeout HTTP 請求超時時間,預設 10 秒
NSQ timeout HTTP 請求超時時間,預設 10 秒
MQTT Broker、Kafka - 無可選引數
Prometheus timeout HTTP 請求超時時間,預設 10 秒
阿里雲日誌服務 SLS - 無可選引數
LLM model、timeout 覆蓋預設模型;請求超時時間預設為 60 秒

只有上表列出的引數會影響對應操作物件,其他額外引數雖然可被呼叫入口接收,但聯結器實現不會使用。

覆蓋資料庫

資料庫類聯結器配置了預設資料庫時,查詢會在預設資料庫中進行。如本次操作需要使用其他資料庫,可以在獲取聯結器操作物件時傳入 database:

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

支援 database 引數的聯結器以引數表為準。對於不支援該引數的聯結器,如需操作其他資料庫,應建立不同的聯結器。

覆蓋 DataWay Token

DataWay 可以在獲取操作物件時覆蓋聯結器中儲存的 Token:

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

不同型別聯結器返回的操作物件具有不同方法,具體介面見對應聯結器文件。