You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/migrations/v1_0/database/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,5 +18,5 @@ Depending on your application's availability requirements, choose one of the fol
18
18
## 🏗️ Technical Overview
19
19
20
20
The v1.0 database migration involves:
21
-
1.**Schema Updates**: Adding `protocol_version`, `owner`, and `last_updated` columns to the `tasks` and `push_notification_configs`tables.
21
+
1.**Schema Updates**: Adding `protocol_version`, `owner`, and `last_updated` columns to the `tasks`table and `protocol_version`, `owner` columns to the `push_notification_configs`table.
22
22
2.**Storage Model**: Transitioning from Pydantic-based JSON to Protobuf-based JSON serialization for better interoperability and performance.
Copy file name to clipboardExpand all lines: docs/migrations/v1_0/database/simple_migration.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Simple Migration: v0.3 to v1.0
2
2
3
-
This guide is for users who can afford a short period of downtime (typically a few minutes) during the migration from A2A protocol v0.3 to v1.0. This is the recommended path for single-instance applications or non-critical services.
3
+
This guide is for users who can afford a short period of downtime during the migration from A2A protocol v0.3 to v1.0. This is the recommended path for single-instance applications or non-critical services.
4
4
5
5
---
6
6
@@ -39,9 +39,8 @@ uv run a2a-db --database-url "your-database-url"
39
39
>For more details on the CLI migration tool, including flags, see the [A2A SDK Database Migrations README](../../../../src/a2a/migrations/README.md).
40
40
41
41
> [!NOTE]
42
-
> All new columns are nullable or have default values.
43
42
>
44
-
> Protocol v1.0 is designed to be backward compatible by default. After this step, your new v1.0 code will be able to read existing v0.3 entries from the database using a built-in legacy parser.
43
+
> Database stores v1.0 are designed to be backward compatible by default. After this step, your new v1.0 code will be able to read existing v0.3 entries from the database using a built-in legacy parser.
45
44
46
45
### Step 2: Verify the Migration
47
46
@@ -62,13 +61,18 @@ Upgrade your application to use the v1.0 SDK.
62
61
63
62
If your application fails to start or encounters errors after the migration:
64
63
65
-
1.**Revert Schema**: Use the `downgrade` command to step back to the v0.3 structure.
64
+
1.**Revert Application Code**: Revert your application code to use the v0.3 SDK.
65
+
66
+
> [!NOTE]
67
+
> Older SDKs are compatible with the new schema (as new columns are nullable). If something breaks, rolling back the application code is usually sufficient.
68
+
69
+
2.**Revert Schema (Fallback)**: If you encounter database issues, use the `downgrade` command to step back to the v0.3 structure.
66
70
```bash
67
71
uv run a2a-db downgrade -1
68
72
```
69
-
2. **Reinstall v0.3 SDK**: Revert your application code to the previous version.
70
73
3. **Restart**: Resume operations using the v0.3 SDK.
Copy file name to clipboardExpand all lines: docs/migrations/v1_0/database/zero_downtime.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,9 +41,9 @@ uv run a2a-db --database-url "your-database-url"
41
41
>For more details on the CLI migration tool, including flags, see the [A2A SDK Database Migrations README](../../../../src/a2a/migrations/README.md).
42
42
43
43
> [!NOTE]
44
-
> All new columns are nullable or have default values. Your existing v0.3 code will continue to work normally after this step is completed.
44
+
> All new columns are nullable. Your existing v0.3 code will continue to work normally after this step is completed.
45
45
>
46
-
> Protocol v1.0 is designed to be backward compatible by default. After this step, your new v1.0 code will be able to read existing v0.3 entries from the database using a built-in legacy parser.
46
+
> Database stores v1.0 are designed to be backward compatible by default. After this step, your new v1.0 code will be able to read existing v0.3 entries from the database using a built-in legacy parser.
0 commit comments