Skip to content

Commit 0a63842

Browse files
committed
few small fixes
1 parent b2ae765 commit 0a63842

3 files changed

Lines changed: 12 additions & 8 deletions

File tree

docs/migrations/v0_3_to_v1_0/database/README.md renamed to docs/migrations/v1_0/database/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ Depending on your application's availability requirements, choose one of the fol
1818
## 🏗️ Technical Overview
1919

2020
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.
2222
2. **Storage Model**: Transitioning from Pydantic-based JSON to Protobuf-based JSON serialization for better interoperability and performance.

docs/migrations/v0_3_to_v1_0/database/simple_migration.md renamed to docs/migrations/v1_0/database/simple_migration.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Simple Migration: v0.3 to v1.0
22

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.
44

55
---
66

@@ -39,9 +39,8 @@ uv run a2a-db --database-url "your-database-url"
3939
>For more details on the CLI migration tool, including flags, see the [A2A SDK Database Migrations README](../../../../src/a2a/migrations/README.md).
4040
4141
> [!NOTE]
42-
> All new columns are nullable or have default values.
4342
>
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.
4544
4645
### Step 2: Verify the Migration
4746

@@ -62,13 +61,18 @@ Upgrade your application to use the v1.0 SDK.
6261

6362
If your application fails to start or encounters errors after the migration:
6463

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.
6670
```bash
6771
uv run a2a-db downgrade -1
6872
```
69-
2. **Reinstall v0.3 SDK**: Revert your application code to the previous version.
7073
3. **Restart**: Resume operations using the v0.3 SDK.
7174

75+
7276
---
7377

7478
## 🧩 Resources

docs/migrations/v0_3_to_v1_0/database/zero_downtime.md renamed to docs/migrations/v1_0/database/zero_downtime.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ uv run a2a-db --database-url "your-database-url"
4141
>For more details on the CLI migration tool, including flags, see the [A2A SDK Database Migrations README](../../../../src/a2a/migrations/README.md).
4242
4343
> [!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.
4545
>
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.
4747
4848
#### ✅ How to Verify
4949
Confirm the schema is at the correct version:

0 commit comments

Comments
 (0)