vlocode-project - v1.42.0
    Preparing search index...

    Interface DatapackExportDefinition

    interface DatapackExportDefinition {
        autoGeneratedMatchingKey?: boolean;
        embeddedObjects?: Record<string, DatapackExportEmbeddedObject>;
        fields?: Record<string, ExportFieldDefinition>;
        filter?: LookupFilter;
        ignoreFields?: string[];
        limit?: number;
        matchingKeyFields?: string[];
        name: string | string[];
        objectType: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoGeneratedMatchingKey?: boolean

    When true the matching key is auto-generated random number instead of a value based on the object data. autogenerated matching keys only work for none-lookup fields.

    embeddedObjects?: Record<string, DatapackExportEmbeddedObject>

    List of objects that should be embedded in this datapack. The key is the name under which embedded records are exported.

    fields?: Record<string, ExportFieldDefinition>

    Optional object with specific export settings for fields in the object.

    filter?: LookupFilter

    Where condition to filter the object data to export by. Can be a string or an object. When an object, the key is the field name and the value is the value to filter by. Accesing fields from the parent datapack using bracket syntax {} is supported:

    filter:
    AccountId: $parent.Id
    IsActive: true

    When defined as a string, the string is used as the where condition and interpolated this allows for more complex where conditions:

    filter: "AccountId = '{parent.Id}' AND IsActive = 'true'"
    
    ignoreFields?: string[]

    List of fields to exclude from the export.

    limit?: number

    Optional maximum number of records to return when querying this object.

    matchingKeyFields?: string[]

    List of fields which uniquely identify the object and are used for matching the object when importing and for generating the external lookup reference.

    name: string | string[]

    Name format of the datapack, used to create the folder name of the datapack, when a filename is not set this is also used as the file name.

    When this is a string the string is parsed as format and values between brackets are replace by field values from the object to export, i.e {Name}. When this is defined as an array each value in the array is evaluated as a field value expression and constants need to be prixed with a _:

    name:
    - Name
    - _constantValue
    # OR
    name: "{Name}_constantValue"
    objectType: string

    Type of SObject to which this filter applies