Skip to content

doc: custom procedures sample #554

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

Merged
ymc9 merged 1 commit into from
Jan 9, 2026
Merged

doc: custom procedures sample #554

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,6 @@
[submodule "code-repos/zenstackhq/v3-doc-plugin"]
path = code-repos/zenstackhq/v3-doc-plugin
url = https://github.com/zenstackhq/v3-doc-plugin
[submodule "code-repos/zenstackhq/v3-doc-orm-procedure"]
path = code-repos/zenstackhq/v3-doc-orm-procedure
url = https://github.com/zenstackhq/v3-doc-orm-procedure.git
1 change: 1 addition & 0 deletions code-repos/zenstackhq/v3-doc-orm-procedure
Open in desktop
Submodule v3-doc-orm-procedure added at ef3abb
2 changes: 1 addition & 1 deletion code-repos/zenstackhq/v3-doc-plugin
Open in desktop
Submodule v3-doc-plugin updated 3 files
+81 −29 package-lock.json
+3 −3 package.json
+2 −1 zenstack/input.ts
5 changes: 5 additions & 0 deletions docs/orm/custom-proc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: ORM custom procedures

import PreviewFeature from '../_components/PreviewFeature';
import AvailableSince from '../_components/AvailableSince';
import StackBlitzGithub from '@site/src/components/StackBlitzGithub';

# Custom Procedures

Expand Down Expand Up @@ -96,3 +97,7 @@ const feeds = await db.$procs.getUserFeeds({
## Error handling

The `ZenStackClient` always throws an `ORMError` to the caller when an error occurs. To follow this protocol, custom procedure implementations should ensure other types of errors are caught and wrapped into `ORMError` and re-thrown. See [Error Handling](./errors.md) for more details.

## Samples

<StackBlitzGithub repoPath="zenstackhq/v3-doc-orm-procedure" openFile={['zenstack/schema.zmodel', 'main.ts']} startScript="dev" />
2 changes: 1 addition & 1 deletion docs/orm/polymorphism.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ The ORM query API hides all the complexity of managing polymorphic models for yo

The schema used in the sample involves a base model and three concrete models:

<StackBlitzGithub repoPath="zenstackhq/v3-doc-orm-polymorphism" codeFiles={['zenstack/schema.zmodel', 'main.ts']} startScript="generate,dev" />
<StackBlitzGithub repoPath="zenstackhq/v3-doc-orm-polymorphism" openFile={['zenstack/schema.zmodel', 'main.ts']} startScript="dev" />