Skip to content

DOCS-4142: Document 4 MB maximum size limit for tabular data readings #4445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ The following attributes are available for data capture configuration:
| Name | Type | Required? | Description |
| ------------------ | ------ | --------- | ----------- |
| `capture_frequency_hz` | float | **Required** | Frequency in hertz at which to capture data. For example, to capture a reading every 2 seconds, enter `0.5`. |
| `method` | string | **Required** | Depends on the type of component or service. See [Supported components and services](/data-ai/capture-data/capture-sync/#click-to-see-resources-that-support-data-capture-and-cloud-sync). |
| `method` | string | **Required** | Depends on the type of component or service. See [Supported components and services](/data-ai/capture-data/capture-sync/#click-to-see-resources-that-support-data-capture-and-cloud-sync). **Note:** For tabular data, Viam enforces a maximum size of 4MB for any single reading. |
| `retention_policy` | object | Optional | Option to configure how long data collected by this component or service should remain stored in the Viam Cloud. You must set this in JSON mode. See the JSON example for a camera component. <br> **Options:** `"days": <int>`, `"binary_limit_gb": <int>`, `"tabular_limit_gb": <int>`. <br> Days are in UTC time. Setting a retention policy of 1 day means that data stored now will be deleted the following day **in UTC time**. You can set either or both of the size limit options and size is in gigabytes. The `retention_policy` does not affect logs. For information about logs, see [Logging](/operate/reference/viam-server/#logging). |
| `recent_data_store` | object | Optional | Configure a rolling time frame of recent data to store in a [hot data store](#capture-to-the-hot-data-store) for faster access. Example: `{ "stored_hours": 24 }` |
| `additional_params` | depends | depends | Varies based on the method. For example, `ReadImage` requires a MIME type. |
Expand Down
4 changes: 4 additions & 0 deletions static/include/app/apis/generated/data_sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,10 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s
Upload tabular data collected on your machine through a specific {{< glossary_tooltip term_id="component" text="component" >}} to Viam.
Uploaded tabular data can be found under the **Sensors** subtab of the app's [**Data** tab](https://app.viam.com/data).

{{< alert title="Size limit" color="note" >}}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to be put in an override instead of generated?

Viam enforces a maximum size of 4MB for any single reading for tabular data.
{{< /alert >}}

{{< tabs >}}
{{% tab name="Python" %}}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
Upload tabular data collected on your machine through a specific {{< glossary_tooltip term_id="component" text="component" >}} to [Viam](https://app.viam.com).
Uploaded tabular data can be found under the **Sensors** subtab of the [**Data** tab](https://app.viam.com/data).
Uploaded tabular data can be found under the **Sensors** subtab of the [**Data** tab](https://app.viam.com/data).

{{< alert title="Size limit" color="note" >}}
Viam enforces a maximum size of 4MB for any single reading for tabular data.
{{< /alert >}}
Loading