WRDSchema | WebHare Platform SDK

Class WRDSchema<S>

Type Parameters

S extends SchemaTypeDefinition = AnySchemaTypeDefinition

Index

Constructors

constructor

new WRDSchema<S extends SchemaTypeDefinition = AnySchemaTypeDefinition>(
tag: string,
): WRDSchema<S>
Open a WRD schema by tag
Type Parameters
- S extends SchemaTypeDefinition = AnySchemaTypeDefinition
Parameters
- tag: string
Returns WRDSchema<S>
- Defined in jssdk/wrd/src/schema.ts:235

Properties

`Readonly`tag

tag: string

Methods

__ensureSchemaData

__ensureSchemaData(
__namedParameters?: { refresh?: boolean },
): Promise<SchemaData>
Parameters
- __namedParameters: { refresh?: boolean } = {}
Returns Promise<SchemaData>
- Defined in jssdk/wrd/src/schema.ts:260

__getTypeTag

__getTypeTag(type: number): Promise<null | string>
Parameters
- type: number
Returns Promise<null | string>
- Defined in jssdk/wrd/src/schema.ts:357

__listTypes

__listTypes(): Promise<
IteratorObject<{ id: number; tag: TypeRec }, undefined, unknown>,
>
Returns Promise<IteratorObject<{ id: number; tag: TypeRec }, undefined, unknown>>
- Defined in jssdk/wrd/src/schema.ts:362

__toWRDTypeId

__toWRDTypeId(tag: undefined | string): Promise<number>
Parameters
- tag: undefined | string
Returns Promise<number>
- Defined in jssdk/wrd/src/schema.ts:275

[getWRDSchemaType]

"[getWRDSchemaType]"(
type: string,
allowMissingType: true,
): Promise<null | HSVMObject>
Parameters
- type: string
- allowMissingType: true
Returns Promise<null | HSVMObject>
- Defined in jssdk/wrd/src/schema.ts:399
"[getWRDSchemaType]"(type: string, allowMissingType: false): Promise<HSVMObject>
Parameters
- type: string
- allowMissingType: false
Returns Promise<HSVMObject>
- Defined in jssdk/wrd/src/schema.ts:400

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>
- Defined in jssdk/wrd/src/schema.ts:542

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>>
- Defined in jssdk/wrd/src/schema.ts:287

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>
- Defined in jssdk/wrd/src/schema.ts:546

describeType

describeType(tagOrId: string | number): Promise<null | WRDTypeMetadata>
Describe a wrdType
Parameters
- tagOrId: string | number
  Either the string tag or the type number to describe
Returns Promise<null | WRDTypeMetadata>
- Defined in jssdk/wrd/src/schema.ts:323

enrich

enrich<
    T extends string,
    EnrichKey extends string,
    DataRow extends { [K in string]: null | number },
    Mapping extends EnrichOutputMap<S[T]>,
    RightOuterJoin extends boolean = false,
>(
    type: T,
    data: DataRow[],
    field: EnrichKey,
    mapping: Mapping,
    options?: {
        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]: null | number }
- Mapping extends EnrichOutputMap<S[T]>
- RightOuterJoin extends boolean = false
Parameters
- type: T
- data: DataRow[]
- field: EnrichKey
- mapping: Mapping
- options: {
  historyMode?: SimpleHistoryMode | HistoryModeData;
  rightOuterJoin?: RightOuterJoin;
  } = {}
Returns WRDEnrichResult<S, T, EnrichKey, DataRow, Mapping, RightOuterJoin>
- Defined in jssdk/wrd/src/schema.ts:523

exists

exists(): Promise<boolean>
Test whether this schema actually exists in the database

Returns Promise<boolean>
- Defined in jssdk/wrd/src/schema.ts:395

extendWith

extendWith<T extends SchemaTypeDefinition>(): WRDSchema<CombineSchemas<S, T>>
Type Parameters
- T extends SchemaTypeDefinition
Returns WRDSchema<CombineSchemas<S, T>>
- Defined in jssdk/wrd/src/schema.ts:550

find

find<T extends string>(
    type: T,
    query: MatchObjectQueryable<S[T]>,
    options?: { historyMode?: SimpleHistoryMode | HistoryModeData },
): Promise<null | number>
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<null | number>
- Defined in jssdk/wrd/src/schema.ts:493

getEventMasks

getEventMasks(type: keyof S & string | (keyof S & string)[]): Promise<string[]>
Parameters
- type: keyof S & string | (keyof S & string)[]
Returns Promise<string[]>
- Defined in jssdk/wrd/src/schema.ts:554

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<
    null
    | 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 & { allowMissing: true; export: true }
Returns Promise<null | MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, true>>
- Defined in jssdk/wrd/src/schema.ts:499
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<
    null
    | 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 & { allowMissing: true; export?: false }
Returns Promise<null | MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, false>>
- Defined in jssdk/wrd/src/schema.ts:500
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>>
- Defined in jssdk/wrd/src/schema.ts:502
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>>
- Defined in jssdk/wrd/src/schema.ts:503
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>>
- Defined in jssdk/wrd/src/schema.ts:504
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<
    null
    | MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, Export>,
>
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<null | MapRecordOutputMap<S[T], RecordizeOutputMap<S[T], M>, Export>>
- Defined in jssdk/wrd/src/schema.ts:505

getId

getId(opts: { allowMissing: true }): Promise<null | number>
Parameters
- opts: { allowMissing: true }
Returns Promise<null | number>
- Defined in jssdk/wrd/src/schema.ts:245
getId(opts?: { allowMissing?: boolean }): Promise<number>
Parameters
- Optionalopts: { allowMissing?: boolean }
Returns Promise<number>
- Defined in jssdk/wrd/src/schema.ts:246

getNextGuid

getNextGuid<T extends string>(type: T): string
Reserve a wrdGuid
Type Parameters
- T extends string
Parameters
- type: T
Returns string
- Defined in jssdk/wrd/src/schema.ts:438

getNextId

getNextId<T extends string>(type: T): Promise<number>
Reserve a wrdId
Type Parameters
- T extends string
Parameters
- type: T
Returns Promise<number>
- Defined in jssdk/wrd/src/schema.ts:433

getType

getType<T extends string>(type: T): WRDType<S, T>
Type Parameters
- T extends string
Parameters
- type: T
Returns WRDType<S, T>
- Defined in jssdk/wrd/src/schema.ts:353

hasType

hasType(tag: string): Promise<boolean>
Test whether a type exists in this schema
Parameters
- tag: string
Returns Promise<boolean>
- Defined in jssdk/wrd/src/schema.ts:368

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>
- Defined in jssdk/wrd/src/schema.ts:442
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>
- Defined in jssdk/wrd/src/schema.ts:443
insert<T extends string>(
    type: T,
    value: WRDInsertable<S[T]>,
    options?: { importMode?: boolean; temp?: boolean },
): Promise<number>
Type Parameters
- T extends string
Parameters
- type: T
- value: WRDInsertable<S[T]>
- Optionaloptions: { importMode?: boolean; temp?: boolean }
Returns Promise<number>
- Defined in jssdk/wrd/src/schema.ts:444

modify

modify<T extends string>(type: T): WRDModificationBuilder<S, T>
Type Parameters
- T extends string
Parameters
- type: T
Returns WRDModificationBuilder<S, T>
- Defined in jssdk/wrd/src/schema.ts:427

query

query<T extends string>(type: T): WRDSingleQueryBuilder<S, T, null>
Type Parameters
- T extends string
Parameters
- type: T
Returns WRDSingleQueryBuilder<S, T, null>
- Defined in jssdk/wrd/src/schema.ts:422

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<null | number>
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<null | number>
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");
```
- Defined in jssdk/wrd/src/schema.ts:484

selectFrom

selectFrom<T extends string>(type: T): WRDSingleQueryBuilder<S, T, null>
Type Parameters
- T extends string
Parameters
- type: T
Returns WRDSingleQueryBuilder<S, T, null>
Deprecated
use query() in WebHare 5.4.1+
- Defined in jssdk/wrd/src/schema.ts:417

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");
```
- Defined in jssdk/wrd/src/schema.ts:460

updateSchema

updateSchema(updates: SchemaUpdates): Promise<void>
Parameters
- updates: SchemaUpdates
Returns Promise<void>
- Defined in jssdk/wrd/src/schema.ts:568

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<WRDInsertable<S[T]>, 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<WRDInsertable<S[T]>, RequiredKeys<Q> | RequiredKeys<U>>,
  { historyMode?: SimpleHistoryMode | HistoryModeData },
  >
Returns Promise<[number, boolean]>
- Defined in jssdk/wrd/src/schema.ts:465

Class WRDSchema<S>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WRDSchema<S>

Properties

Readonlytag

Methods

__ensureSchemaData

Parameters

Returns Promise<SchemaData>

__getTypeTag

Parameters

Returns Promise<null | string>

__listTypes

Returns Promise<IteratorObject<{ id: number; tag: TypeRec }, undefined, unknown>>

__toWRDTypeId

Parameters

Returns Promise<number>

[getWRDSchemaType]

Parameters

Returns Promise<null | HSVMObject>

Parameters

Returns Promise<HSVMObject>

close

Type Parameters

Parameters

Returns Promise<void>

createType

Parameters

Returns Promise<WRDType<S, string>>

delete

Type Parameters

Parameters

Returns Promise<void>

describeType

Parameters

Returns Promise<null | WRDTypeMetadata>

enrich

Type Parameters

Parameters

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

exists

Returns Promise<boolean>

extendWith

Type Parameters

Returns WRDSchema<CombineSchemas<S, T>>

find

Type Parameters

Parameters

Returns Promise<null | number>

getEventMasks

Parameters

Returns Promise<string[]>

getFields

Type Parameters

Parameters

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

Type Parameters

Parameters

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

Type Parameters

Parameters

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

Type Parameters

Parameters

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

Type Parameters

Parameters

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

Type Parameters

Parameters

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

getId

`Readonly`tag