Class: Schema

July 15, 2024 · View on GitHub

Class: Schema<T>

Defines a schema that determines how an Entity is mapped to Redis data structures. Construct by passing in a schema name, a SchemaDefinition, and optionally SchemaOptions:

interface Foo extends Entity {
  aString: string,
  aNumber: number,
  aBoolean: boolean,
  someText: string,
  aPoint: Point,
  aDate: Date,
  someStrings: string[],
}

const schema = new Schema<Foo>('foo', {
  aString: { type: 'string' },
  aNumber: { type: 'number' },
  aBoolean: { type: 'boolean' },
  someText: { type: 'text' },
  aPoint: { type: 'point' },
  aDate: { type: 'date' },
  someStrings: { type: 'string[]' }
}, {
  dataStructure: 'HASH'
})

A Schema is primarily used by a Repository which requires a Schema in its constructor.

Name	Type
`T`	extends `Entity` = `Record`<`string`, `any`>

Name	Type
`T`	extends `Entity` = `Record`<`string`, `any`>

Name	Type	Description
`schemaName`	`string`	The name of the schema. Prefixes the ID when creating Redis keys.
`schemaDef`	`SchemaDefinition`<`T`>	Defines all of the fields for the Schema and how they are mapped to Redis.
`options?`	`SchemaOptions`	Additional options for this Schema.

Accessors

dataStructure

• get dataStructure(): DataStructure

The configured data structure, a string with the value of either HASH or JSON, that this Schema uses to store Entities in Redis.

fields

• get fields(): Field[]

The Fields defined by this Schema.

indexHash

• get indexHash(): string

A hash for this Schema that is used to determine if the Schema has been changed when calling createIndex.

indexHashName

• get indexHashName(): string

The configured name for the RediSearch index hash for this Schema.

indexName

• get indexName(): string

The configured name for the RediSearch index for this Schema.

The name of the schema. Prefixes the ID when creating Redis keys. Combined with the results of idStrategy to generate a key. If name is foo and idStrategy returns 12345 then the generated key would be foo:12345.