Skip to main content

Interface: SystemDataModel

server.SystemDataModel

Internal type used in Convex code generation!

Convert a SchemaDefinition into a GenericDataModel.

Hierarchy

Properties

_scheduled_functions

_scheduled_functions: Object

Type declaration

NameType
document{ completedTime: undefined | number ; name: string ; args: any[] ; scheduledTime: number ; state: { kind: "pending"; } | { kind: "inProgress"; } | { kind: "success"; } | { kind: "failed"; error: string; } | { kind: "canceled"; } ; _creationTime: number ; _id: GenericId<"_scheduled_functions"> }
document.completedTimeundefined | number
document.namestring
document.argsany[]
document.scheduledTimenumber
document.state{ kind: "pending"; } | { kind: "inProgress"; } | { kind: "success"; } | { kind: "failed"; error: string; } | { kind: "canceled"; }
document._creationTimenumber
document._idGenericId<"_scheduled_functions">
fieldPaths"_id" | ExtractFieldPaths<VObject<{ completedTime: undefined | number ; name: string ; args: any[] ; scheduledTime: number ; state: { kind: "pending"; } | { kind: "inProgress"; } | { kind: "success"; } | { kind: "failed"; error: string; } | { kind: "canceled"; } }, { name: VString<string, "required"> ; args: VArray<any[], VAny<any, "required", string>, "required"> ; scheduledTime: VFloat64<number, "required"> ; completedTime: VFloat64<undefined | number, "optional"> ; state: VUnion<{ kind: "pending" } | { kind: "inProgress" } | { kind: "success" } | { kind: "failed" ; error: string } | { kind: "canceled" }, [VObject<{ kind: "pending" }, { kind: VLiteral<"pending", "required"> }, "required", "kind">, VObject<{ kind: "inProgress" }, { kind: VLiteral<"inProgress", "required"> }, "required", "kind">, VObject<{ kind: "success" }, { kind: VLiteral<"success", "required"> }, "required", "kind">, VObject<{ kind: "failed" ; error: string }, { kind: VLiteral<"failed", "required"> ; error: VString<string, "required"> }, "required", "kind" | "error">, VObject<{ kind: "canceled" }, { kind: VLiteral<"canceled", "required"> }, "required", "kind">], "required", "kind" | "error"> }, "required", "name" | "args" | "scheduledTime" | "completedTime" | "state" | "state.kind" | "state.error">>
indexes{ by_id: ["_id"] ; by_creation_time: ["_creationTime"] }
indexes.by_id["_id"]
indexes.by_creation_time["_creationTime"]
searchIndexes
vectorIndexes

Inherited from

DataModelFromSchemaDefinition._scheduled_functions


_storage

_storage: Object

Type declaration

NameType
document{ contentType: undefined | string ; sha256: string ; size: number ; _creationTime: number ; _id: GenericId<"_storage"> }
document.contentTypeundefined | string
document.sha256string
document.sizenumber
document._creationTimenumber
document._idGenericId<"_storage">
fieldPaths"_id" | ExtractFieldPaths<VObject<{ contentType: undefined | string ; sha256: string ; size: number }, { sha256: VString<string, "required"> ; size: VFloat64<number, "required"> ; contentType: VString<undefined | string, "optional"> }, "required", "sha256" | "size" | "contentType">>
indexes{ by_id: ["_id"] ; by_creation_time: ["_creationTime"] }
indexes.by_id["_id"]
indexes.by_creation_time["_creationTime"]
searchIndexes
vectorIndexes

Inherited from

DataModelFromSchemaDefinition._storage