SalesforceFieldMetadata

@kysoql/core / SalesforceFieldMetadata

Metadata that describes Salesforce field capabilities in a Kysoql schema.

Properties

Property	Modifier	Type	Description
`salesforceType`	`readonly`	`string`	Salesforce Describe field type, such as `string`, `date`, or `reference`.
`nullable`	`readonly`	`boolean`	Whether Salesforce can return `null` for this field.
`filterable`	`readonly`	`boolean`	Whether the field can be referenced in a `WHERE` predicate.
`sortable`	`readonly`	`boolean`	Whether the field can be referenced in `ORDER BY`.
`groupable`	`readonly`	`boolean`	Whether the field can be referenced in `GROUP BY`.
`referenceTo?`	`readonly`	`string`	Referenced Salesforce object name for a relationship field, when known.
`relationshipName?`	`readonly`	`string`	Parent relationship name used for dotted relationship traversal.
`activePicklistValue?`	`readonly`	`string`	Active picklist values represented by the generated field type.
`aggregatable?`	`readonly`	`boolean`	Whether the field can be passed to Salesforce aggregate functions.
`custom?`	`readonly`	`boolean`	Whether the field is a custom Salesforce field.
`polymorphic?`	`readonly`	`boolean`	Whether the relationship can target more than one Salesforce object type.