* How-to: Incremental Migrations
This commit adds a how-to guide for defining "incremental migrations,"
a strategy for updating the schema of a database while maintaining compatibility
with outdated clients and without requiring a manual migration.
The code is not on GitHub yet,
as I'd like review on my choice of example before pushing the repository.
As such, the links to the code at the bottom of the new document are broken.
* Updates following review
- Internals get their own section, and move down.
- Appendix gets its own section, instead of joining "Subscriptions."
- SQL and Subscriptions move up.
* *Must* accept `ReducerContext`, not *may*
* Small fixes to Rust docs for database Identity and rename Address
* Update Rust SDK reference for various 1.0 API changes
* Fix broken links
* TOC and TODOs
* Rename `Address` to `ConnectionId` in index, fix some links
* Minor fixes I found while working through converting this to typescript
* Link to SQL ref
* Additional fixups found while rewriting TS ref
* Remove references to BitCraftMini
We no longer use this as an example.
Also, I'm pretty sure we stopped using that name ages ago.
* No UB from mixing `subscribe` and `subscribe_to_all_tables`
Co-authored-by: joshua-spacetime <josh@clockworklabs.io>
* Update TypeScript SDK reference (#181)
* Begin updating TypeScript SDK ref to match the new rust one
* Link to SQL ref from `subscribe` method
* Fill in the rest of the TypeScript SDK ref
* Fix copy-paste error: `subscribeToAllTables` should be camelCase
Co-authored-by: joshua-spacetime <josh@clockworklabs.io>
* Copy change from Rust SDK docs: no UB in `subscribeToAllTables`
Co-authored-by: joshua-spacetime <josh@clockworklabs.io>
* Fix casing of `withModuleName`
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
* Address Tyler's review
---------
Co-authored-by: joshua-spacetime <josh@clockworklabs.io>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
---------
Co-authored-by: joshua-spacetime <josh@clockworklabs.io>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
* Begin revising rust client quickstart: update the code
* Revise Rust client SDK quickstart
A whole bunch of stuff has changed since this document was last updated.
Notably, I've chosen to re-order a bunch of sections,
since the previous structure of the document doesn't make much sense
after the 0.12 API rework.
* Fix credentials import issue
There are still warnings here but it builds now
* Fix warnings after pasting all this code into a fresh project
---------
Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>
* Initial code pass on updating server to 1.0.0
* Updated to work with current 1.0.0-rc4, master branches of SpacetimeDB and the CSharpSDK
* Minor edit for clarity
* No longer optional, ReducerContext is always the first argument
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
* Improved description of OnInsert and OnDelete callbacks
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
* Fixed capitalization.
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
* Fixed capitalization.
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
* SDK language corrected and clarified.
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
* Added that the example is for the C# client and does not include server examples.
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
* Added comma for clarity
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
* Added comma for clarity
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
* Applied requested changes to improve clarity
* Revised the SDK Client Quickstart to be more-in-line with the Rust Client Quickstart flow
* Added comments to code
* Replaced <module-name> with quickstart-chat
---------
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
* Unified Rust and C# documentation for Blackhol.io
Creates a single markdown file for each page, containing both Rust and C# server implementations, using the following format:
:::rust
# A rust section
:::
:::csharp
# A csharp section
:::
The visibility of each section should then be controlled by a dropdown on the website itself, leveraging tooling not contained in this branch.
* Updated language code blocks to clarify the block refers to the server's language
Prepped the combined documents to specifically tag for the server side code such that:
:::server-rust
A rust server implementation section.
:::
:::server-csharp
A csharp server implementation section.
:::
And in a future additionally update the documentation to differentiate the client portion too, like:
:::client-unity
A Unity client implementation section.
:::
* Update part-4.md
Added additional clarification that the linked repo contained content beyond the scope of the tutorial.
* Updated subscriptions to match new API format
* Small fixes to unity tutorial index page
* Added a note about column names to the C# tutorial
* Merged a section which was now abutting another section
* Clarified where you are supposed to put C# reducers
* Small, mostly whitespace fixes
---------
Co-authored-by: Tyler Cloutier <cloutiertyler@aol.com>
* First commit to test images
* Progress on the unity tutorial
* moar docs
* Part 3 incoming
* Part 3 and almost part 4!
* Finalized part 4 and deleted unused files
* Small fixes and clarifications
* Review typos and fixes
* Fixed link validation for images
* Removed the reference to an image which is going to be moving
* Fixed the tsconfig issue (it was not actually using the tsconfig)
* Shortened titles
* Just testing something
* Undo change
* Consistent headers
* Commenting out images for now
* Missed an image
* Added a script to check the validity of docs links and a .github action
* Removed erroneous thing
* Switched the action trigger
* Added workflow to ensure that the nav.ts has been built to nav.js
* typo
* Build nav.ts
* typo thing
* Fixed script issue
* Fix
* Fixed a few links
* Added relative link resolution and fixed the broken links
* now checking fragments
* Now checking fragments properly and publishing some stats
* Forgot exit code
* Fix broken links
Well, in at least some cases, just remove broken links.
- The BSATN ref contained links to type defns, but didn't have type defns.
Replace the links with plain text.
- HTTP database links for recovery-code related routes were getting mangled
in some way I couldn't figure out, so the links weren't working
despite their targets clearly existing.
Conveniently, those routes have been removed,
so remove the links and the corresponding sections.
- The JSON doc (erroneously called "SATN") contained typos,
spelling "producttype" as "productype".
- C# SDK ref had links to a section on the `Address` type, but no such section.
Replace the links with plain text.
- Rust SDK ref had a link getting mangled in a way I couldn't figure out.
Simplify the section title so that the anchor name is predictable.
- TypeSciprt SDK ref used camelCase names in anchor links,
but we downcase all section titles to create anchor names.
Also slap a section in README.md which says how to run the checker locally.
---------
Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
Phoebe Goldman