Member Junction
    Preparing search index...

    Type Alias ComponentQueryDataRequirement

    Describes how a component will use a specific query in MemberJunction to fetch data

    type ComponentQueryDataRequirement = {
        categoryPath: string;
        description?: string;
        entityNames: string[];
        fields: SimpleQueryFieldInfo[];
        isNew?: boolean;
        name: string;
        newQuerySQL?: string;
        parameters?: ComponentQueryParameterValue[];
    }
    Index

    Properties

    categoryPath description? entityNames fields isNew? name newQuerySQL? parameters?

    Properties

    categoryPath: string

    Full path of the category for the query. Categories can be hierarchical so a full path might be 'Membership/Users/ActiveUsers'. This helps in organizing queries and avoiding name collisions.

    description?: string

    Description of the query and how/why the component will use it

    entityNames: string[]

    A list of the entities that are part of this query. This is vital information for matching query requests against existing queries

    fields: SimpleQueryFieldInfo[]

    A list of the fields that the component will use out of the possible fields returned by the query. Uses the

    SimpleQueryFieldInfo type to describe each field, which extends SimpleEntityFieldInfo with query-specific properties like source entity tracking and summary field indicators.

    isNew?: boolean

    Indicates whether this query was newly created (true) or matched an existing query (false). Set by the Query Designer agent during query processing.

    name: string

    Query name, used along with categoryPath to identify the query

    newQuerySQL?: string

    This is only provided when requesting a NEW query be created. For existing queries, this will be undefined. This SQL can use Nunjucks syntax/templating for parameters including the custom filters defined in

    parameters?: ComponentQueryParameterValue[]

    Queries can have parameters (not all do). See

    ComponentQueryParameterValue for details.

    Settings

    Member Visibility

    On This Page

    Properties