dodil k3 vector store
Per-bucket vector engine lifecycle. Four subcommands — create, get, delete, list-instances. Configure once at bucket setup time; rarely touched afterwards.
Persistent flag on the whole group: --bucket / -b (required for create / get / delete; ignored for list-instances).
| Subcommand | API |
|---|---|
dodil k3 vector store create | ConfigureEngine |
dodil k3 vector store get | GetEngine |
dodil k3 vector store delete | DeleteEngine |
dodil k3 vector store list-instances | ListVBaseInstances |
dodil k3 vector store create
dodil k3 vector store create -b BUCKET [-m MODE]Configures the bucket’s vector engine. auto (default) provisions a fresh VBase database for you; external points at your own VBase cluster.
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--mode | -m | string | auto | auto (K3 provisions) or external (your own VBase) |
# Auto mode — K3 handles VBase provisioning
dodil k3 vector store create -b kb-prod
# External mode flag (see CLI gap below)
dodil k3 vector store create -b kb-prod -m externalExternal mode is a CLI gap today. The
--mode externalflag is accepted, but the CLI doesn’t expose the required follow-on flags (vbase_endpoint,vbase_port,vbase_db_name). For external mode, use the API directly — see API Reference → ConfigureEngine.
pickmode (reuse an existing VBase service) is not in the CLI at all. Use the API.
After create, poll get until status reaches ENGINE_STATUS_ACTIVE — typically under a minute for auto mode.
dodil k3 vector store get
dodil k3 vector store get -b BUCKETReturns the engine row — status, mode, VBase connection info, and the bucket’s collections inline.
dodil k3 vector store get -b kb-prod -o json \
| jq '{status, mode, vbaseEndpoint, vbaseDbName, collectionCount: (.collections | length)}'Status path on a fresh create:
PENDING ─► PROVISIONING ─► ACTIVE
│
▼ on provisioning failure
ERROR (error_message populated)ACTIVE is the steady state — collections + search operate against this engine.
dodil k3 vector store delete
dodil k3 vector store delete -b BUCKETRemoves K3’s engine row + the bucket’s VBase connection config. Does NOT drop the underlying VBase database (auto-mode only) — the database persists for re-attach.
dodil k3 vector store delete -b kb-prod
--delete-databaseflag is a CLI gap. The API supportsdelete_database: trueto also drop the VBase database (auto mode only) — the CLI doesn’t expose it. For a full teardown via CLI today, delete the engine here, then drop the VBase database directly via VBase . Or use the API:curl -sS -X DELETE "https://k3.dev.dodil.io/kb-prod/vector" \ -H "Authorization: Bearer $DODIL_TOKEN" \ -H "Content-Type: application/json" \ -d '{"bucket":"kb-prod","deleteDatabase":true}'
Does NOT cascade to collections or to Scriptum pipelines / ingest rules bound to pipeline-mode collections in this bucket — those persist and reference an orphaned engine. Clean them up separately if you want a clean reset.
dodil k3 vector store list-instances
dodil k3 vector store list-instancesLists the VBase services available to the org. Useful for picking an existing service when configuring engines in pick mode (via the API).
dodil k3 vector store list-instances -o json \
| jq '.instances[] | {serviceId, name, status, serviceType}'
--bucketis inherited from the parent group but ignored bylist-instances— the call is org-scoped. You can omit-b.
Sample output:
{
"serviceId": "vb_svc_a1b2...",
"name": "prod-cluster-us-east-1",
"status": "running",
"serviceType": "cluster"
}The serviceId is what you’d pass to ConfigureEngine with mode: "pick".
Common gotchas
| Symptom | Cause | Fix |
|---|---|---|
get returns status: ENGINE_STATUS_PROVISIONING for minutes | VBase provisioning still running (auto mode) | Wait — usually under 60 s. If stuck > 5 min, check error_message |
create succeeds but collections all show COLLECTION_STATUS_ERROR | Engine in ERROR — provisioning failed | get to see error_message; recreate with delete then create |
delete succeeds but bucket still has collections | Delete didn’t cascade to collections | Run dodil k3 vector collection list -b BUCKET and clean up explicitly |
delete doesn’t free VBase resources | The delete_database: true flag is not on the CLI | Use the API call shown above OR drop the VBase DB directly |
See also
- Engine — API Reference — full surface incl.
external+pickmode configuration anddelete_database - Core Concepts → Engine — type signature + three-modes table
- VBase — the underlying managed-Milvus product
dodil k3 vector collection— what you create once the engine is ACTIVE