Managing Versions
Managing CLI Versions
Downloading the CLI
All CloudQuery CLI versions are available for download on the releases page (opens in a new tab).
Homebrew
To update the CLI via Homebrew, run:
brew upgrade cloudquery/tap/cloudqueryTo install a specific version of the CLI, run:
brew install cloudquery/tap/cloudquery@<version>(e.g. brew install cloudquery/tap/cloudquery@2.3.10)
Managing Integration Versions
CloudQuery integrations are versioned independently of the CLI. Releases happen on a weekly schedule, using semantic versioning to indicate breaking schema changes as described in Source Integration Release Stages. We recommend pinning integration versions to avoid unexpected changes to your data model, and only upgrading to new versions when you need to take advantage of new features or bug fixes. That said, if you are okay with the risk of breaking changes (or able to use migrate_mode: forced), this how-to guide (opens in a new tab) describes how to keep integration versions up-to-date automatically using Renovate. In all cases, we recommend performing upgrades in a staging environment first before applying them to production.
Semantic Versioning
For version Major.Minor.Patch:
Majoris incremented when there are breaking changes (e.g. breaking configuration spec structure, column type changes).Minoris incremented when we add features in a backwards compatible way.Patchis incremented when we fix bugs in a backwards compatible way.
Source Integration Release Stages
Official source integrations (opens in a new tab) go through two release stages: Preview and Generally Available (GA).
Both Preview and GA integrations follow semantic versioning.
The main differences between the two stages are:
- Preview integrations are experimental and may have frequent breaking changes.
- Preview integrations might get deprecated due to lack of usage.
- Premium integrations in Preview are free to use.
- Long Term Support and bug fixes are only guaranteed for integrations that are Generally Available.