Delete

Delete allows you to remove Items by one of their key paths. You can use any of the Item’s key paths and the Item will be deleted from all of them. Delete doesn’t return anything, whether or not anything was actually deleted (e.g. if there wasn’t any Item at the given key path). Delete also supports batches of up to 50 key paths at a time.

For this example we’ll use the schema defined in Example: Movies Schema, which defines Movie as an Item Type with the key path /movies-:id.


15 collapsed lines
1
package main
2

3
import (
4
  "context"
5
  "fmt"
6
  "os"
7
  "slices"
8
  "strconv"
9
  "time"
10

11
  "github.com/StatelyCloud/go-sdk/stately"
12
  // This is the code you generated from schema
13
  "github.com/StatelyCloud/stately/go-sdk-sample/schema"
14
)
15

16
func sampleDelete(
17
  ctx context.Context,
18
  client stately.Client,
19
  movieID []byte,
20
) error {
21
  return client.Delete(ctx, "/movie-"+stately.ToKeyID(movieID))
22
}


6 collapsed lines
1
require 'bundler/setup'
2
require 'statelydb'
3
require_relative 'schema/stately.item_types'
4
require 'byebug'
5

6

7
def sample_delete(client, movie_id)
8

9
  key_path = StatelyDB::KeyPath.with('movie', movie_id)
10
  client.delete(key_path)
11

12
end


9 collapsed lines
1
from __future__ import annotations
2

3
from typing import TYPE_CHECKING
4

5
from statelydb import ListToken, SyncChangedItem, SyncDeletedItem, SyncReset, key_path
6

7
from .schema import Actor, Change, Character, Client, Movie
8

9

10
async def sample_delete(client: Client, movie_id: UUID) -> None:
11
    kp = key_path("movie-{id}", id=movie_id)
12
    await client.delete(kp)


3 collapsed lines
1
import { createClient, DatabaseClient, Movie } from "./schema/index.js";
2
import { keyPath, ListToken } from "@stately-cloud/client";
3

4
async function sampleDelete(client: DatabaseClient) {
5
  // Put a movie
6
  let movie = await client.put(
7
    client.create("Movie", {
8
      genre: "action",
9
      year: 1997n,
10
      title: "Starship Troopers",
11
      rating: "R",
12
      duration: 7_740n,
13
    }),
14
  );
15

16
  // Delete the movie
17
  await client.del(keyPath`/movie-${movie.id}`);
18
}

1
# There are no key path helpers for shell, so you need to
2
# manually base64-encode the UUID's bytes
3
stately item delete \
4
  --store-id <store-id-goes-here> \
5
  --item-key '/movie-2hC3sMFFSlelJlFf9hRD9g'

Tombstones

Deleted Items leave behind a “tombstone” record which lets you know that they have been deleted. You can’t interact with the tombstone through any of our APIs, but it’s important that they exist to allow SyncList to tell you about Items that have been deleted since your last sync. Tombstones take up very little space and are automatically cleaned up after some time (on the order of weeks).