Migration guides
Health Connector SDK follows semantic versioning: only major releases contain breaking changes. Each has a dedicated guide with before-and-after code for every change.
v2.x.x → v3.0.0
Difficulty: moderate · roughly 30 minutes for a typical app
| Breaking change | What it affects |
|---|---|
| Logging system redesign | HealthConnectorLoggerConfig and log processors replace the previous logging setup |
| API renaming | The largest section — many method and type names changed |
| Health record property types | Properties moved to typed measurement units |
| Meal type unification | One MealType vocabulary across platforms |
| Metadata constructor changes | Metadata.manualEntry() / Metadata.automaticallyRecorded() |
| Exception hierarchy & error handling | Typed exceptions carrying HealthConnectorErrorCode |
New in v3.0.0: the incremental sync API, record sorting, and HealthDataTypeCategory.
v1.x.x → v2.0.0
Difficulty: moderate · roughly 15–30 minutes for a typical app
| Breaking change | What it affects |
|---|---|
| Delete records API redesign | Delete requests are now built from a HealthDataType |
| Read records method rename | Method naming aligned with the rest of the API |
| Error code changes | Codes renamed and regrouped |
| Aggregate response type | Aggregates return typed results |
| Update record return type | Return value simplified |
New in v2.0.0: individual permission status checks, batch updates (Android), activity-specific distance types (iOS), speed data types, and exercise session support.
Upgrading within a major version
Minor and patch releases are backward compatible. Note two version-specific build requirements introduced along the way:
- v3.9.0+ requires
compileSdkExtension 19in your Android Gradle configuration, because it builds against Health Connect 1.2.0-alpha03. See Requirements. ExerciseSessionSegmentEvent.weightadditionally requires the device's Health Connect Mainline module to be at SDK Extension 21, checked at runtime. See Annotations.
The changelog lists every release.