Skip to main content

trigger

This operation triggers a refresh job for an external collection. Returns the job ID.

Description

Starts a refresh job for an external collection in the current cluster context. Use the returned jobId to check the job with zilliz external-collection refresh describe.

Synopsis

bash
zilliz external-collection refresh trigger
--name <value>
[--database <value>]
[--external-source <value>]
[--external-spec <value>]

Options

  • --name (string) -

    [REQUIRED]

    Specifies the external collection name.

  • --database (string) -

    Specifies the database name.

  • --external-source (string) -

    Overrides the external source (optional).

  • --external-spec (string) -

    Overrides the external spec (optional).

Example

bash
# Trigger refresh for an external collection
zilliz external-collection refresh trigger --name my_external_coll

# Example output
# {
# "jobId": 123456
# }

# Trigger refresh in a non-default database
zilliz external-collection refresh trigger --name my_external_coll --database my_db
Minimum SDK versionv1.4.x
Ctrl I