Data Management Service API

The data management service API allows you to sync data stored on the machine it is deployed on to the cloud.

The data management service supports the following methods:

The data client API supports a separate set of methods that allow you to upload and export data to and from the Viam app. For information about that API, see Data Client API.

Establish a connection

To get started using Viam’s SDKs to connect to and control your machine, go to your machine’s page on the Viam app, navigate to the CONNECT tab’s Code sample page, select your preferred programming language, and copy the sample code.

To show your machine’s API key in the sample code, toggle Include API key.

When executed, this sample code creates a connection to your machine as a client.

The following examples assume that you have a machine configured with an data_manager service.

import (
  "go.viam.com/rdk/services/datamanager"
)

API

Sync

Sync data stored on the machine to the cloud.

// Sync data stored on the machine to the cloud.
err := data.Sync(context.Background(), nil)

Reconfigure

Reconfigure this resource. Reconfigure must reconfigure the resource atomically and in place.

DoCommand

Execute model-specific commands that are not otherwise defined by the service API. For built-in service models, any model-specific commands available are covered with each model’s documentation. If you are implementing your own data manager service and add features that have no built-in API method, you can access them with DoCommand.

myDataManagerSvc, err := datamanager.FromRobot(machine, "my_data_manager_svc")

command := map[string]interface{}{"cmd": "test", "data1": 500}
result, err := myDataManagerSvc.DoCommand(context.Background(), command)

Close

Safely shut down the resource and prevent further use.

data, err := datamanager.FromRobot(machine, "my_data_manager")

err := data.Close(context.Background())