Readonly defaultA record of default attributes for the entity, keyed by entity field names.
Readonly defaultA record of default attributes for the table, keyed by table field aliases.
Readonly delimiterA delimiter used in the table's composite keys.
Readonly nameThe name of the table.
Metadata for the table's partition key attribute.
Represents the keys that should be excluded from schema validation. These keys are reserved by dyna-record and should be managed internally.
While dyna-record employs type guards to prevent the setting of these keys, this ensures additional runtime validation.
The reserved keys include:
Metadata for the table's sort key attribute.
Adds the partition key attribute to Table metadata storage
Adds the sort key attribute to Table metadata storage
Private buildCreates default attribute metadata. Use tableDefaultFields unless consuming table decorator specifies overrides
Generated using TypeDoc
Represents the metadata for a table within the ORM framework, encapsulating information such as table name, key attributes, and default field mappings. This class is fundamental for defining how entities are mapped to their underlying database tables, providing a schema-like structure that includes both key configuration and default attribute handling.
The metadata includes the partition and sort key attributes of the table, which are essential for database operations. It also provides a mechanism to include default attributes and their mappings, supporting common fields like
id,type,createdAt, andupdatedAt, along with their serialization strategies, particularly for date fields.Param: options
Configuration options for the table metadata.