Start a data sync

If your feature view is configured to use scheduled data sync, you canoptionally skip the wait until the next scheduled sync operation by manuallyinitiating the data sync.

You can't manually trigger a data sync if your feature view is configuredto use continuous data sync. For more information about the types of data syncthat Vertex AI Feature Store supports and how to configure the sync typefor a feature view, seeSync feature data in a feature view.

Note that to sync the data for the entire online store, you need to sync thedata for all of its feature views.

Data sync might involve costs for BigQuery resource usage. Forinformation about how to optimize costs while setting the sync schedule for afeature view, seeOptimize costs during sync.

Before you begin

Authenticate toVertex AI, unless you've done so already.

To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.

    Install the Google Cloud CLI. After installation,initialize the Google Cloud CLI by running the following command:

    gcloudinit

    If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

For more information, seeAuthenticate for using REST in the Google Cloud authentication documentation.

Manually start a data sync

Use the following sample to manually start the data sync in a feature viewconfigured for scheduled data sync.

Note that only one data sync operation can be active at any point of time fora feature view. If you try to manually start the data sync while another sync isin progress, then the new sync operation starts only after the ongoing syncoperation ends.

Caution: You can't trigger the data sync if your feature viewis configured forcontinuous data sync.If your feature view is configured for continuous data sync, then the featuredata is refreshed whenever the feature data in the BigQuery data source is updated.

REST

To manually start a data sync in aFeatureView,send aPOST request by using thefeatureViews.syncmethod.

Before using any of the request data, make the following replacements:

  • LOCATION_ID: Region where the online store is located, such asus-central1.
  • PROJECT_ID: Your project ID.
  • FEATUREONLINESTORE_NAME: The name of the online store containing the feature view.
  • FEATUREVIEW_NAME: The name of the feature view where you want to manually start the data sync.

HTTP method and URL:

POST https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featureOnlineStores/FEATUREONLINESTORE_NAME/featureViews/FEATUREVIEW_NAME:sync

To send your request, choose one of these options:

curl

Note: The following command assumes that you have logged in to thegcloud CLI with your user account by runninggcloud init orgcloud auth login , or by usingCloud Shell, which automatically logs you into thegcloud CLI . You can check the currently active account by runninggcloud auth list.

Execute the following command:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featureOnlineStores/FEATUREONLINESTORE_NAME/featureViews/FEATUREVIEW_NAME:sync"

PowerShell

Note: The following command assumes that you have logged in to thegcloud CLI with your user account by runninggcloud init orgcloud auth login . You can check the currently active account by runninggcloud auth list.

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featureOnlineStores/FEATUREONLINESTORE_NAME/featureViews/FEATUREVIEW_NAME:sync" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{  "featureViewSync": "projects/PROJECT_ID/locations/LOCATION_ID/featureOnlineStores/FEATUREONLINESTORE_NAME/featureViews/FEATUREVIEW_NAME/featureViewSyncs/OPERATION_ID"}

What's next

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.