菜单
How to use @t4h.framework/orm @Entity, @Property, ORM create/findOne/find/exists, Ref, RefCollection, and ORMClaim-shaped activities. Use when defining entities or querying with ORM.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Documents @t4h.framework/amber (Amber client, Ticket operations, HTTP activities, Basic auth, runtime-claims peers). Use when implementing ticket or protocol flows—integration, creation, updates, transfers, tabulation, comments, locks—or when the user asks about ticket/protocol integration, creating tickets or protocols, or similar; also when they mention @t4h.framework/amber or Amber channel APIs.
Guides assembling T4H apps with Workflow definitions, default-export App wiring, and routing to the correct framework-* skill per @t4h.framework package. Use when scaffolding workflows, structuring main plus src/workflows, nesting startWorkflow, or choosing which package skill to read for HTTP, auth, ORM, Amber, cache, FS, SFTP, or SMTP.
How to use @t4h.framework/cache CacheClaim get/set, TTL, and Serializable values; pairing with @t4h.framework/http OAuth2. Use when implementing caches or imports from @t4h.framework/cache.
How to use @t4h.framework/core App, Workflow, Authorization, Env, Claim, History, Binary, Serializable, startWorkflow, StartWorkflowActivity, WorkflowClaim, and WorkflowRef. Use when building T4H apps, workflows, nested workflow starts, or importing from @t4h.framework/core.
How to use @t4h.framework/fs FileSystemClaim read/write and Binary. Use when handling filesystem claims or imports from @t4h.framework/fs.
How to use @t4h.framework/http HttpClient, http singleton, HttpRequestActivityInput, HttpAuth, OAuth2, HttpClientRequestClaim. Use when calling HTTP from workflows or extending OAuth2.
| name | t4h-framework-orm |
| description | How to use @t4h.framework/orm @Entity, @Property, ORM create/findOne/find/exists, Ref, RefCollection, and ORMClaim-shaped activities. Use when defining entities or querying with ORM. |
>=22.@t4h.framework/core (workspace:^).Import from @t4h.framework/orm.
ORMConfig and new ORM(config)| Field | Purpose |
|---|---|
connectionString | Passed through to persistence (your environment defines the format). |
entities | Entity class constructors to register. |
ORM extends SerializableClass: default serialization round-trips connectionString only.
| Method | Purpose |
|---|---|
create(entity, data) | One insert → Ref<T>; array → RefCollection<T>. |
findOne(entity, options) | FindOneOptions: where, optional orderBy. Ref<T> | null. |
find(entity, options?) | Adds limit, offset. RefCollection<T>. |
exists(entity, options) | Same options as findOne → boolean. |
Implementation goes through History-bound activities that use ORMClaim.
FindOneOptions<T>: where (FindWhere<T>), optional orderBy ('asc' \| 'desc' per field).FindOptions<T>: FindOneOptions + optional limit, offset.@Entity(options?): optional tableName; default from getEntityTableName (class name if unset).@Property(options?): PropertyMetadata (type, nullable, unique, default, …). See metadata exports.ORMClaimAbstract API used by the activities: find, create, getSnapshot, update, remove with types from typings/ORM.
Ref and RefCollectionHandles for rows; Ref supports snapshot/update/remove via the corresponding activities (see packages/orm/src/models).
orm.ts exports ORMCreateActivity, ORMFindActivity, ORMGetSnapshotActivity, ORMUpdateActivity, ORMRemoveActivity, and ./typings/ORM. ORMFindOneActivity is used internally by ORM.findOne but is not in the main barrel—import its module path only if needed.