Skip to content

Commit

Permalink
docs: add docs on how to upgrade the schema of stable structures (#146)
Browse files Browse the repository at this point in the history
Adds a short doc on how attributes can be added to a stable structure.

Closes #109
  • Loading branch information
ielashi committed Sep 26, 2023
1 parent af272e4 commit 96ce8ab
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
66 changes: 66 additions & 0 deletions docs/schema-upgrades.md
Original file line number Diff line number Diff line change
@@ -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<u8>,
}

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<u8>,

// 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<u8>,

// The timestamp the asset was created at.
#[serde(default)]
created_at: u64,

// The username of the uploader.
uploaded_by: Option<String>,
}
```

0 comments on commit 96ce8ab

Please sign in to comment.