BulkImportAsync()
Creates an import job from the given data files (or cloud object/volume sources).
public async Task<BulkImportResp> BulkImportAsync(BulkImportRequest request, CancellationToken cancellationToken = default)
Request Syntax
var request = new BulkImportRequest
{
CollectionName = "my_collection",
Files = [["/tmp/import/book.parquet"]],
Options = { ["format"] = "json" }
};
BulkImportResp response = await bulkImport.BulkImportAsync(request);
REQUEST PARAMETERS:
DatabaseName(string) -The database to import into. Defaults to
"default".CollectionName(string) -The target collection name.
PartitionName(string?) -An optional partition to import into.
Files(IReadOnlyList> ) -The data files to import, grouped: each inner list is one file group. Open-source Milvus only uses this import mode, and exactly one import source (
Files, object URLs, or a volume) must be set.ClusterId(string?) -The cloud deployment target (Zilliz Cloud only).
ProjectId(string?) -The cloud project ID (Zilliz Cloud only).
RegionId(string?) -The cloud region ID (Zilliz Cloud only).
ObjectUrl(string?) -A singular object URL (Zilliz Cloud only; deprecated, prefer
ObjectUrls).ObjectUrls(IReadOnlyList> ) -The object URLs to import, grouped (Zilliz Cloud only).
AccessKey(string?) -The access key for object-URL import mode (Zilliz Cloud only).
SecretKey(string?) -The secret key for object-URL import mode (Zilliz Cloud only).
Token(string?) -The token for object-URL import mode (Zilliz Cloud only).
VolumeName(string?) -The volume name for volume import mode (Zilliz Cloud only).
DataPaths(IReadOnlyList> ) -The data paths for volume import mode (Zilliz Cloud only; requires
VolumeName).Options(IDictionary) - The import options, e.g.
["format"] = "json". Entries are added via the collection-initializer syntaxOptions = { ... }.
RETURN TYPE:
Task
RETURNS:
A BulkImportResp object that contains the envelope returned by the bulk-import REST endpoint. See BulkImportResp for its members.
EXCEPTIONS:
-
Thrown when the HTTP request fails or the server returns an error. Inspect the exception message for details.
Example
using Milvus.Client.V2;
using Milvus.Client.V2.Requests.Utility;
using Milvus.Client.V2.Responses.Utility;
using var bulkImport = new BulkImport(new BulkImportConfig
{
Url = "http://localhost:19530",
ApiKey = "..."
});
BulkImportResp response = await bulkImport.BulkImportAsync(new BulkImportRequest
{
CollectionName = "my_collection",
Files = [["/tmp/import/book.parquet"]],
Options = { ["format"] = "json" }
});
Console.WriteLine(response.JobId);