RefreshExternalCollection()

Refreshes an external collection from its external data source.

pub async fn refresh_external_collection(&self, request: RefreshExternalCollectionRequest) -> Result<RefreshExternalCollectionResponse>

The operation is asynchronous and returns a job id that can be polled through GetRefreshExternalCollectionProgress.

Request Syntax

let request = RefreshExternalCollectionRequest::builder()
    .collection_name("books")
    .external_source("data_source")
    .build()?;

REQUEST FIELDS:

• database_name: Option<String>

  Name of the target database; uses the default database when empty.

• collection_name: String

  Name of the external collection to refresh. Required.

• external_source: String

  Name of the external data source to refresh from.

• external_spec: Option<serde_json::Value>

  Optional external-source specification as a JSON object.

RETURN TYPE:

Result

RETURNS:

A RefreshExternalCollectionResponse containing the ID of the refresh job. Returns an Error if the operation fails.

RefreshExternalCollectionResponse
    job_id() // -> i64

METHODS:

• job_id() (i64) -

  The ID of the refresh job.

Example

let request = RefreshExternalCollectionRequest::builder()
    .collection_name("books")
    .external_source("data_source")
    .build()?;
let resp = client.refresh_external_collection(request).await?;
println!("job_id: {}", resp.job_id());