Skip to main content
server.SeriesDefinition A series exposes its access policy and derived inputs. Its internal schema declaration remains the existing native table representation.

​
Type parameters

​
Hierarchy

  • Pick<SeriesTableDefinition<Fields>, "eventInput" | "rangeInput" | "pageInput" | "retention"> ↳ SeriesDefinition

​
Properties

​
[seriesDefinition]

• Readonly [seriesDefinition]: SeriesTableDefinition<Fields>

​
Methods

​
eventInput

▸ eventInput(): VObject<{ values: Expand<{ [Property in string | number | symbol]?: Exclude<Infer<Fields[Property]>, undefined> } & { [Property in string | number | symbol]: Infer<Fields[Property]> }> ; series: string ; time: bigint ; order: bigint ; event_id: string }, { series: VString<string, "required"> ; event_id: VString<string, "required"> ; time: VInt64<bigint, "required"> ; order: VInt64<bigint, "required"> ; values: VObject<Expand<{ [Property in string | number | symbol]?: Exclude<Infer<Fields[Property]>, undefined> } & { [Property in string | number | symbol]: Infer<Fields[Property]> }>, Fields, "required", { [Property in string | number | symbol]: Property | `\{Property & string}.{Fields[Property][“fieldPaths”]}` }[keyof Fields] & string> }, "required", "values" | "series" | "time" | "order" | "event_id" | `values.\{\{ [Property in string \| number \| symbol]: Property \| \`{Property & string}.${Fields[Property][“fieldPaths”]}` }[keyof Fields] & string}`> Derive one admission input from this series’ declared payload. The source belongs to the authorized endpoint; keys, receipt time and admission metadata belong to the engine.

​
Returns

VObject<{ values: Expand<{ [Property in string | number | symbol]?: Exclude<Infer<Fields[Property]>, undefined> } & { [Property in string | number | symbol]: Infer<Fields[Property]> }> ; series: string ; time: bigint ; order: bigint ; event_id: string }, { series: VString<string, "required"> ; event_id: VString<string, "required"> ; time: VInt64<bigint, "required"> ; order: VInt64<bigint, "required"> ; values: VObject<Expand<{ [Property in string | number | symbol]?: Exclude<Infer<Fields[Property]>, undefined> } & { [Property in string | number | symbol]: Infer<Fields[Property]> }>, Fields, "required", { [Property in string | number | symbol]: Property | `\{Property & string}.{Fields[Property][“fieldPaths”]}` }[keyof Fields] & string> }, "required", "values" | "series" | "time" | "order" | "event_id" | `values.\{\{ [Property in string \| number \| symbol]: Property \| \`{Property & string}.${Fields[Property][“fieldPaths”]}` }[keyof Fields] & string}`>

​
Inherited from

Pick.eventInput

​
rangeInput

▸ rangeInput(): VObject<{ from: bigint ; to: bigint ; series: string }, { series: VString<string, "required"> ; from: VInt64<bigint, "required"> ; to: VInt64<bigint, "required"> }, "required", "from" | "to" | "series"> Derive the exact half-open range of this series.

​
Returns

VObject<{ from: bigint ; to: bigint ; series: string }, { series: VString<string, "required"> ; from: VInt64<bigint, "required"> ; to: VInt64<bigint, "required"> }, "required", "from" | "to" | "series">

​
Inherited from

Pick.rangeInput

​
pageInput

▸ pageInput(): VObject<{ fields: undefined | Extract<keyof Fields, string>[] ; cursor: undefined | string ; limit: undefined | number ; direction: undefined | "asc" | "desc" ; from: bigint ; to: bigint ; series: string }, { series: VString<string, "required"> ; from: VInt64<bigint, "required"> ; to: VInt64<bigint, "required"> ; direction: VUnion<undefined | "asc" | "desc", [VLiteral<"asc", "required">, VLiteral<"desc", "required">], "optional", never> ; limit: VFloat64<undefined | number, "optional"> ; cursor: VString<undefined | string, "optional"> ; fields: VArray<undefined | Extract<keyof Fields, string>[], VUnion<Extract<keyof Fields, string>, VLiteral<Extract<keyof Fields, string>, "required">[], "required", never>, "optional"> }, "required", "fields" | "from" | "cursor" | "to" | "limit" | "series" | "direction"> Derive paging and projection inputs from this series’ payload.

​
Returns

VObject<{ fields: undefined | Extract<keyof Fields, string>[] ; cursor: undefined | string ; limit: undefined | number ; direction: undefined | "asc" | "desc" ; from: bigint ; to: bigint ; series: string }, { series: VString<string, "required"> ; from: VInt64<bigint, "required"> ; to: VInt64<bigint, "required"> ; direction: VUnion<undefined | "asc" | "desc", [VLiteral<"asc", "required">, VLiteral<"desc", "required">], "optional", never> ; limit: VFloat64<undefined | number, "optional"> ; cursor: VString<undefined | string, "optional"> ; fields: VArray<undefined | Extract<keyof Fields, string>[], VUnion<Extract<keyof Fields, string>, VLiteral<Extract<keyof Fields, string>, "required">[], "required", never>, "optional"> }, "required", "fields" | "from" | "cursor" | "to" | "limit" | "series" | "direction">

​
Inherited from

Pick.pageInput

​
retention

▸ retention(): SeriesRetention The exact retention declared for this series, independent of storage.

​
Returns

SeriesRetention

​
Inherited from

Pick.retention

​
access

▸ access(definition): SeriesDefinition<Fields>

​
Parameters

​
Returns

SeriesDefinition<Fields> ▸ access(definition): SeriesDefinition<Fields>

​
Parameters

​
Returns

SeriesDefinition<Fields> ▸ access<R, Binding>(definition, ...binding): SeriesDefinition<Fields> & AccessTableBinding<R, Binding>

​
Type parameters

​
Parameters

​
Returns

SeriesDefinition<Fields> & AccessTableBinding<R, Binding>