Skip to content

Document data source type support for data pipelines #4394

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

promptless[bot]
Copy link
Contributor

@promptless promptless bot commented Jun 10, 2025

Based on PR DATA-4228, document the new data source type functionality for data pipelines. This PR adds support for specifying data source types when creating and updating data pipelines, allowing users to choose between different data storage backends (standard, hotstorage) for their pipeline operations.

Key Changes:

  • New --data-source-type CLI flag for data pipeline commands (create, update, list, describe)
  • Support for "standard" and "hotstorage" data source types
  • Default behavior uses "standard" data source type when not specified
  • Updated Go SDK methods to accept data source type parameters
  • Enhanced CLI validation for data source type values

Documentation Needs:

  1. Update CLI documentation to explain the new --data-source-type flag
  2. Document the available data source types and their use cases
  3. Provide examples of using data source types in CLI commands
  4. Update SDK documentation to show the new API parameters
  5. Explain the default behavior and when users might want to specify different types

This functionality allows users to optimize their data pipeline performance and storage characteristics by choosing the appropriate data source type for their specific use case.

Trigger Events


If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)

Copy link

netlify bot commented Jun 10, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 3d28474
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/68489fda0330b90008f2162a
😎 Deploy Preview https://deploy-preview-4394--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 56 (🟢 up 10 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot
Copy link
Member

viambot commented Jun 10, 2025

👋 Thanks for contributing! A reviewer will look at it on the next working day!

Copy link
Contributor Author

promptless bot commented Jun 10, 2025

Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.)

Comment on lines +385 to +386
| `--machine-id` | Filter by specified machine ID. | `export binary`, `delete`, `tag filter` | Optional |
| `--machine-name` | Filter by specified machine name. | `export binary`, `delete`, `tag filter`| Optional |
Copy link
Member

Choose a reason for hiding this comment

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

Flagging this since it came up today: many commands have a --machine option, aliased to --machine-name and --machine-id, which you can pass either a machine id or machine name to. Curious that this list includes the aliases but not the parent option (when our other docs explicitly mention only the parent option, with one notable exception where there is no alias).

Copy link
Member

Choose a reason for hiding this comment

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

Update: looks like this whole data section was lifted from below to preserve alphabetical order. Don't be fooled into thinking this part is all original like I was 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants