diff --git a/README.md b/README.md index fff76635..ef8890b8 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,10 @@ For more information about the philosophy behind the library, see [Roman's tutor - [Cell]: A serializable value - [MinHeap]: A priority queue. +## Tutorials + +[Schema Upgrades](./docs/schema-upgrades.md) + ## How it Works Stable structures are able to work directly in stable memory because each data structure manages diff --git a/docs/schema-upgrades.md b/docs/schema-upgrades.md new file mode 100644 index 00000000..12758e50 --- /dev/null +++ b/docs/schema-upgrades.md @@ -0,0 +1,66 @@ +# Schema Upgrades + +Stable structures store data directly in stable memory and do not require upgrade hooks. +Since these structures are designed to persist throughout the lifetime of the canister, it's nearly inevitable that developers would want to make modifications to the data's schema as the canister evolves. + +Let's say you are storing assets in your canister. The declaration of it can look something like this: + +```rust +#[derive(Serialize, Deserialize, CandidType)] +struct Asset { + // The contents of the asset. + contents: Vec, +} + +impl Storable for Asset { + fn to_bytes(&self) -> std::borrow::Cow<[u8]> { + let mut bytes = vec![]; + ciborium::ser::into_writer(&self, &mut bytes).unwrap(); + Cow::Owned(bytes) + } + + fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self { + ciborium::de::from_reader(&*bytes).expect("deserialization must succeed.") + } + + const BOUND: Bound = Bound::Unbounded; +} +``` + +> **Note:** Stables structures do not enforce a specific data format. +It's up to the developer to use the data format that fits their use-case. +In this example, CBOR is used for encoding `Asset`. + + +## Adding an attribute + +Adding a new field can be as simple as adding the field, like this: + +```rust +#[derive(Serialize, Deserialize)] +struct Asset { + // The contents of the asset. + contents: Vec, + + // The timestamp the asset was created at. + #[serde(default)] + created_at: u64, +} +``` + +If the new attribute being added doesn't have a sensible default value, consider wrapping it in an `Option`: + +```rust +#[derive(Serialize, Deserialize, CandidType)] +struct Asset { + // The contents of the asset. + contents: Vec, + + // The timestamp the asset was created at. + #[serde(default)] + created_at: u64, + + // The username of the uploader. + uploaded_by: Option, +} +```