Merge branch 'master' into phoebe/csharp-ref-fix-rust-code

Author: gefjon

docs/deploying/maincloud.md

@@ -23,7 +23,7 @@ spacetime login
 ```
 
 1. Open the SpacetimeDB website and log in using your GitHub login.
-1. You should now be able to see your published modules [by navigating to your profile on the website](/profile).
+1. You should now be able to see your published modules https://spacetimedb.com/profile, or you can navigate to your database directly at https://spacetimedb.com/my-cool-module.
 
 ---
 

docs/deploying/spacetimedb-standalone.md

@@ -82,29 +82,69 @@ server {
     listen 80;
     server_name example.com;
 
-    location / {
+    #########################################
+    # By default SpacetimeDB is completely open so that anyone can publish to it. If you want to block
+    # users from creating new databases you should keep this section commented out. Otherwise, if you
+    # want to open it up (probably for dev environments) then you can uncomment this section and then
+    # also comment out the location / section below.
+    #########################################
+    # location / {
+    #     proxy_pass http://localhost:3000;
+    #     proxy_http_version 1.1;
+    #     proxy_set_header Upgrade $http_upgrade;
+    #     proxy_set_header Connection "Upgrade";
+    #     proxy_set_header Host $host;
+    # }
+
+    # Anyone can subscribe to any database.
+    # Note: This is the only section *required* for the websocket to function properly. Clients will
+    # be able to create identities, call reducers, and subscribe to tables through this websocket.
+    location ~ ^/v1/database/[^/]+/subscribe$ {
         proxy_pass http://localhost:3000;
         proxy_http_version 1.1;
         proxy_set_header Upgrade $http_upgrade;
         proxy_set_header Connection "Upgrade";
         proxy_set_header Host $host;
     }
 
-    # This restricts who can publish new databases to your SpacetimeDB instance. We recommend
-    # restricting this ability to local connections. 
-    location /v1/publish {
-        allow 127.0.0.1;
-        deny all;
+    # Uncomment this section to allow all HTTP reducer calls
+    # location ~ ^/v1/[^/]+/call/[^/]+$ {
+    #     proxy_pass http://localhost:3000;
+    #     proxy_http_version 1.1;
+    #     proxy_set_header Upgrade $http_upgrade;
+    #     proxy_set_header Connection "Upgrade";
+    #     proxy_set_header Host $host;
+    # }
+
+    # Uncomment this section to allow all HTTP sql requests
+    # location ~ ^/v1/[^/]+/sql$ {
+    #     proxy_pass http://localhost:3000;
+    #     proxy_http_version 1.1;
+    #     proxy_set_header Upgrade $http_upgrade;
+    #     proxy_set_header Connection "Upgrade";
+    #     proxy_set_header Host $host;
+    # }
+
+    # NOTE: This is required for the typescript sdk to function, it is optional
+    # for the rust and the C# SDKs.
+    location /v1/identity {
         proxy_pass http://localhost:3000;
         proxy_http_version 1.1;
         proxy_set_header Upgrade $http_upgrade;
         proxy_set_header Connection "Upgrade";
         proxy_set_header Host $host;
     }
+
+    # Block all other routes explicitly. Only localhost can use these routes. If you want to open your
+    # server up so that anyone can publish to it you should comment this section out.
+    location / {
+        allow 127.0.0.1;
+        deny all;
+    }
 }
 ```
 
-This configuration contains a restriction to the `/v1/publish` route. This restriction makes it so that you can only publish to the database if you're publishing from a local connection on the host. 
+This configuration by default blocks all connections other than `/v1/identity` and `/v1/database/<database-name>/subscribe` which only allows the most basic functionality. This will prevent all remote users from publishing to your SpacetimeDB instance.
 
 Enable the configuration:
 

docs/index.md

@@ -188,6 +188,9 @@ pub fn world(ctx: &spacetimedb::ReducerContext) -> Result<(), String> {
    clear_all_tables(ctx);
 }
 ```
+While SpacetimeDB doesn't support nested transactions,
+a reducer can [schedule another reducer](https://docs.rs/spacetimedb/latest/spacetimedb/attr.reducer.html#scheduled-reducers) to run at an interval,
+or at a specific time.
 :::
 :::server-csharp
 ```csharp
@@ -207,19 +210,12 @@ public static void World(ReducerContext ctx)
    // ...
 }
 ```
-:::
-
-:::server-rust
-While SpacetimeDB doesn't support nested transactions,
-a reducer can [schedule another reducer](https://docs.rs/spacetimedb/latest/spacetimedb/attr.reducer.html#scheduled-reducers) to run at an interval,
-or at a specific time.
-:::
-:::server-csharp
 While SpacetimeDB doesn't support nested transactions,
 a reducer can [schedule another reducer](/docs/modules/c-sharp#scheduled-reducers) to run at an interval,
 or at a specific time.
 :::
 
+
 ### Client
 A **client** is an application that connects to a [database](#database). A client logs in using an [identity](#identity) and receives an [connection id](#connectionid) to identify the connection. After that, it can call [reducers](#reducer) and query public [tables](#table).
 

docs/modules/c-sharp/index.md

@@ -88,6 +88,8 @@ This creates a `dotnet` project in `my-project-directory` with the following `St
 </Project>
 ```
 
+> NOTE: It is important to not change the `StdbModule.csproj` name because SpacetimeDB assumes that this will be the name of the file.
+
 This is a standard `csproj`, with the exception of the line `<RuntimeIdentifier>wasi-wasm</RuntimeIdentifier>`.
 This line is important: it allows the project to be compiled to a WebAssembly module. 
 
@@ -223,9 +225,9 @@ However:
 
 # Tables
 
-Tables are declared using the [`[SpacetimeDB.Table]` attribute](#table-attribute).
+Tables are declared using the `[SpacetimeDB.Table]` attribute.
 
-This macro is applied to a C# `partial class` or `partial struct` with named fields. (The `partial` modifier is required to allow code generation to add methods.) All of the fields of the table must be marked with [`[SpacetimeDB.Type]`](#type-attribute).
+This macro is applied to a C# `partial class` or `partial struct` with named fields. (The `partial` modifier is required to allow code generation to add methods.) All of the fields of the table must be marked with [`[SpacetimeDB.Type]`]( #attribute-spacetimedbtype).
 
 The resulting type is used to store rows of the table. It's a normal class (or struct). Row values are not special -- operations on row types do not, by themselves, modify the table. Instead, a [`ReducerContext`](#class-reducercontext) is needed to get a handle to the table.
 

docs/modules/c-sharp/quickstart.md

@@ -311,6 +311,6 @@ spacetime sql quickstart-chat "SELECT * FROM message"
 
 You've just set up your first database in SpacetimeDB! You can find the full code for this client [in the C# server module example](https://github.com/clockworklabs/com.clockworklabs.spacetimedbsdk/tree/master/examples~/quickstart-chat/server).
 
-The next step would be to create a client that interacts with this module. You can use any of SpacetimDB's supported client languages to do this. Take a look at the quick start guide for your client language of choice: [Rust](/docs/sdks/rust/quickstart), [C#](/docs/sdks/c-sharp/quickstart), or [TypeScript](/docs/sdks/typescript/quickstart).
+The next step would be to create a client that interacts with this module. You can use any of SpacetimeDB's supported client languages to do this. Take a look at the quick start guide for your client language of choice: [Rust](/docs/sdks/rust/quickstart), [C#](/docs/sdks/c-sharp/quickstart), or [TypeScript](/docs/sdks/typescript/quickstart).
 
 If you are planning to use SpacetimeDB with the Unity game engine, you can skip right to the [Unity Comprehensive Tutorial](/docs/unity/part-1).

docs/modules/rust/quickstart.md

@@ -224,11 +224,15 @@ pub fn identity_disconnected(ctx: &ReducerContext) {
 }
 ```
 
+## Start the Server
+
+If you haven't already started the SpacetimeDB server, run the `spacetime start` command in a _separate_ terminal and leave it running while you continue following along.
+
 ## Publish the module
 
 And that's all of our module code! We'll run `spacetime publish` to compile our module and publish it on SpacetimeDB. `spacetime publish` takes an optional name which will map to the database's unique `Identity`. Clients can connect either by name or by `Identity`, but names are much more user-friendly. If you'd like, come up with a unique name that contains only URL-safe characters (letters, numbers, hyphens and underscores), and fill it in where we've written `quickstart-chat`.
 
-From the `quickstart-chat` directory, run:
+From the `quickstart-chat` directory, run in another tab:
 
 ```bash
 spacetime publish --project-path server quickstart-chat
@@ -239,7 +243,7 @@ spacetime publish --project-path server quickstart-chat
 You can use the CLI (command line interface) to run reducers. The arguments to the reducer are passed in JSON format.
 
 ```bash
-spacetime call quickstart-chat send_message 'Hello, World!'
+spacetime call quickstart-chat send_message "Hello, World!"
 ```
 
 Once we've called our `send_message` reducer, we can check to make sure it ran by running the `logs` command.

docs/nav.js

@@ -39,6 +39,7 @@ const nav = {
         page('SQL Reference', 'sql', 'sql/index.md'),
         section('Subscriptions'),
         page('Subscription Reference', 'subscriptions', 'subscriptions/index.md'),
+        page('Subscription Semantics', 'subscriptions/semantics', 'subscriptions/semantics.md'),
         section('Row Level Security'),
         page('Row Level Security', 'rls', 'rls/index.md'),
         section('How To'),

docs/rls/index.md

@@ -33,7 +33,7 @@ use spacetimedb::{client_visibility_filter, Filter};
 /// A client can only see their account
 #[client_visibility_filter]
 const ACCOUNT_FILTER: Filter = Filter::Sql(
-    "SELECT * FROM account WHERE identity = :sender"
+    "SELECT * FROM account WHERE account.identity = :sender"
 );
 ```
 :::
@@ -52,7 +52,7 @@ public partial class Module
     /// </summary>
     [SpacetimeDB.ClientVisibilityFilter]
     public static readonly Filter ACCOUNT_FILTER = new Filter.Sql(
-        "SELECT * FROM account WHERE identity = :sender"
+        "SELECT * FROM account WHERE account.identity = :sender"
     );
 }
 ```
@@ -90,7 +90,7 @@ use spacetimedb::{client_visibility_filter, Filter};
 /// A client can only see their account
 #[client_visibility_filter]
 const ACCOUNT_FILTER: Filter = Filter::Sql(
-    "SELECT * FROM account WHERE identity = :sender"
+    "SELECT * FROM account WHERE account.identity = :sender"
 );
 
 /// An admin can see all accounts
@@ -113,7 +113,7 @@ public partial class Module
     /// </summary>
     [SpacetimeDB.ClientVisibilityFilter]
     public static readonly Filter ACCOUNT_FILTER = new Filter.Sql(
-        "SELECT * FROM account WHERE identity = :sender"
+        "SELECT * FROM account WHERE account.identity = :sender"
     );
 
     /// <summary>
@@ -141,7 +141,7 @@ use spacetimedb::{client_visibility_filter, Filter};
 /// A client can only see their account
 #[client_visibility_filter]
 const ACCOUNT_FILTER: Filter = Filter::Sql(
-    "SELECT * FROM account WHERE identity = :sender"
+    "SELECT * FROM account WHERE account.identity = :sender"
 );
 
 /// An admin can see all accounts
@@ -170,7 +170,7 @@ public partial class Module
     /// </summary>
     [SpacetimeDB.ClientVisibilityFilter]
     public static readonly Filter ACCOUNT_FILTER = new Filter.Sql(
-        "SELECT * FROM account WHERE identity = :sender"
+        "SELECT * FROM account WHERE account.identity = :sender"
     );
 
     /// <summary>

docs/sdks/c-sharp/index.md

@@ -23,7 +23,7 @@ The SpacetimeDB client for C# contains all the tools you need to build native cl
 If you would like to create a console application using .NET, you can create a new project using `dotnet new console` and add the SpacetimeDB SDK to your dependencies:
 
 ```bash
-dotnet add package spacetimedbsdk
+dotnet add package SpacetimeDB.ClientSDK
 ```
 
 (See also the [CSharp Quickstart](/docs/modules/c-sharp/quickstart) for an in-depth example of such a console application.)

docs/sdks/c-sharp/quickstart.md

@@ -22,7 +22,7 @@ Open the project in your IDE of choice.
 
 ## Add the NuGet package for the C# SpacetimeDB SDK
 
-Add the `SpacetimeDB.ClientSDK` [NuGet package](https://www.nuget.org/packages/spacetimedbsdk) using Visual Studio or Rider _NuGet Package Manager_ or via the .NET CLI:
+Add the `SpacetimeDB.ClientSDK` [NuGet package](https://www.nuget.org/packages/SpacetimeDB.ClientSDK/) using Visual Studio or Rider _NuGet Package Manager_ or via the .NET CLI:
 
 ```bash
 dotnet add package SpacetimeDB.ClientSDK
@@ -141,15 +141,15 @@ To `Program.cs`, add:
 const string HOST = "http://localhost:3000";
 
 /// The database name we chose when we published our module.
-const string DBNAME = "quickstart-chat";
+const string DB_NAME = "quickstart-chat";
 
 /// Load credentials from a file and connect to the database.
 DbConnection ConnectToDB()
 {
     DbConnection? conn = null;
     conn = DbConnection.Builder()
         .WithUri(HOST)
-        .WithModuleName(DBNAME)
+        .WithModuleName(DB_NAME)
         .WithToken(AuthToken.Token)
         .OnConnect(OnConnected)
         .OnConnectError(OnConnectError)