ReferenceAPI referenceInterfaces

SalesforceObject

Generated API reference for SalesforceObject in @kysoql/core.

@kysoql/core / SalesforceObject

Type-level description of one Salesforce object and its query capabilities.

Type Parameters

Type Parameter	Default type
`Fields` extends `Record`<`string`, `AnySalesforceField`>	-
`Parents` extends `Record`<`string`, `SalesforceParentRelationship`<`string`, `string`, `boolean`>>	`Record`<`string`, `never`>
`Children` extends `Record`<`string`, `SalesforceChildRelationship`<`string`, `string`>>	`Record`<`string`, `never`>
`SupportedScope` extends `string`	`never`
`DataCategoryGroups` extends `Record`<`string`, `string`>	`Record`<`string`, `never`>
`MruEnabled` extends `boolean`	`boolean`
`SetOptionsCapability` extends `SalesforceSetOptionsCapability`	`"none"`
`FieldsComplete` extends `boolean`	`true`

Properties

Property	Modifier	Type	Description
`fields`	`readonly`	`Fields`	Field definitions keyed by Salesforce field API name.
`parents`	`readonly`	`Parents`	Parent relationship definitions keyed by relationship name.
`children`	`readonly`	`Children`	Child relationship definitions keyed by relationship name.
`supportedScopes`	`readonly`	`SupportedScope`	Union of `USING SCOPE` values accepted by this object.
`dataCategoryGroups`	`readonly`	`DataCategoryGroups`	Data-category groups and values available to `WITH DATA CATEGORY`.
`mruEnabled`	`readonly`	`MruEnabled`	Whether MRU-dependent clauses such as `FOR VIEW` are supported.
`setOptionsCapability`	`readonly`	`SetOptionsCapability`	Which Salesforce `SET OPTIONS` variant this object supports.
`fieldsComplete?`	`readonly`	`FieldsComplete`	False for field-filtered schemas; server-side FIELDS() cannot be narrowed.

SalesforceGeolocation

Generated API reference for SalesforceGeolocation in @kysoql/core.

SalesforceParentRelationship

Generated API reference for SalesforceParentRelationship in @kysoql/core.

On this page

Type Parameters Properties