Overview
Trix is currently in the v0.x release series. This guide covers upgrading between versions and preparing for future major releases.
- Back up your data with
trix export - Review changes in the Changelog
- Test in a staging environment first
- Check SDK compatibility with your runtime version
Current Version: v0.x
The v0.x series is the initial public release of Trix. During this phase, we may introduce breaking changes between minor versions as we refine the API based on user feedback.
v0.x Stability Note: While we strive for stability, the v0.x series is pre-1.0 software. Minor versions (0.1 → 0.2) may include breaking changes. Patch versions (0.1.0 → 0.1.1) are always backwards-compatible.
Checking Your Current Version
# Check CLI version
trix version
# Check for available updates
trix version --checkUpgrading Within v0.x
To upgrade to the latest v0.x version, update your SDK package:
# Update to latest v0.x
pip install --upgrade trixdb
# Or install a specific version
pip install trixdb==0.1.1v0.1.x Patch Notes
Patch releases within v0.1.x are backwards-compatible and include bug fixes and minor improvements. No code changes are required when upgrading between patch versions.
| Version | Type | Migration Required |
|---|---|---|
| 0.1.0 → 0.1.1 | Patch | No - just update the package |
| 0.1.x → 0.2.0 | Minor | Check changelog for breaking changes |
| 0.x → 1.0.0 | Major | Yes - follow the migration guide |
Looking Ahead: v1.0
We're working toward a stable v1.0 release. Here's what to expect:
v1.0 Goals: Stable API guarantees, improved performance, enhanced SDK ergonomics, and comprehensive documentation. We'll provide a detailed migration guide when v1.0 is released.
Planned Changes for v1.0
- Simplified method names: More intuitive naming like
remember()andrecall()as primary methods - Improved response types: Consistent pagination and metadata across all endpoints
- Enhanced TypeScript types: Better generic support and stricter type checking
- Async-first Python SDK: Native async/await as the default
Preparing for v1.0
To minimize migration effort when v1.0 is released:
- Use the latest v0.x SDK and stay current with patches
- Follow deprecation warnings in your logs
- Avoid using any methods marked as experimental or deprecated
- Subscribe to our changelog for early migration guidance
CLI Upgrade
The Trix CLI can be upgraded independently of the SDK:
# Update via Homebrew
brew upgrade devghost/taps/trix
# Verify version
trix versionConfig File Location
# Current v0.x config format
api_key: gdb_xxx
api_url: https://api.trixdb.com
default_space: space_abc123
output: tableRollback Procedures
If you encounter issues after upgrading, you can rollback to a previous version:
SDK Rollback
# Install a specific previous version
pip install trixdb==0.1.0
# Verify the version
pip show trixdbCLI Rollback
# Rollback via Homebrew
brew unlink trix
brew install devghost/taps/[email protected]
brew link [email protected]Data compatibility: Data written with a newer version may not be fully compatible with older SDK versions. Always test rollbacks in a non-production environment first.
API Versioning
The Trix REST API uses URL versioning. The current API version is v1, which is used by all v0.x SDKs.
| API Version | SDK Version | Status |
|---|---|---|
/v1/ | 0.x | Current |
The REST API version (/v1/) is independent of the SDK version (0.x). When we release SDK v1.0, it will continue to use the /v1/ API endpoints. We'll increment to /v2/ only if the API itself has breaking changes.
Migration Support
Need help with your upgrade? We're here to assist:
Community Discord
Ask questions and share experiences with other developers in our Discord community.
Email Support
Contact [email protected] for personalized upgrade assistance.
Enterprise Support
Enterprise plans include priority support for migrations and upgrades.
More Resources
Visit our Support page for additional help options and troubleshooting guides.