Class ToolingApiSchemaAccess

Lazy access to Salesforce schema objects, instead of pre-loading all schema data schema and describe calls are made when needed. This speeds up initial loading time but the total time needed for describing all objects will be significantly higher.

Constructors

constructor

new ToolingApiSchemaAccess(
queryService: QueryService,
schemaStore: SchemaDataStore,
): ToolingApiSchemaAccess
Parameters
- queryService: QueryService
- schemaStore: SchemaDataStore
Returns ToolingApiSchemaAccess
- Defined in packages/salesforce/src/schema/toolingApiSchemaAccess.ts:83

Properties

chunkSize

chunkSize: number = 50

Default chunk size for fetching entities

`Private` `Readonly`deferredProcessor

deferredProcessor: DeferredWorkQueue<string, any> = ...

entityDefinition

entityDefinition: {
    fields: string[];
    filter: {
        IsDeprecatedAndHidden: boolean;
        IsEverCreatable: boolean;
        IsQueryable: boolean;
        KeyPrefix: { op: string; value: null };
    };
    name: string;
} = ...

`Private` `Readonly`entityDefinitionFilter

entityDefinitionFilter: {
    IsDeprecatedAndHidden: boolean;
    IsEverCreatable: boolean;
    IsQueryable: boolean;
    KeyPrefix: { op: string; value: null };
} = ...

`Private` `Readonly`entityDefinitionObjectFields

entityDefinitionObjectFields: string[] = ...

`Private` `Readonly`entityDefinitionObjectName

entityDefinitionObjectName: "EntityDefinition" = 'EntityDefinition'

`Private` `Readonly`excludedObjectListPostFixes

excludedObjectListPostFixes: string[] = ...

fieldDefinition

fieldDefinition: { fields: string[]; name: string } = ...

`Private` `Readonly`fieldDefinitionObjectFields

fieldDefinitionObjectFields: string[] = ...

`Private` `Readonly`fieldDefinitionObjectName

fieldDefinitionObjectName: "FieldDefinition" = 'FieldDefinition'

`Private` `Readonly`logger

logger: Logger

`Private` `Readonly`objectListChunkSize

objectListChunkSize: 2000

parallelism

parallelism: number = 5

Number of parallel processing threads for fetching entity definitions from the server

`Private` `Readonly`queryService

queryService: QueryService

`Private` `Readonly`schemaStore

schemaStore: SchemaDataStore

Methods

`Private`enqueue

enqueue(sobjectType: string): DeferredPromise<any>
Parameters
- sobjectType: string
Returns DeferredPromise<any>
- Defined in packages/salesforce/src/schema/toolingApiSchemaAccess.ts:116

`Private`executeToolingQuery

executeToolingQuery<T extends object>(
    query: QueryBuilder,
    field: string,
    chunk: string[],
): Promise<T[]>
Type Parameters
- T extends object
Parameters
- query: QueryBuilder
- field: string
- chunk: string[]
Returns Promise<T[]>
- Defined in packages/salesforce/src/schema/toolingApiSchemaAccess.ts:164

getEntityDefinition

getEntityDefinition(type: string): Promise<undefined | EntityDefinition>
Parameters
- type: string
Returns Promise<undefined | EntityDefinition>
- Defined in packages/salesforce/src/schema/toolingApiSchemaAccess.ts:108

`Private`getEntityDefinitions

getEntityDefinitions(
sobjectTypes: string[],
chunkSize?: number,
): Promise<WorkItemResult<any>[]>
Parameters
- sobjectTypes: string[]
- chunkSize: number = ...
Returns Promise<WorkItemResult<any>[]>
- Defined in packages/salesforce/src/schema/toolingApiSchemaAccess.ts:120

listObjectTypes

listObjectTypes(chunkSize?: number): Promise<string[]>
Parameters
- chunkSize: number = ...
Returns Promise<string[]>
- Defined in packages/salesforce/src/schema/toolingApiSchemaAccess.ts:87

`Private`normalize

normalize(obj: any): any
Parameters
- obj: any
Returns any
- Defined in packages/salesforce/src/schema/toolingApiSchemaAccess.ts:198

Class ToolingApiSchemaAccess

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ToolingApiSchemaAccess

Properties

chunkSize

Private ReadonlydeferredProcessor

entityDefinition

Private ReadonlyentityDefinitionFilter

Private ReadonlyentityDefinitionObjectFields

Private ReadonlyentityDefinitionObjectName

Private ReadonlyexcludedObjectListPostFixes

fieldDefinition

Private ReadonlyfieldDefinitionObjectFields

Private ReadonlyfieldDefinitionObjectName

Private Readonlylogger

Private ReadonlyobjectListChunkSize

parallelism

Private ReadonlyqueryService

Private ReadonlyschemaStore

Methods

Privateenqueue

Parameters

Returns DeferredPromise<any>

PrivateexecuteToolingQuery

Type Parameters

Parameters

Returns Promise<T[]>

getEntityDefinition

Parameters

Returns Promise<undefined | EntityDefinition>

PrivategetEntityDefinitions

Parameters

Returns Promise<WorkItemResult<any>[]>

listObjectTypes

Parameters

Returns Promise<string[]>

Privatenormalize

Parameters

Returns any

Settings

On This Page

`Private` `Readonly`deferredProcessor

`Private` `Readonly`entityDefinitionFilter

`Private` `Readonly`entityDefinitionObjectFields

`Private` `Readonly`entityDefinitionObjectName

`Private` `Readonly`excludedObjectListPostFixes

`Private` `Readonly`fieldDefinitionObjectFields

`Private` `Readonly`fieldDefinitionObjectName

`Private` `Readonly`logger

`Private` `Readonly`objectListChunkSize

`Private` `Readonly`queryService

`Private` `Readonly`schemaStore

`Private`enqueue

`Private`executeToolingQuery

`Private`getEntityDefinitions

`Private`normalize