mirror of
https://github.com/clockworklabs/SpacetimeDB.git
synced 2026-05-06 15:49:35 -04:00
Shubham Mishra
e4098f98d9
## Description of Changes
This PR primarily affects the `bindings-macro` and `schema` crates to
review:
### Core changes
1. Replaces the `name` macro with `accessor` for **Tables, Views,
Procedures, and Reducers** in Rust modules.
2. Extends `RawModuleDefV10` with a new section for:
* case conversion policies
* explicit names
New sections are not validated in this PR so not functional.
3. Updates index behavior:
* Index names are now always **system-generated** for clients. Which
will be fixed in follow-up PR when we start validating RawModuleDef with
explicit names.
* The `accessor` name for an index is used only inside the module.
## Breaking changes (API/ABI)
1. **Rust modules**
* The `name` macro must be replaced with `accessor`.
2. **Client bindings (all languages)**
* Index names are now system-generated instead of using explicitly
provided names.
**Complexity:** 3
A follow-up PR will reintroduce explicit names with support for case
conversion.
---------
Co-authored-by: rekhoff <r.ekhoff@clockworklabs.io>
Co-authored-by: clockwork-labs-bot <clockwork-labs-bot@users.noreply.github.com>
Co-authored-by: clockwork-labs-bot <bot@clockworklabs.com>
451 lines
13 KiB
Rust
451 lines
13 KiB
Rust
//! STDB module used for benchmarks.
|
|
//!
|
|
//! This file is tightly bound to the `benchmarks` crate (`crates/bench`).
|
|
//!
|
|
//! The various tables in this file need to remain synced with `crates/bench/src/schemas.rs`
|
|
//! Field orders, names, and types should be the same.
|
|
//!
|
|
//! We instantiate multiple copies of each table. These should be identical
|
|
//! aside from indexing strategy. Table names must match the template:
|
|
//!
|
|
//! `{IndexStrategy}{TableName}`, in PascalCase.
|
|
//!
|
|
//! The reducers need to remain synced with `crates/bench/src/spacetime_module.rs`
|
|
//! Reducer names must match the template:
|
|
//!
|
|
//! `{operation}_{index_strategy}_{table_name}`, in snake_case.
|
|
//!
|
|
//! The three index strategies are:
|
|
//! - `unique`: a single unique key, declared first in the struct.
|
|
//! - `no_index`: no indexes.
|
|
//! - `btree_each_column`: one index for each column.
|
|
//!
|
|
//! Obviously more could be added...
|
|
#![allow(non_camel_case_types)]
|
|
#![allow(clippy::too_many_arguments)]
|
|
use spacetimedb::{log, ReducerContext, Table};
|
|
use std::hint::black_box;
|
|
|
|
// ---------- schemas ----------
|
|
|
|
#[spacetimedb::table(accessor = unique_0_u32_u64_str)]
|
|
pub struct unique_0_u32_u64_str_t {
|
|
#[primary_key]
|
|
id: u32,
|
|
age: u64,
|
|
name: String,
|
|
}
|
|
|
|
#[spacetimedb::table(accessor = no_index_u32_u64_str)]
|
|
pub struct no_index_u32_u64_str_t {
|
|
id: u32,
|
|
age: u64,
|
|
name: String,
|
|
}
|
|
|
|
#[spacetimedb::table(accessor = btree_each_column_u32_u64_str)]
|
|
pub struct btree_each_column_u32_u64_str_t {
|
|
#[index(btree)]
|
|
id: u32,
|
|
#[index(btree)]
|
|
age: u64,
|
|
#[index(btree)]
|
|
name: String,
|
|
}
|
|
|
|
#[spacetimedb::table(accessor = unique_0_u32_u64_u64)]
|
|
pub struct unique_0_u32_u64_u64_t {
|
|
#[primary_key]
|
|
id: u32,
|
|
x: u64,
|
|
y: u64,
|
|
}
|
|
|
|
#[spacetimedb::table(accessor = no_index_u32_u64_u64)]
|
|
pub struct no_index_u32_u64_u64_t {
|
|
id: u32,
|
|
x: u64,
|
|
y: u64,
|
|
}
|
|
|
|
#[spacetimedb::table(accessor = btree_each_column_u32_u64_u64)]
|
|
pub struct btree_each_column_u32_u64_u64_t {
|
|
#[index(btree)]
|
|
id: u32,
|
|
#[index(btree)]
|
|
x: u64,
|
|
#[index(btree)]
|
|
y: u64,
|
|
}
|
|
|
|
// ---------- empty ----------
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn empty(_ctx: &ReducerContext) {}
|
|
|
|
// ---------- insert ----------
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_unique_0_u32_u64_str(ctx: &ReducerContext, id: u32, age: u64, name: String) {
|
|
ctx.db
|
|
.unique_0_u32_u64_str()
|
|
.insert(unique_0_u32_u64_str_t { id, name, age });
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_no_index_u32_u64_str(ctx: &ReducerContext, id: u32, age: u64, name: String) {
|
|
ctx.db
|
|
.no_index_u32_u64_str()
|
|
.insert(no_index_u32_u64_str_t { id, name, age });
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_btree_each_column_u32_u64_str(ctx: &ReducerContext, id: u32, age: u64, name: String) {
|
|
ctx.db
|
|
.btree_each_column_u32_u64_str()
|
|
.insert(btree_each_column_u32_u64_str_t { id, name, age });
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_unique_0_u32_u64_u64(ctx: &ReducerContext, id: u32, x: u64, y: u64) {
|
|
ctx.db
|
|
.unique_0_u32_u64_u64()
|
|
.insert(unique_0_u32_u64_u64_t { id, x, y });
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_no_index_u32_u64_u64(ctx: &ReducerContext, id: u32, x: u64, y: u64) {
|
|
ctx.db
|
|
.no_index_u32_u64_u64()
|
|
.insert(no_index_u32_u64_u64_t { id, x, y });
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_btree_each_column_u32_u64_u64(ctx: &ReducerContext, id: u32, x: u64, y: u64) {
|
|
ctx.db
|
|
.btree_each_column_u32_u64_u64()
|
|
.insert(btree_each_column_u32_u64_u64_t { id, x, y });
|
|
}
|
|
|
|
// ---------- insert bulk ----------
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_bulk_unique_0_u32_u64_u64(ctx: &ReducerContext, locs: Vec<unique_0_u32_u64_u64_t>) {
|
|
for loc in locs {
|
|
ctx.db.unique_0_u32_u64_u64().insert(loc);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_bulk_no_index_u32_u64_u64(ctx: &ReducerContext, locs: Vec<no_index_u32_u64_u64_t>) {
|
|
for loc in locs {
|
|
ctx.db.no_index_u32_u64_u64().insert(loc);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_bulk_btree_each_column_u32_u64_u64(ctx: &ReducerContext, locs: Vec<btree_each_column_u32_u64_u64_t>) {
|
|
for loc in locs {
|
|
ctx.db.btree_each_column_u32_u64_u64().insert(loc);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_bulk_unique_0_u32_u64_str(ctx: &ReducerContext, people: Vec<unique_0_u32_u64_str_t>) {
|
|
for u32_u64_str in people {
|
|
ctx.db.unique_0_u32_u64_str().insert(u32_u64_str);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_bulk_no_index_u32_u64_str(ctx: &ReducerContext, people: Vec<no_index_u32_u64_str_t>) {
|
|
for u32_u64_str in people {
|
|
ctx.db.no_index_u32_u64_str().insert(u32_u64_str);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn insert_bulk_btree_each_column_u32_u64_str(ctx: &ReducerContext, people: Vec<btree_each_column_u32_u64_str_t>) {
|
|
for u32_u64_str in people {
|
|
ctx.db.btree_each_column_u32_u64_str().insert(u32_u64_str);
|
|
}
|
|
}
|
|
|
|
// ---------- update ----------
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn update_bulk_unique_0_u32_u64_u64(ctx: &ReducerContext, row_count: u32) {
|
|
let mut hit: u32 = 0;
|
|
for loc in ctx.db.unique_0_u32_u64_u64().iter().take(row_count as usize) {
|
|
hit += 1;
|
|
ctx.db.unique_0_u32_u64_u64().id().update(unique_0_u32_u64_u64_t {
|
|
id: loc.id,
|
|
x: loc.x.wrapping_add(1),
|
|
y: loc.y,
|
|
});
|
|
}
|
|
assert_eq!(hit, row_count, "not enough rows to perform requested amount of updates");
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn update_bulk_unique_0_u32_u64_str(ctx: &ReducerContext, row_count: u32) {
|
|
let mut hit: u32 = 0;
|
|
for u32_u64_str in ctx.db.unique_0_u32_u64_str().iter().take(row_count as usize) {
|
|
hit += 1;
|
|
ctx.db.unique_0_u32_u64_str().id().update(unique_0_u32_u64_str_t {
|
|
id: u32_u64_str.id,
|
|
name: u32_u64_str.name,
|
|
age: u32_u64_str.age.wrapping_add(1),
|
|
});
|
|
}
|
|
assert_eq!(hit, row_count, "not enough rows to perform requested amount of updates");
|
|
}
|
|
|
|
// ---------- iterate ----------
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn iterate_unique_0_u32_u64_str(ctx: &ReducerContext) {
|
|
for u32_u64_str in ctx.db.unique_0_u32_u64_str().iter() {
|
|
black_box(u32_u64_str);
|
|
}
|
|
}
|
|
#[spacetimedb::reducer]
|
|
pub fn iterate_unique_0_u32_u64_u64(ctx: &ReducerContext) {
|
|
for u32_u64_u64 in ctx.db.unique_0_u32_u64_u64().iter() {
|
|
black_box(u32_u64_u64);
|
|
}
|
|
}
|
|
|
|
// ---------- filtering ----------
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_unique_0_u32_u64_str_by_id(ctx: &ReducerContext, id: u32) {
|
|
if let Some(p) = ctx.db.unique_0_u32_u64_str().id().find(id) {
|
|
black_box(p);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_no_index_u32_u64_str_by_id(ctx: &ReducerContext, id: u32) {
|
|
for p in ctx.db.no_index_u32_u64_str().iter().filter(|p| p.id == id) {
|
|
black_box(p);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_btree_each_column_u32_u64_str_by_id(ctx: &ReducerContext, id: u32) {
|
|
for p in ctx.db.btree_each_column_u32_u64_str().id().filter(&id) {
|
|
black_box(p);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_unique_0_u32_u64_str_by_name(ctx: &ReducerContext, name: String) {
|
|
for p in ctx.db.unique_0_u32_u64_str().iter().filter(|p| p.name == name) {
|
|
black_box(p);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_no_index_u32_u64_str_by_name(ctx: &ReducerContext, name: String) {
|
|
for p in ctx.db.no_index_u32_u64_str().iter().filter(|p| p.name == name) {
|
|
black_box(p);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_btree_each_column_u32_u64_str_by_name(ctx: &ReducerContext, name: String) {
|
|
for p in ctx.db.btree_each_column_u32_u64_str().name().filter(&name) {
|
|
black_box(p);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_unique_0_u32_u64_u64_by_id(ctx: &ReducerContext, id: u32) {
|
|
if let Some(loc) = ctx.db.unique_0_u32_u64_u64().id().find(id) {
|
|
black_box(loc);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_no_index_u32_u64_u64_by_id(ctx: &ReducerContext, id: u32) {
|
|
for loc in ctx.db.no_index_u32_u64_u64().iter().filter(|p| p.id == id) {
|
|
black_box(loc);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_btree_each_column_u32_u64_u64_by_id(ctx: &ReducerContext, id: u32) {
|
|
for loc in ctx.db.btree_each_column_u32_u64_u64().id().filter(&id) {
|
|
black_box(loc);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_unique_0_u32_u64_u64_by_x(ctx: &ReducerContext, x: u64) {
|
|
for loc in ctx.db.unique_0_u32_u64_u64().iter().filter(|p| p.x == x) {
|
|
black_box(loc);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_no_index_u32_u64_u64_by_x(ctx: &ReducerContext, x: u64) {
|
|
for loc in ctx.db.no_index_u32_u64_u64().iter().filter(|p| p.x == x) {
|
|
black_box(loc);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_btree_each_column_u32_u64_u64_by_x(ctx: &ReducerContext, x: u64) {
|
|
for loc in ctx.db.btree_each_column_u32_u64_u64().x().filter(&x) {
|
|
black_box(loc);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_unique_0_u32_u64_u64_by_y(ctx: &ReducerContext, y: u64) {
|
|
for loc in ctx.db.unique_0_u32_u64_u64().iter().filter(|p| p.y == y) {
|
|
black_box(loc);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_no_index_u32_u64_u64_by_y(ctx: &ReducerContext, y: u64) {
|
|
for loc in ctx.db.no_index_u32_u64_u64().iter().filter(|p| p.y == y) {
|
|
black_box(loc);
|
|
}
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn filter_btree_each_column_u32_u64_u64_by_y(ctx: &ReducerContext, y: u64) {
|
|
for loc in ctx.db.btree_each_column_u32_u64_u64().y().filter(&y) {
|
|
black_box(loc);
|
|
}
|
|
}
|
|
|
|
// ---------- delete ----------
|
|
|
|
// FIXME: current nonunique delete interface is UNUSABLE!!!!
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn delete_unique_0_u32_u64_str_by_id(ctx: &ReducerContext, id: u32) {
|
|
ctx.db.unique_0_u32_u64_str().id().delete(id);
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn delete_unique_0_u32_u64_u64_by_id(ctx: &ReducerContext, id: u32) {
|
|
ctx.db.unique_0_u32_u64_u64().id().delete(id);
|
|
}
|
|
|
|
// ---------- clear table ----------
|
|
#[spacetimedb::reducer]
|
|
pub fn clear_table_unique_0_u32_u64_str(_ctx: &ReducerContext) {
|
|
unimplemented!("Modules currently have no interface to clear a table");
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn clear_table_no_index_u32_u64_str(_ctx: &ReducerContext) {
|
|
unimplemented!("Modules currently have no interface to clear a table");
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn clear_table_btree_each_column_u32_u64_str(_ctx: &ReducerContext) {
|
|
unimplemented!("Modules currently have no interface to clear a table");
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn clear_table_unique_0_u32_u64_u64(_ctx: &ReducerContext) {
|
|
unimplemented!("Modules currently have no interface to clear a table");
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn clear_table_no_index_u32_u64_u64(_ctx: &ReducerContext) {
|
|
unimplemented!("Modules currently have no interface to clear a table");
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn clear_table_btree_each_column_u32_u64_u64(_ctx: &ReducerContext) {
|
|
unimplemented!("Modules currently have no interface to clear a table");
|
|
}
|
|
// ---------- count ----------
|
|
|
|
// You need to inspect the module outputs to actually read the result from these.
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn count_unique_0_u32_u64_str(ctx: &ReducerContext) {
|
|
log::info!("COUNT: {}", ctx.db.unique_0_u32_u64_str().count());
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn count_no_index_u32_u64_str(ctx: &ReducerContext) {
|
|
log::info!("COUNT: {}", ctx.db.no_index_u32_u64_str().count());
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn count_btree_each_column_u32_u64_str(ctx: &ReducerContext) {
|
|
log::info!("COUNT: {}", ctx.db.btree_each_column_u32_u64_str().count());
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn count_unique_0_u32_u64_u64(ctx: &ReducerContext) {
|
|
log::info!("COUNT: {}", ctx.db.unique_0_u32_u64_u64().count());
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn count_no_index_u32_u64_u64(ctx: &ReducerContext) {
|
|
log::info!("COUNT: {}", ctx.db.no_index_u32_u64_u64().count());
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn count_btree_each_column_u32_u64_u64(ctx: &ReducerContext) {
|
|
log::info!("COUNT: {}", ctx.db.btree_each_column_u32_u64_u64().count());
|
|
}
|
|
// ---------- module-specific stuff ----------
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn fn_with_1_args(_ctx: &ReducerContext, _arg: String) {}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn fn_with_32_args(
|
|
_ctx: &ReducerContext,
|
|
_arg1: String,
|
|
_arg2: String,
|
|
_arg3: String,
|
|
_arg4: String,
|
|
_arg5: String,
|
|
_arg6: String,
|
|
_arg7: String,
|
|
_arg8: String,
|
|
_arg9: String,
|
|
_arg10: String,
|
|
_arg11: String,
|
|
_arg12: String,
|
|
_arg13: String,
|
|
_arg14: String,
|
|
_arg15: String,
|
|
_arg16: String,
|
|
_arg17: String,
|
|
_arg18: String,
|
|
_arg19: String,
|
|
_arg20: String,
|
|
_arg21: String,
|
|
_arg22: String,
|
|
_arg23: String,
|
|
_arg24: String,
|
|
_arg25: String,
|
|
_arg26: String,
|
|
_arg27: String,
|
|
_arg28: String,
|
|
_arg29: String,
|
|
_arg30: String,
|
|
_arg31: String,
|
|
_arg32: String,
|
|
) {
|
|
}
|
|
|
|
#[spacetimedb::reducer]
|
|
pub fn print_many_things(_ctx: &ReducerContext, n: u32) {
|
|
for _ in 0..n {
|
|
log::info!("hello again!");
|
|
}
|
|
}
|