SalesforceFieldDescription

@kysoql/codegen / SalesforceFieldDescription

Field metadata required to render a generated Kysoql schema.

Properties

Property	Modifier	Type	Description
`name`	`readonly`	`string`	Salesforce field API name.
`type`	`readonly`	`string`	Salesforce Describe field type.
`nillable`	`readonly`	`boolean`	Whether Salesforce reports the field as nillable.
`filterable`	`readonly`	`boolean`	Whether Salesforce reports the field as filterable.
`sortable`	`readonly`	`boolean`	Whether Salesforce reports the field as sortable.
`groupable`	`readonly`	`boolean`	Whether Salesforce reports the field as groupable.
`aggregatable`	`readonly`	`boolean`	Whether Salesforce reports the field as aggregatable.
`custom`	`readonly`	`boolean`	Whether this is a custom Salesforce field.
`referenceTo?`	`readonly`	readonly `string`[]	Target object API names for reference fields.
`relationshipName?`	`readonly`	`string` \| `null`	Parent relationship name supplied by Salesforce, if any.
`namePointing?`	`readonly`	`boolean`	Whether Salesforce marks the field as a polymorphic name-pointing reference.
`polymorphicForeignKey?`	`readonly`	`boolean`	Whether Salesforce marks the field as a polymorphic foreign key.
`picklistValues?`	`readonly`	readonly `SalesforcePicklistValue`[]	Picklist values returned by Describe for this field.