Tutorial.md

May 21, 2025 ยท View on GitHub

QuickStart Guide

This guide will help you get started with how to use vts to transport vector data into milvus, currently, we support the following 3 source connectors:

  • milvus
  • postgres vector
  • elastic search

Standalone mode

  • standalone mode is used for demo only, it's not recommended for production use.

1. Build the vts project

./mvnw install -Dmaven.test.skip

2. Setup the configuration file

go to ./seatunnel-example/seatunnel-examples/src/main/resources/examples, update the conf file

  • milvus_to_milvus.conf
  • pg_to_milvus.conf
  • es_to_milvus.conf

here is an example of milvus_to_milvus.conf

env {
  parallelism = 1
  job.mode = "BATCH"
}

source {
  Milvus {
    url="https://in01-***.aws-us-west-2.vectordb.zillizcloud.com:19530"
    token="***"
    database="default"
    collections=["medium_articles"]
    batch_size=100
  }
}

sink {
  Milvus {
    url="https://in01-***.aws-us-west-2.vectordb.zillizcloud.com:19542"
    token="***"
    database="default"
    batch_size=10
  }
}

3. Run examples

The example file is located at ./seatunnel-example/seatunnel-examples/src/main/java/com/zilliz/seatunnel/examples/engine/SeatunnelEngineExample.java

update the configuration file path in SeatunnelEngineExample.java, and run the example.

String configurePath = args.length > 0 ? args[0] : "/examples/****.conf";

4. Check the data in milvus

go to milvus console, check the data in the collection

Cluster mode

1. Build the vts project

./mvnw install -Dmaven.test.skip

2. Run Examples

Run this example to start the server

./seatunnel-example/seatunnel-examples/src/main/java/com/zilliz/seatunnel/examples/engine/SeatunnelEngineServerExample.java

3. Submit Job through Restful API

check the example in

./seatunnel-example/seatunnel-examples/src/main/resources/examples/curl.sh

Deployment

...