docs: add Convex migration guide#5536
Open
clockwork-labs-bot wants to merge 1 commit into
Open
Conversation
| | Project | Project plus module source tree | A SpacetimeDB project contains module code, generated bindings, and client code. | | ||
| | Deployment | Database | A published SpacetimeDB module creates or updates a database on Maincloud or a self-hosted host. | | ||
| | Backend | Database plus module | Your module contains tables and callable functions that run inside the database. | | ||
| | `convex/` directory | Module source directory | TypeScript templates usually put module code in `spacetimedb/src/index.ts`. Rust, C#, and C++ use their normal project layouts. | |
Contributor
There was a problem hiding this comment.
I think we can just say spacetimedb directory.
| | `convex/` directory | Module source directory | TypeScript templates usually put module code in `spacetimedb/src/index.ts`. Rust, C#, and C++ use their normal project layouts. | | ||
| | `schema.ts` | Table definitions in module code | SpacetimeDB schema is declared in the module language using [tables](/docs/tables). | | ||
| | `defineSchema` | `schema(...)` or language-specific module schema | In TypeScript, pass tables to `schema({ tableName })`. | | ||
| | `defineTable` | Table | Tables store rows and define columns, constraints, indexes, visibility, and optional scheduling. | |
Contributor
There was a problem hiding this comment.
Should this be the table() function?
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of Changes
Adds a new migration guide for teams moving applications from Convex to SpacetimeDB.
The guide includes:
API and ABI breaking changes
None. Documentation-only change.
Expected complexity level and risk
Testing
pnpm buildindocs/.