Interface SkipEntityInfo

Info about a single entity including fields and relationships

interface SkipEntityInfo {
    baseView: string;
    description?: string;
    fields: SkipEntityFieldInfo[];
    id: string;
    name: string;
    relatedEntities: SkipEntityRelationshipInfo[];
    rows?: unknown[];
    rowsPacked?: "None" | "Sample" | "All";
    rowsSampleMethod?: "random" | "top n" | "bottom n";
    schemaName: string;
}

Properties

baseView description? fields id name relatedEntities rows? rowsPacked? rowsSampleMethod? schemaName

Properties

baseView

baseView: string

Optional description

description?: string

fields

fields: SkipEntityFieldInfo[]

id

id: string

name

name: string

relatedEntities

relatedEntities: SkipEntityRelationshipInfo[]

Optional rows

rows?: unknown[]

Optional, the metadata can include an array of rows that can be used to provide context to Skip for the data that is being passed in.

Optional rowsPacked

rowsPacked?: "None" | "Sample" | "All"

If rows packed is set to anything other than none, the data is provided in the rows property.

Optional rowsSampleMethod

rowsSampleMethod?: "random" | "top n" | "bottom n"

If rowsPacked === 'Sample', this additional property is used to indicate the method used to sample the rows

schemaName

schemaName: string

Settings

Member Visibility

Theme

On This Page

baseViewdescriptionfieldsidnamerelatedEntitiesrowsrowsPackedrowsSampleMethodschemaName