EntityIdentityOptions: { identityKeys?: readonly string[] }

Options for locating named entities in JSON Schema (TBox) or instance data (ABox).

TBox (schema): a sub-schema whose properties declares one of identityKeys is a Concise Bounded Description (CBD) root — the unit that receives $meta grafts, halts graph extraction, etc.

ABox (instance): an object carrying one of identityKeys is treated as a named entity when walking documents (meta stamping, client-meta rejection, …).

Always align identityKeys with the idKey passed to extendSchemaShortcut on the same schema artifact. SPARQL backends typically use @id; Prisma uses id.

Type declaration

  • OptionalidentityKeys?: readonly string[]

    Property name(s) that identify a named entity.

    ["@id"] — JSON-LD / SPARQL default.