當您需要將本地文件或數據流導入到云數據庫 SelectDB 版實例時,您可以使用Stream Load進行數據同步導入,并通過即時的返回結果判斷本次導入是否成功。本文介紹如何通過Stream Load導入數據至云數據庫 SelectDB 版實例中。
背景信息
Stream Load屬于同步接口的導入方式,您可以通過發送HTTP請求將本地文件或數據流導入到云數據庫 SelectDB 版實例中。Stream Load執行并返回導入結果,您可以通過請求的返回結果判斷本次導入是否成功。
Stream Load適用于導入本地文件或通過程序導入數據流中的數據,支持的數據格式包括:CSV
(文本)、JSON
、PARQUET
和ORC
。
創建導入
Stream Load通過HTTP協議提交和傳輸數據。以下通過curl命令提交導入,也可以通過其他HTTP Client進行操作。
語法
# Header中支持的屬性,請參見下面的參數說明。
# 格式為: -H "key1:value1"。
curl --location-trusted -u <username>:<password> [-H ""] -H "expect:100-continue" -T <file_name> -XPUT http://<host>:<port>/api/<db
_name>/<table_name>/_stream_load
參數說明
參數名稱 | 參數說明 |
| 需要認證時,會將 |
| 指定云數據庫 SelectDB 版實例的用戶名和密碼。 |
| 指定本次Stream Load導入請求的請求頭(Header)內容。 |
| 指定需要導入數據的文件。 |
| HTTP請求的Method,采用PUT請求方法,指定云數據庫 SelectDB 版的數據導入地址,其中包括參數如下。
|
Stream Load使用HTTP協議,因此導入任務有關的參數主要設置在請求頭(Header)中。常用的導入參數如下。
參數名稱 | 參數說明 |
| 導入任務的唯一標識。 說明 推薦同一批次數據使用相同的 |
| 指定導入數據格式,默認值為 |
| 指定導入文件中的換行符,默認為 |
| 指定導入文件中的列分隔符,默認為 |
| 指定文件的壓縮格式。僅支持 |
| 指定導入任務的最大容忍率,默認為 |
| 指定是否開啟嚴格過濾模式,默認為 |
| 指定導入使用的集群。默認為該實例的默認集群。如果該實例沒有設置默認集群,則自動選擇一個有權限的集群。 |
| 指定是否只導入數據到對應分區的一個tablet,默認值為 |
| 指定導入任務的過濾條件。支持對原始數據指定 |
| 指定待導入數據的分區(Partition)信息。如果待導入數據不屬于指定的分區(Partition)則不會被導入。這些數據將計入dpp.abnorm.ALL。 |
| 指定待導入數據的函數變換配置。支持的函數變換方法包含列的順序變化以及表達式變換,其中表達式變換的方法與查詢語句的一致。 |
| 指定數據合并類型,默認為 |
| 僅在指定 |
| 只適用于UNIQUE_KEYS,相同Key列下,保證Value列按照source_sequence列進行REPLACE, source_sequence可以是數據源中的列,也可以是表結構中的一列。 |
| 指定導入內存限制。單位為字節,默認為 |
| 指定導入的超時時間,單位:秒,默認值為 |
| 指定本次導入所使用的時區,默認為" |
| 指定是否開啟兩階段事務提交模式,默認為 |
Stream load是一種同步的導入方式,因此導入的結果會通過創建導入的返回值直接返回給用戶。返回結果示例如下。
{
"TxnId": 17,
"Label": "707717c0-271a-44c5-be0b-4e71bfeacaa5",
"Status": "Success",
"Message": "OK",
"NumberTotalRows": 5,
"NumberLoadedRows": 5,
"NumberFilteredRows": 0,
"NumberUnselectedRows": 0,
"LoadBytes": 28,
"LoadTimeMs": 27,
"BeginTxnTimeMs": 0,
"StreamLoadPutTimeMs": 2,
"ReadDataTimeMs": 0,
"WriteDataTimeMs": 3,
"CommitAndPublishTimeMs": 18
}
返回結果參數說明如下。
參數名稱 | 參數說明 |
| 導入的事務ID。 |
| 導入 |
| 導入狀態,取值如下:
|
| 已存在的 這個字段只有在當Status為" |
| 錯誤信息提示。 |
| 導入總處理的行數。 |
| 成功導入的行數。 |
| 數據質量不合格的行數。 |
| 被 |
| 導入的字節數。 |
| 導入完成時間,單位毫秒。 |
| 向Fe請求開始一個事務所花費的時間,單位:毫秒。 |
| 向Fe請求獲取導入數據執行計劃所花費的時間,單位:毫秒。 |
| 讀取數據所花費的時間,單位:毫秒。 |
| 執行寫入數據操作所花費的時間,單位:毫秒。 |
| 向Fe請求提交并且發布事務所花費的時間,單位:毫秒。 |
| 如果有數據質量問題,通過訪問這個URL查看具體錯誤行。 |
使用Stream Load導入數據,示例如下。
curl --location-trusted -u admin:admin_123 -T data.csv -H "label:123" -H "expect:100-continue" http://selectdb-cn-h033cjs****-fe.selectdbfe.pre.rds.aliyuncs.com:8080/api/test_db/test_table/_stream_load
取消導入
無法手動取消Stream Load,Stream Load在超時或者導入錯誤后會被系統自動取消。
查看Stream Load
您可以通過show stream load
來查看已經完成的Stream load任務。默認BE(BackEnd)不保留Stream Load的啟用記錄,如果您要查看則需要在BE上啟用記錄,配置參數為:enable_stream_load_record=true,具體操作請參見BE配置項。?
使用示例
腳本示例
創建待導入的SelectDB數據表,示例如下。
CREATE TABLE test_table ( id int, name varchar(50), age int, address varchar(50), url varchar(500) ) UNIQUE KEY(`id`, `name`) DISTRIBUTED BY HASH(id) BUCKETS 16 PROPERTIES("replication_num" = "1");
創建待導入文件
test.data
,示例如下。1,yang,32,shanghai,http://example.com 2,wang,22,beijing,http://example.com 3,xiao,23,shenzhen,http://example.com 4,jess,45,hangzhou,http://example.com 5,jack,14,shanghai,http://example.com 6,tomy,25,hangzhou,http://example.com 7,lucy,45,shanghai,http://example.com 8,tengyin,26,shanghai,http://example.com 9,wangli,27,shenzhen,http://example.com 10,xiaohua,37,shanghai,http://example.com
使用不同參數配置導入數據,示例如下。
將本地文件
test.data
中的數據導入到數據庫test_db
中的test_table
表,使用Label
用于去重,指定超時時間為100秒。curl --location-trusted -u root -H "label:123" -H "timeout:100" -H "expect:100-continue" -H "column_separator:," -T test.data http://host:port/api/test_db/test_table/_stream_load
將本地文件
test.data
中的數據導入到數據庫test_db
中的test_table
表,使用Label用于去重,指定文件的列名,并且只導入address等于hangzhou的數據。curl --location-trusted -u root -H "label:123" -H "columns: id,name,age,address,url" -H "where: address='hangzhou'" -H "expect:100-continue" -H "column_separator:," -T test.data http://host:port/api/test_db/test_table/_stream_load
將本地文件
test.data
中的數據導入到數據庫test_db
中的test_table
表,允許20%的錯誤率。curl --location-trusted -u root -H "label:123" -H "max_filter_ratio:0.2" -H "expect:100-continue" -T test.data http://host:port/api/test_db/test_table/_stream_load
導入數據進行嚴格模式過濾,并設置時區為
Africa/Abidjan
。curl --location-trusted -u root -H "strict_mode: true" -H "timezone: Africa/Abidjan" -H "expect:100-continue" -T test.data http://host:port/api/test_db/test_table/_stream_load
刪除與這批導入Key相同的數據。
curl --location-trusted -u root -H "merge_type: DELETE" -H "expect:100-continue" -T test.data http://host:port/api/test_db/test_table/_stream_load
將這批數據中address列為hangzhou的數據的行刪除,其他行正常追加。
curl --location-trusted -u root: -H "expect:100-continue" -H "columns: id,name,age,address,url" -H "merge_type: MERGE" -H "delete: address='hangzhou'" -H "column_separator:," -T test.data http://host:port/api/testDb/testTbl/_stream_load
Java代碼示例
package com.selectdb.x2doris.connector.doris.writer;
import com.alibaba.fastjson2.JSON;
import org.apache.http.HttpHeaders;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.client.HttpClient;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.entity.BufferedHttpEntity;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultRedirectStrategy;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.protocol.RequestContent;
import org.apache.http.util.EntityUtils;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Base64;
import java.util.List;
import java.util.Map;
public class DorisLoadCase {
public static void main(String[] args) throws Exception {
// 1. 參數配置
String loadUrl = "http://<Host:Port>/api/<DB>/<TABLE>/_stream_load?";
String userName = "admin";
String password = "****";
// 2. 構建httpclient,特別注意需要開啟重定向(isRedirectable)
HttpClientBuilder httpClientBuilder = HttpClients.custom().setRedirectStrategy(new DefaultRedirectStrategy() {
// 開啟重定向
@Override
protected boolean isRedirectable(String method) {
return true;
}
});
httpClientBuilder.addInterceptorLast(new RequestContent(true));
HttpClient httpClient = httpClientBuilder.build();
// 3. 構建httpPut請求對象
HttpPut httpPut = new HttpPut(loadUrl);
// 設置httpHeader...
String basicAuth = Base64.getEncoder().encodeToString(String.format("%s:%s", userName, password).getBytes(StandardCharsets.UTF_8));
httpPut.addHeader(HttpHeaders.AUTHORIZATION, "Basic " + basicAuth);
httpPut.addHeader(HttpHeaders.EXPECT, "100-continue");
httpPut.addHeader(HttpHeaders.CONTENT_TYPE, "text/plain; charset=UTF-8");
RequestConfig reqConfig = RequestConfig.custom().setConnectTimeout(30000).build();
httpPut.setConfig(reqConfig);
// 4. 設置要發送的數據,這里寫入csv
// 假設有一張表,字段如下:
// field1,field2,field3,field4
// 這里模擬了三條csv記錄,doris 中csv的行分隔符默認是\n,列分隔符默認是\t
String data =
"1\t2\t3\t4\n" +
"11\t22\t33\t44\n" +
"111\t222\t333\t444";
httpPut.setEntity(new StringEntity(data));
// 5. 發送請求,處理結果
HttpResponse httpResponse = httpClient.execute(httpPut);
int httpStatus = httpResponse.getStatusLine().getStatusCode();
String respContent = EntityUtils.toString(new BufferedHttpEntity(httpResponse.getEntity()), StandardCharsets.UTF_8);
String respMsg = httpResponse.getStatusLine().getReasonPhrase();
if (httpStatus == HttpStatus.SC_OK) {
// 選擇適合的JSON序列化組件,對返回結果進行序列化
Map<String, String> respAsMap = JSON.parseObject(respContent, Map.class);
// 獲取SelectDB返回的狀態碼...
String dorisStatus = respAsMap.get("Status");
// SelectDB返回以下狀態,都表示數據寫入成功
List<String> DORIS_SUCCESS_STATUS = Arrays.asList("Success", "Publish Timeout", "200");
if (!DORIS_SUCCESS_STATUS.contains(dorisStatus) || !respMsg.equals("OK")) {
throw new RuntimeException("StreamLoad failed, status: " + dorisStatus + ", Response: " + respMsg);
} else {
System.out.println("successful....");
}
} else {
throw new IOException("StreamLoad Response HTTP Status Error, httpStatus: "+ httpStatus +", url: " + loadUrl + ", error: " + respMsg);
}
}
}
相關系統配置
FE配置
stream_load_default_timeout_second
:導入任務的超時時間,單位:秒。默認值為600。導入任務在設定的timeout時間內未完成則會被系統取消,變成CANCELLED。如果導入的源文件無法在規定時間內完成導入,您可以在Stream load請求中設置單獨的超時時間或者調整FE的參數stream_load_default_timeout_second
來設置全局的默認超時時間。
BE配置
streaming_load_max_mb
:Stream load的最大導入大小,單位:MB,默認值為10240。如果您的原始文件超過該值,則需要調整BE參數streaming_load_max_mb
。
Http Stream模式
在Stream Load中,依托Table Value Function(TVF)功能,可以通過使用SQL表達式來表達導入的參數。這個Stream Load依托TVF功能后名為http_stream
。更多Table Value Function(TVF)的使用方式,詳情請參見TVF。
使用http_stream進行Stream Load導入時的Rest API URL不同于Stream Load普通導入的 URL。
普通Stream Load的URL為:
http://host:http_port/api/{db}/{table}/_stream_load
。使用TVF http_stream的URL 為:
http://host:http_port/api/_http_stream
。
語法
Stream Load的Http Stream模式。
curl --location-trusted -u <username>:<password> [-H "sql: ${load_sql}"...] -T <file_name> -XPUT http://host:http_port/api/_http_stream
Http Stream參數說明請參見參數說明。
使用示例
在Http Header中添加一個SQL
的參數load_sql,去替代之前參數中的column_separator
、line_delimiter
、where
、columns
等參數,SQL
參數load_sql示例如下。
INSERT INTO db.table (col, ...) SELECT stream_col, ... FROM http_stream("property1"="value1");
完整示例:
curl --location-trusted -u admin:admin_123 -T test.csv -H "sql:insert into demo.example_tbl_1(user_id, age, cost) select c1, c4, c7 * 2 from http_stream(\"format\" = \"CSV\", \"column_separator\" = \",\" ) where age >= 30" http://host:http_port/api/_http_stream