opschain entity
Included from Basic tier
Manages entities: minimal estate records — a database schema, a rack, a building — with no template and no automation. Nothing runs against an entity (no actions, changes or background tasks); it carries the basic node constructs instead: properties, settings, metadata, asset owners, maintenance windows, bookmarks, archive and the soft delete / restore lifecycle.
An entity lives in an entities/ collection under a project, an
environment, an asset or another entity —
/projects/shop/environments/prod/entities/orders_schema — and parents
entities only. Entities are part of the core platform: no entitlement and
no count limit, and they never count against the asset limit.
Entities are server estate with no local form: every verb needs a target
(--server <url>, OPSCHAIN_SERVER, or the active opschain context)
and the server's PostgreSQL store — a server on the embedded store
refuses by name.
| Subcommand | Purpose |
|---|---|
opschain docs cli/entity-list | List one parent's entities with filters and keyset pagination. |
opschain docs cli/entity-promote | Promote an entity to an asset pinned to a template version. |
opschain docs cli/entity-show | Show one entity. |
opschain docs cli/entity-create | Create one entity under a parent. |
opschain docs cli/entity-bulk-create | Create a batch of entities from a YAML or JSON file. |
opschain docs cli/entity-update | Update an entity's name, description or archive state. |
opschain docs cli/entity-delete | Soft-delete an entity and its child entities. |
Paths
Every verb takes a node path positionally. A bare
<project>/… form gets the /projects/ prefix for you, so
shop/environments/prod/entities/orders_schema and
/projects/shop/environments/prod/entities/orders_schema are the same
entity. list, create and bulk-create take the parent path
(a project, environment, asset or entity); show, update and
delete take the entity's own path. The same paths work with the shared
node verbs: opschain nodes show|create|update, opschain nodes list
(with its include-entities option),
opschain properties|settings show|edit|history and
opschain admin nodes delete|restore|destroy|export|import and
opschain vault store|store-file|global (the entity owns the secret).
Errors
- A path you may not read answers exactly like a missing one:
entity <path> not found — it does not exist, was deleted, or you may not see it(for the parent-addressed verbs,parent <path> not found …). Exit 1. - A server on the embedded store:
entities need the server's PostgreSQL store, and this server runs the embedded store: …. Exit 1. - A refused write names every field:
the server refused the request: code: Code has already been taken; …. Exit 1. - No server target:
entities need a server target — pass --server <url> or 'opschain context use <name>' …. Exit 2.
See also
opschain docs resources/entity— the entity fields and batch shapes.opschain docs resources/node— the node family and its paths.opschain docs metadata— classifying entities with metadata profiles.