Class WRDSchema<S>

Readonlytag

__clearCache

• __clearCache(): void

  Returns void

__ensureSchemaData

• __ensureSchemaData(
      __namedParameters?: { refresh?: boolean },
  ): Promise<SchemaData>

  Parameters

  • __namedParameters: { refresh?: boolean } = {}

  Returns Promise<SchemaData>

__getTypeTag

• __getTypeTag(type: number): Promise<string | null>

  Parameters

  • type: number

  Returns Promise<string | null>

__toWRDTypeId

• __toWRDTypeId(tag: string | undefined): Promise<number>

  Parameters

  • tag: string | undefined

  Returns Promise<number>

[getWRDSchemaType]

• "[getWRDSchemaType]"(
      type: string,
      allowMissingType: true,
  ): Promise<HSVMObject | null>

  Parameters

  • type: string
  • allowMissingType: true

  Returns Promise<HSVMObject | null>

• "[getWRDSchemaType]"(type: string, allowMissingType: false): Promise<HSVMObject>

  Parameters

  • type: string
  • allowMissingType: false

  Returns Promise<HSVMObject>

close

• close<T extends string>(
      type: T,
      ids: number | number[],
      options?: EntityCloseOptions,
  ): Promise<void>

  Type Parameters

  • T extends string

  Parameters

  • type: T
  • ids: number | number[]
  • Optionaloptions: EntityCloseOptions

  Returns Promise<void>

createType

• createType(
      tag: string,
      config: Partial<WRDTypeMetadata> & Pick<WRDTypeMetadata, "metaType">,
  ): Promise<WRDType<S, string>>

  Parameters

  • tag: string
  • config: Partial<WRDTypeMetadata> & Pick<WRDTypeMetadata, "metaType">

  Returns Promise<WRDType<S, string>>

delete

• delete<T extends string>(type: T, ids: number | number[]): Promise<void>

  Type Parameters

  • T extends string

  Parameters

  • type: T
  • ids: number | number[]

  Returns Promise<void>

describeType

• describeType(tagOrId: string | number): Promise<WRDTypeMetadata | null>

  Describe a wrdType

  Parameters

  • tagOrId: string | number

    Either the string tag or the type number to describe

  Returns Promise<WRDTypeMetadata | null>

enrich

• enrich<
      T extends string,
      EnrichKey extends string,
      DataRow extends { [K in string]: number | null },
      Mapping extends EnrichOutputMap<S[T]>,
      RightOuterJoin extends boolean = false,
  >(
      type: T,
      data: DataRow[],
      field: EnrichKey,
      mapping: Mapping,
      options?: {
          allowMissing?: RightOuterJoin;
          historyMode?: SimpleHistoryMode | HistoryModeData;
          rightOuterJoin?: RightOuterJoin;
      },
  ): WRDEnrichResult<S, T, EnrichKey, DataRow, Mapping, RightOuterJoin>

  Type Parameters

  • T extends string
  • EnrichKey extends string
  • DataRow extends { [K in string]: number | null }
  • Mapping extends EnrichOutputMap<S[T]>
  • RightOuterJoin extends boolean = false

  Parameters

  • type: T
  • data: DataRow[]
  • field: EnrichKey
  • mapping: Mapping
  • options: {
        allowMissing?: RightOuterJoin;
        historyMode?: SimpleHistoryMode | HistoryModeData;
        rightOuterJoin?: RightOuterJoin;
    } = {}

    • OptionalallowMissing?: RightOuterJoin

      Keep original data records even if no match was found

    • OptionalhistoryMode?: SimpleHistoryMode | HistoryModeData

      History mode for matching enriching records

    • OptionalrightOuterJoin?: RightOuterJoin

      Deprecated

      With the modern wrd() API you should switch to allowMissing: true

  Returns WRDEnrichResult<S, T, EnrichKey, DataRow, Mapping, RightOuterJoin>

exists

• exists(): Promise<boolean>

  Test whether this schema actually exists in the database

  Returns Promise<boolean>

extendWith

• extendWith<T extends SchemaTypeDefinition>(): WRDSchema<CombineSchemas<S, T>>

  Type Parameters

  • T extends SchemaTypeDefinition

  Returns WRDSchema<CombineSchemas<S, T>>

find

• find<T extends string>(
      type: T,
      query: MatchObjectQueryable<S[T]>,
      options?: { historyMode?: SimpleHistoryMode | HistoryModeData },
  ): Promise<number | null>

  Returns the wrdId of the entity that matches the properties of the query object.

  Type Parameters

  • T extends string

  Parameters

  • type: T

    Type to search in

  • query: MatchObjectQueryable<S[T]>

    Query object (field-value pairs)

  • Optionaloptions: { historyMode?: SimpleHistoryMode | HistoryModeData }

    Options for the search

  Returns Promise<number | null>

getEventMasks

• getEventMasks(type: keyof S & string | (keyof S & string)[]): Promise<string[]>

  Parameters

  • type: keyof S & string | (keyof S & string)[]

  Returns Promise<string[]>

getFields

• getFields<
      M extends
          string
          | { [K: string]: OutputMap<S[T]> }
          | readonly AttrRef<S[T]>[],
      T extends string,
  >(
      type: T,
      id: number,
      mapping: M,
      options: GetFieldsOptions & { allowMissing: true; export: true },
  ): Promise<
      MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, true>
      | null,
  >

  Type Parameters

  • M extends string | { [K: string]: OutputMap<S[T]> } | readonly AttrRef<S[T]>[]
  • T extends string

  Parameters

  • type: T
  • id: number
  • mapping: M
  • options: GetFieldsOptions & { allowMissing: true; export: true }

  Returns Promise<MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, true> | null>

• getFields<
      M extends
          string
          | { [K: string]: OutputMap<S[T]> }
          | readonly AttrRef<S[T]>[],
      T extends string,
  >(
      type: T,
      id: number,
      mapping: M,
      options: GetFieldsOptions & { allowMissing: true; export?: false },
  ): Promise<
      MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, false>
      | null,
  >

  Type Parameters

  • M extends string | { [K: string]: OutputMap<S[T]> } | readonly AttrRef<S[T]>[]
  • T extends string

  Parameters

  • type: T
  • id: number
  • mapping: M
  • options: GetFieldsOptions & { allowMissing: true; export?: false }

  Returns Promise<MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, false> | null>

• getFields<
      M extends
          string
          | { [K: string]: OutputMap<S[T]> }
          | readonly AttrRef<S[T]>[],
      T extends string,
  >(
      type: T,
      id: number,
      mapping: M,
      options: GetFieldsOptions & { export: true },
  ): Promise<MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, true>>

  Type Parameters

  • M extends string | { [K: string]: OutputMap<S[T]> } | readonly AttrRef<S[T]>[]
  • T extends string

  Parameters

  • type: T
  • id: number
  • mapping: M
  • options: GetFieldsOptions & { export: true }

  Returns Promise<MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, true>>

• getFields<
      M extends
          string
          | { [K: string]: OutputMap<S[T]> }
          | readonly AttrRef<S[T]>[],
      T extends string,
  >(
      type: T,
      id: number,
      mapping: M,
      options: GetFieldsOptions & { export?: false },
  ): Promise<MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, false>>

  Type Parameters

  • M extends string | { [K: string]: OutputMap<S[T]> } | readonly AttrRef<S[T]>[]
  • T extends string

  Parameters

  • type: T
  • id: number
  • mapping: M
  • options: GetFieldsOptions & { export?: false }

  Returns Promise<MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, false>>

• getFields<
      M extends
          string
          | { [K: string]: OutputMap<S[T]> }
          | readonly AttrRef<S[T]>[],
      T extends string,
  >(
      type: T,
      id: number,
      mapping: M,
  ): Promise<MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, false>>

  Type Parameters

  • M extends string | { [K: string]: OutputMap<S[T]> } | readonly AttrRef<S[T]>[]
  • T extends string

  Parameters

  • type: T
  • id: number
  • mapping: M

  Returns Promise<MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, false>>

• getFields<
      M extends
          string
          | { [K: string]: OutputMap<S[T]> }
          | readonly AttrRef<S[T]>[],
      T extends string,
      Export extends boolean,
  >(
      type: T,
      id: number,
      mapping: M,
      options?: GetFieldsOptions,
  ): Promise<
      MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, Export>
      | null,
  >

  Type Parameters

  • M extends string | { [K: string]: OutputMap<S[T]> } | readonly AttrRef<S[T]>[]
  • T extends string
  • Export extends boolean

  Parameters

  • type: T
  • id: number
  • mapping: M
  • Optionaloptions: GetFieldsOptions

  Returns Promise<MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, Export> | null>

getId

• getId(opts: { allowMissing: true }): Promise<number | null>

  Parameters

  • opts: { allowMissing: true }

  Returns Promise<number | null>

• getId(opts?: { allowMissing?: boolean }): Promise<number>

  Parameters

  • Optionalopts: { allowMissing?: boolean }

  Returns Promise<number>

getNextGuid

• getNextGuid<T extends string>(type: T): string

  Reserve a wrdGuid

  Type Parameters

  • T extends string

  Parameters

  • type: T

  Returns string

getNextId

• getNextId<T extends string>(type: T): Promise<number>

  Reserve a wrdId

  Type Parameters

  • T extends string

  Parameters

  • type: T

  Returns Promise<number>

hasType

• hasType(tag: string): Promise<boolean>

  Test whether a type exists in this schema

  Parameters

  • tag: string

  Returns Promise<boolean>

insert

• insert<T extends string>(
      type: T,
      value: Partial<WRDInsertable<S[T]>>,
      options: { importMode?: boolean; temp: true },
  ): Promise<number>

  Type Parameters

  • T extends string

  Parameters

  • type: T
  • value: Partial<WRDInsertable<S[T]>>
  • options: { importMode?: boolean; temp: true }

  Returns Promise<number>

• insert<T extends string>(
      type: T,
      value: Partial<WRDInsertable<S[T]>>,
      options: { importMode: true; temp?: boolean },
  ): Promise<number>

  Type Parameters

  • T extends string

  Parameters

  • type: T
  • value: Partial<WRDInsertable<S[T]>>
  • options: { importMode: true; temp?: boolean }

  Returns Promise<number>

• insert<T extends string>(
      type: T,
      value: Simplify<
          {
              [K in string
              | number
              | symbol as ToWRDAttr<S[T][K]>["__insertable"] extends true
                  ? false extends ToWRDAttr<S[T][K]>["__required"] ? K : never
                  : never]?: GetInputType<S[T][K]>
          } & {
              [K in string
              | number
              | symbol as InsertableAndRequired<ToWRDAttr<S[T][K]>> extends true
                  ? K
                  : never]: GetInputType<S[T][K]>
          },
      >,
      options?: { importMode?: boolean; temp?: boolean },
  ): Promise<number>

  Type Parameters

  • T extends string

  Parameters

  • type: T
  • value: Simplify<
        {
            [K in string
            | number
            | symbol as ToWRDAttr<S[T][K]>["__insertable"] extends true
                ? false extends ToWRDAttr<S[T][K]>["__required"] ? K : never
                : never]?: GetInputType<S[T][K]>
        } & {
            [K in string
            | number
            | symbol as InsertableAndRequired<ToWRDAttr<S[T][K]>> extends true
                ? K
                : never]: GetInputType<S[T][K]>
        },
    >
  • Optionaloptions: { importMode?: boolean; temp?: boolean }

  Returns Promise<number>

listTypes

• listTypes(): Promise<
      IteratorObject<
          {
              id: number;
              metaType: "object"
              | "link"
              | "domain"
              | "attachment";
              tag: string;
          },
          undefined,
          unknown,
      >,
  >

  Returns Promise<
      IteratorObject<
          {
              id: number;
              metaType: "object"
              | "link"
              | "domain"
              | "attachment";
              tag: string;
          },
          undefined,
          unknown,
      >,
  >

modify

• modify<T extends string>(type: T): WRDModificationBuilder<S, T>

  Type Parameters

  • T extends string

  Parameters

  • type: T

  Returns WRDModificationBuilder<S, T>

query

• query<T extends string>(type: T): WRDSingleQueryBuilder<S, T, null>

  Type Parameters

  • T extends string

  Parameters

  • type: T

  Returns WRDSingleQueryBuilder<S, T, null>

search

• search<T extends string, F extends string>(
      type: T,
      field: F,
      value: WhereValueOptions<S[T], F, WhereConditions<S[T], F> & "=">["value"],
      options?: GetOptionsIfExists<
          WhereValueOptions<S[T], F, WhereConditions<S[T], F> & "=">,
          object,
      > & { historyMode?: SimpleHistoryMode | HistoryModeData },
  ): Promise<number | null>

  Returns the wrdId of an entity that has a field with a specific value, or null if not found.

  Type Parameters

  • T extends string
  • F extends string

  Parameters

  • type: T
  • field: F

    Field to filter on

  • value: WhereValueOptions<S[T], F, WhereConditions<S[T], F> & "=">["value"]

    Value to match (using condition "=")

  • Optionaloptions: GetOptionsIfExists<
        WhereValueOptions<S[T], F, WhereConditions<S[T], F> & "=">,
        object,
    > & { historyMode?: SimpleHistoryMode | HistoryModeData }

    Additional options for the filter

  Returns Promise<number | null>

  Example

  /// Returns the wrdId of an entity with the first name "John" (or null if no such entity exists)
  const result = await schema.search("wrdPerson", "wrdFirstName", "John");
  Copy

update

• update<T extends string>(
      type: T,
      entity: number | MatchObjectQueryable<S[T]>,
      value: WRDUpdatable<S[T]>,
      options?: { importMode?: boolean },
  ): Promise<void>

  Updates fields of a specific entity

  Type Parameters

  • T extends string

  Parameters

  • type: T
  • entity: number | MatchObjectQueryable<S[T]>

    wrdId of the entity to update, or a query object to find the entity (throws if none or multiple entities match the query)

  • value: WRDUpdatable<S[T]>

    Value to match (using condition "=")

  • Optionaloptions: { importMode?: boolean }

    Additional options for the filter

  Returns Promise<void>

  Example

  /// Returns the wrdId of an entity with the first name "John" (or null if no such entity exists)
  const result = await schema.search("wrdPerson", "wrdFirstName", "John");
  Copy

updateSchema

• updateSchema(updates: SchemaUpdates): Promise<void>

  Parameters

  • updates: SchemaUpdates

  Returns Promise<void>

upsert

• upsert<T extends string, Q extends object, U extends object>(
      type: T,
      query: Q & Pick<WRDUpdatable<S[T]>, keyof S[T] & keyof WRDUpdatable<S[T]>> & MatchObjectQueryable<
          S[T],
      > & Record<
          Exclude<keyof Q, keyof S[T] | keyof S[T] & keyof WRDUpdatable<S[T]>>,
          never,
      >,
      value: U & WRDUpdatable<S[T]> & Record<
          Exclude<keyof U, keyof WRDUpdatable<S[T]>>,
          never,
      >,
      ...options: UpsertOptions<
          Omit<
              Simplify<
                  {
                      [K in string
                      | number
                      | symbol as ToWRDAttr<S[T][K]>["__insertable"] extends true
                          ? false extends ToWRDAttr<(...)[(...)][K]>["__required"]
                              ? K
                              : never
                          : never]?: GetInputType<S[T][K]>
                  } & {
                      [K in string
                      | number
                      | symbol as InsertableAndRequired<ToWRDAttr<S[T][K]>> extends true
                          ? K
                          : never]: GetInputType<S[T][K]>
                  },
              >,
              RequiredKeys<Q>
              | RequiredKeys<U>,
          >,
          { historyMode?: SimpleHistoryMode | HistoryModeData },
      >,
  ): Promise<[number, boolean]>

  Insert an entity, or update if it exists

  Type Parameters

  • T extends string
  • Q extends object
  • U extends object

  Parameters

  • type: T
  • query: Q & Pick<WRDUpdatable<S[T]>, keyof S[T] & keyof WRDUpdatable<S[T]>> & MatchObjectQueryable<
        S[T],
    > & Record<
        Exclude<keyof Q, keyof S[T] | keyof S[T] & keyof WRDUpdatable<S[T]>>,
        never,
    >
  • value: U & WRDUpdatable<S[T]> & Record<
        Exclude<keyof U, keyof WRDUpdatable<S[T]>>,
        never,
    >
  • ...options: UpsertOptions<
        Omit<
            Simplify<
                {
                    [K in string
                    | number
                    | symbol as ToWRDAttr<S[T][K]>["__insertable"] extends true
                        ? false extends ToWRDAttr<(...)[(...)][K]>["__required"] ? K : never
                        : never]?: GetInputType<S[T][K]>
                } & {
                    [K in string
                    | number
                    | symbol as InsertableAndRequired<ToWRDAttr<S[T][K]>> extends true
                        ? K
                        : never]: GetInputType<S[T][K]>
                },
            >,
            RequiredKeys<Q>
            | RequiredKeys<U>,
        >,
        { historyMode?: SimpleHistoryMode | HistoryModeData },
    >

  Returns Promise<[number, boolean]>