-
Notifications
You must be signed in to change notification settings - Fork 109
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Minor attribute cleanups for C# module (#1753)
- Loading branch information
Showing
7 changed files
with
141 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 6 additions & 1 deletion
7
...es/bindings-csharp/Codegen.Tests/fixtures/server/snapshots/Module#PublicTable.verified.cs
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
2 changes: 1 addition & 1 deletion
2
...csharp/Codegen.Tests/fixtures/server/snapshots/Module#Timers.SendMessageTimer.verified.cs
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,87 @@ | ||
| namespace SpacetimeDB; | ||
|
|
||
| [Flags] | ||
| public enum ColumnAttrs : byte | ||
| namespace SpacetimeDB | ||
| { | ||
| UnSet = 0b0000, | ||
| Indexed = 0b0001, | ||
| AutoInc = 0b0010, | ||
| Unique = Indexed | 0b0100, | ||
| Identity = Unique | AutoInc, | ||
| PrimaryKey = Unique | 0b1000, | ||
| PrimaryKeyAuto = PrimaryKey | AutoInc, | ||
| namespace Internal | ||
| { | ||
| [Flags] | ||
| public enum ColumnAttrs : byte | ||
| { | ||
| UnSet = 0b0000, | ||
| Indexed = 0b0001, | ||
| AutoInc = 0b0010, | ||
| Unique = Indexed | 0b0100, | ||
| Identity = Unique | AutoInc, | ||
| PrimaryKey = Unique | 0b1000, | ||
| PrimaryKeyAuto = PrimaryKey | AutoInc, | ||
| } | ||
|
|
||
| // A legacy alias, originally defined as `PrimaryKey | Identity` which is numerically same as above. | ||
| PrimaryKeyIdentity = PrimaryKeyAuto, | ||
| } | ||
| [AttributeUsage(AttributeTargets.Field)] | ||
| public abstract class ColumnAttribute : Attribute | ||
| { | ||
| public string? Table { get; init; } | ||
| internal abstract ColumnAttrs Mask { get; } | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Registers a type as the row structure of a SpacetimeDB table, enabling codegen for it. | ||
| /// | ||
| /// <para> | ||
| /// Multiple [Table] attributes per type are supported. This is useful to reuse row types. | ||
| /// Each attribute instance must have a unique name and will create a SpacetimeDB table. | ||
| /// </para> | ||
| /// </summary> | ||
| [AttributeUsage(AttributeTargets.Struct | AttributeTargets.Class, AllowMultiple = true)] | ||
| public sealed class TableAttribute : Attribute | ||
| { | ||
| /// <summary> | ||
| /// This identifier is used to name the SpacetimeDB table on the host as well as the | ||
| /// table handle structures generated to access the table from within a reducer call. | ||
| /// Registers a type as the row structure of a SpacetimeDB table, enabling codegen for it. | ||
| /// | ||
| /// <para>Defaults to the <c>nameof</c> of the target type.</para> | ||
| /// <para> | ||
| /// Multiple [Table] attributes per type are supported. This is useful to reuse row types. | ||
| /// Each attribute instance must have a unique name and will create a SpacetimeDB table. | ||
| /// </para> | ||
| /// </summary> | ||
| public string? Name { get; init; } | ||
| [AttributeUsage(AttributeTargets.Struct | AttributeTargets.Class, AllowMultiple = true)] | ||
| public sealed class TableAttribute : Attribute | ||
| { | ||
| /// <summary> | ||
| /// This identifier is used to name the SpacetimeDB table on the host as well as the | ||
| /// table handle structures generated to access the table from within a reducer call. | ||
| /// | ||
| /// <para>Defaults to the <c>nameof</c> of the target type.</para> | ||
| /// </summary> | ||
| public string? Name { get; init; } | ||
|
|
||
| /// <summary> | ||
| /// Set to <c>true</c> to make the table visible to everyone. | ||
| /// | ||
| /// <para>Defaults to the table only being visible to its owner.</para> | ||
| /// </summary> | ||
| public bool Public { get; init; } = false; | ||
| /// <summary> | ||
| /// Set to <c>true</c> to make the table visible to everyone. | ||
| /// | ||
| /// <para>Defaults to the table only being visible to its owner.</para> | ||
| /// </summary> | ||
| public bool Public { get; init; } = false; | ||
|
|
||
| public string? Scheduled { get; init; } | ||
| } | ||
| public string? Scheduled { get; init; } | ||
| } | ||
|
|
||
| [AttributeUsage(AttributeTargets.Field)] | ||
| public abstract class ColumnAttribute : Attribute | ||
| { | ||
| public string? Table { get; init; } | ||
| } | ||
|
|
||
| public sealed class AutoIncAttribute : ColumnAttribute { } | ||
| public sealed class AutoIncAttribute : Internal.ColumnAttribute | ||
| { | ||
| internal override Internal.ColumnAttrs Mask => Internal.ColumnAttrs.AutoInc; | ||
| } | ||
|
|
||
| public sealed class PrimaryKeyAttribute : ColumnAttribute { } | ||
| public sealed class PrimaryKeyAttribute : Internal.ColumnAttribute | ||
| { | ||
| internal override Internal.ColumnAttrs Mask => Internal.ColumnAttrs.PrimaryKey; | ||
| } | ||
|
|
||
| public sealed class UniqueAttribute : ColumnAttribute { } | ||
| public sealed class UniqueAttribute : Internal.ColumnAttribute | ||
| { | ||
| internal override Internal.ColumnAttrs Mask => Internal.ColumnAttrs.Unique; | ||
| } | ||
|
|
||
| public sealed class IndexedAttribute : ColumnAttribute { } | ||
| public sealed class IndexedAttribute : Internal.ColumnAttribute | ||
| { | ||
| internal override Internal.ColumnAttrs Mask => Internal.ColumnAttrs.Indexed; | ||
| } | ||
|
|
||
| public static class ReducerKind | ||
| { | ||
| public const string Init = "__init__"; | ||
| public const string Update = "__update__"; | ||
| public const string Connect = "__identity_connected__"; | ||
| public const string Disconnect = "__identity_disconnected__"; | ||
| } | ||
| public static class ReducerKind | ||
| { | ||
| public const string Init = "__init__"; | ||
| public const string Update = "__update__"; | ||
| public const string Connect = "__identity_connected__"; | ||
| public const string Disconnect = "__identity_disconnected__"; | ||
| } | ||
|
|
||
| [AttributeUsage(AttributeTargets.Method, Inherited = false)] | ||
| public sealed class ReducerAttribute(string? name = null) : Attribute | ||
| { | ||
| public string? Name => name; | ||
| [AttributeUsage(AttributeTargets.Method, Inherited = false)] | ||
| public sealed class ReducerAttribute(string? name = null) : Attribute | ||
| { | ||
| public string? Name => name; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,9 @@ | ||
| <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
| <!-- Only needed when referencing local dependencies as projects. For published packages, these are imported automatically. --> | ||
| <Import Project="../crates/bindings-csharp/Runtime/build/SpacetimeDB.Runtime.props" /> | ||
|
|
||
| <!-- Prevent test projects from being picked up by `dotnet pack`. --> | ||
| <PropertyGroup> | ||
| <IsPackable>false</IsPackable> | ||
| </PropertyGroup> | ||
| </Project> |
6ba91bbThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Criterion benchmark results
Criterion benchmark report
YOU SHOULD PROBABLY IGNORE THESE RESULTS.
Criterion is a wall time based benchmarking system that is extremely noisy when run on CI. We collect these results for longitudinal analysis, but they are not reliable for comparing individual PRs.
Go look at the callgrind report instead.
empty
insert_1
insert_bulk
iterate
find_unique
filter
serialize
stdb_module_large_arguments
stdb_module_print_bulk
remaining
6ba91bbThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Callgrind benchmark results
Callgrind Benchmark Report
These benchmarks were run using callgrind,
an instruction-level profiler. They allow comparisons between sqlite (
sqlite), SpacetimeDB running through a module (stdb_module), and the underlying SpacetimeDB data storage engine (stdb_raw). Callgrind emulates a CPU to collect the below estimates.Measurement changes larger than five percent are in bold.
In-memory benchmarks
callgrind: empty transaction
callgrind: filter
callgrind: insert bulk
callgrind: iterate
callgrind: serialize_product_value
callgrind: update bulk
On-disk benchmarks
callgrind: empty transaction
callgrind: filter
callgrind: insert bulk
callgrind: iterate
callgrind: serialize_product_value
callgrind: update bulk