Skip to content

docs: Document table models in shared packages #746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
marcelomendoncasoares wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: Document table models in shared packages #746

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions docs/06-concepts/03-data-and-the-database/01-models/05-shared-packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,21 @@ final profile = UserProfile(
);
```

### Table models

A shared model can declare a `table`, as long as it also sets [`database: all`](../database/tables#choosing-where-a-table-lives). A shared package is used from both the server and the client, so its tables have to be declared for both.

```yaml
class: SharedRecord
table: shared_record
database: all
fields:
name: String
```

### Extending shared models

You can define a base model in a shared package and extend it on the server to add database persistence. Shared packages cannot define table models, but the server can extend a shared model and add a `table` property.
You can also define a base model in a shared package and extend it on the server, which keeps the table definition out of the shared package.

**In the shared package** (`lib/src/shared/vehicle.spy.yaml`):

Expand Down Expand Up @@ -170,10 +182,10 @@ Shared models support most Serverpod model features, with these exceptions:

| Restriction | Reason |
| ----------- | ------ |
| No `table` property | Shared packages are not tied to a database. Use a server model that extends the shared model to add persistence. |
| A `table` requires `database: all` | The package is used on both sides, so its tables cannot be limited to the server or the client. |
| No `serverOnly` on the class | Models must be usable on both server and client. |
| No `scope: serverOnly` on fields | All fields must be serializable for the client. |

If you need tables or server-only fields, define them in a server model that extends the shared model.
If you need server-only fields, define them in a server model that extends the shared model.

The shared package can also contain custom serializable classes. Register them in the server's `generator.yaml` under `extraClasses` if they need to be used in protocol serialization. See [Custom serializable classes](../../server-fundamentals/configuration#custom-serializable-classes) for details.
Loading