Member Junction
    Preparing search index...

    Interface RecordData

    Represents the structure of a metadata record with optional sync tracking

    interface RecordData {
        collections?: Record<string, RecordData[]>;
        deleteRecord?: { delete: boolean; deletedAt?: string; notFound?: boolean };
        embeds?: Record<string, RecordData>;
        extension?:
            | { entity?: string; fields: Record<string, unknown> }
            | Record<string, { fields: Record<string, unknown> }>;
        fields: Record<string, any>;
        primaryKey?: Record<string, any>;
        relatedEntities?: Record<string, RecordData[]>;
        sync?: { checksum: string; lastModified: string };
    }
    Index

    Properties

    collections? deleteRecord? embeds? extension? fields primaryKey? relatedEntities? sync?

    Properties

    collections?: Record<string, RecordData[]>

    First-class collections organized by collection property name (e.g. Lines)

    deleteRecord?: { delete: boolean; deletedAt?: string; notFound?: boolean }

    Delete record directive for removing records from the database

    Type Declaration

    • delete: boolean

      Flag to indicate this record should be deleted

    • OptionaldeletedAt?: string

      ISO timestamp of when the deletion was performed

    • OptionalnotFound?: boolean

      Flag to indicate the record was not found when attempting deletion

    embeds?: Record<string, RecordData>

    First-class 1:1 peer embeds organized by FK field name (e.g. ShipToAddressID)

    extension?:
        | { entity?: string; fields: Record<string, unknown> }
        | Record<string, { fields: Record<string, unknown> }>

    First-class 1:1 IsA type extension. Shorthand form: { entity?: string; fields: Record<string, unknown> } Map form (for overlapping subtypes): { [EntityName]: { fields: Record<string, unknown> } }

    fields: Record<string, any>

    Entity field names and their values

    primaryKey?: Record<string, any>

    Primary key field(s) and their values

    relatedEntities?: Record<string, RecordData[]>

    Related entities organized by entity name

    sync?: { checksum: string; lastModified: string }

    Synchronization metadata for change tracking

    Type Declaration

    • checksum: string

      SHA256 checksum of the fields object

    • lastModified: string

      ISO timestamp of last modification

    Settings

    Member Visibility

    On This Page

    Properties