Schema
Defined in: src/schema/schema.ts:42
A schema: the named, typed attributes an entity of one kind carries, and which of them the node indexes. Built with defineSchema.
A schema is an SDK-side convention. The node sees only attributes, each with a type and an indexed flag; the schema is what types the SDK’s writes and reads, and checks them at runtime.
A named schema also tags every entity it creates with its name, in the indexed SCHEMA_ATTRIBUTE attribute, so that a query through it sees only its own entities.
Type Parameters
Section titled “Type Parameters”The columns, keyed by attribute name.
Properties
Section titled “Properties”columns
Section titled “columns”
readonlycolumns:C
Defined in: src/schema/schema.ts:46
The columns, keyed by attribute name, in the order they were declared.
readonlyname:string|undefined
Defined in: src/schema/schema.ts:44
The name entities are tagged with, or undefined for an untagged schema.
readonlytag:StrValue|undefined
Defined in: src/schema/schema.ts:48
The tag every create writes and every query filters on, if the schema is named.