Skip to main content

SchemaGeneratorOptions

  • Namespace: PPDS.Migration.Schema
  • Assembly: PPDS.Migration
  • Kind: Class

Summary

Options for schema generation.

Members

Methods

ShouldIncludeAttribute

bool ShouldIncludeAttribute(string attributeName, bool isPrimaryKey)

Determines if an attribute should be included based on the filtering options.

  • Param attributeName: The attribute logical name.

  • Param isPrimaryKey: Whether this attribute is the primary key.

  • Returns: True if the attribute should be included.

Properties

CustomFieldsOnly

bool CustomFieldsOnly { get; set; }

Gets or sets whether to include only custom fields. Default: false.

DisablePluginsByDefault

bool DisablePluginsByDefault { get; set; }

Gets or sets the default value for disabling plugins during import. Default: false.

EntityFilters

IReadOnlyDictionary<string, string> EntityFilters { get; set; }

Gets or sets per-entity FetchXML filter expressions to embed in the generated schema. Keys are entity logical names; values are FetchXML filter XML strings (e.g., "<filter><condition attribute='statecode' operator='eq' value='0'/></filter>").

ExcludeAttributes

IReadOnlyList<string> ExcludeAttributes { get; set; }

Gets or sets the attributes to exclude (blacklist). If set, these attributes are excluded. Ignored if IncludeAttributes is set.

IncludeAllFields

bool IncludeAllFields { get; set; }

Gets or sets whether to include all fields. Default: true.

IncludeAttributes

IReadOnlyList<string> IncludeAttributes { get; set; }

Gets or sets the attributes to include (whitelist). If set, only these attributes are included. Takes precedence over ExcludeAttributes. Primary key is always included.

IncludeAuditFields

bool IncludeAuditFields { get; set; }

Gets or sets whether to include audit fields (createdon, createdby, modifiedon, modifiedby, etc.). Default: false.