Class SchemaDataStore

Index

Constructors

Properties

Methods

addDescribe addEntityDefinition addMetadata get has load loadCacheVersion1 loadCacheVersion2 loadFromFile mergeStoreData saveToFile

Constructors

constructor

new SchemaDataStore(): SchemaDataStore
Returns SchemaDataStore

Properties

`Private` `Readonly`fieldInfo

fieldInfo: Map<string, SchemaData<CustomFieldMetadata, Field, FieldDefinition>> = ...

`Private` `Readonly`objectInfo

objectInfo: Map<
string,
SchemaData<CustomObjectMetadata, DescribeSObjectResult, EntityDefinition>,
> = ...

`Private` `Readonly`storeVersion

storeVersion: 2

Methods

addDescribe

addDescribe(describe: DescribeSObjectResult): SchemaDataStore
Add Salesforce table schema data to the store so it can be accessed at any time.
Parameters
- describe: DescribeSObjectResult
  Describe result for the SObject
Returns SchemaDataStore
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:28

addEntityDefinition

addEntityDefinition(entity: EntityDefinition): SchemaDataStore
Parameters
- entity: EntityDefinition
Returns SchemaDataStore
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:36

addMetadata

addMetadata(info: CustomObjectMetadata): SchemaDataStore
Parameters
- info: CustomObjectMetadata
Returns SchemaDataStore
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:44

get

get(
    type: string,
):
    | undefined
    | SchemaData<CustomObjectMetadata, DescribeSObjectResult, EntityDefinition>
Parameters
- type: string
Returns
| undefined
| SchemaData<CustomObjectMetadata, DescribeSObjectResult, EntityDefinition>
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:59
get(
type: string,
field: string,
): undefined | SchemaData<CustomFieldMetadata, Field, FieldDefinition>
Parameters
- type: string
- field: string
Returns undefined | SchemaData<CustomFieldMetadata, Field, FieldDefinition>
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:60
get(
    type: string,
    field?: string,
):
    | undefined
    | SchemaData<CustomObjectMetadata, DescribeSObjectResult, EntityDefinition>
    | SchemaData<CustomFieldMetadata, Field, FieldDefinition>
Parameters
- type: string
- Optionalfield: string
Returns
    | undefined
    | SchemaData<CustomObjectMetadata, DescribeSObjectResult, EntityDefinition>
    | SchemaData<CustomFieldMetadata, Field, FieldDefinition>
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:61

has

has(type: string): boolean
Parameters
- type: string
Returns boolean
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:66

load

load(data: string | object | Buffer<ArrayBufferLike>): Promise<SchemaDataStore>
Restore Salesforce table schema data from a perviously persisted cached (@see persistCache)
Parameters
- data: string | object | Buffer<ArrayBufferLike>
  data string
Returns Promise<SchemaDataStore>
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:94

`Private`loadCacheVersion1

loadCacheVersion1(data: any): void
Parameters
- data: any
Returns void
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:110

`Private`loadCacheVersion2

loadCacheVersion2(data: any): void
Parameters
- data: any
Returns void
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:117

loadFromFile

loadFromFile(file: string): Promise<SchemaDataStore>
Load store contents from a file stored on disk
Parameters
- file: string
  file name to load
Returns Promise<SchemaDataStore>
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:86

`Private`mergeStoreData

mergeStoreData<D, T, M>(
    store: Map<string, SchemaData<T, D, M>>,
    key: string,
    data: SchemaData<T, D, M>,
): void
Type Parameters
- D
- T
- M
Parameters
- store: Map<string, SchemaData<T, D, M>>
- key: string
- data: SchemaData<T, D, M>
Returns void
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:52

saveToFile

saveToFile(file: string): Promise<void>
Persist the currently loaded Meta and describe data about the Salesforce table schema to the the disk.
Parameters
- file: string
  FileName to which to persist the schema data
Returns Promise<void>
- Defined in packages/salesforce/src/schema/schemaDataStore.ts:74

Class SchemaDataStore

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SchemaDataStore

Properties

Private ReadonlyfieldInfo

Private ReadonlyobjectInfo

Private ReadonlystoreVersion

Methods

addDescribe

Parameters

Returns SchemaDataStore

addEntityDefinition

Parameters

Returns SchemaDataStore

addMetadata

Parameters

Returns SchemaDataStore

get

Parameters

Returns | undefined | SchemaData<CustomObjectMetadata, DescribeSObjectResult, EntityDefinition>

Parameters

Returns undefined | SchemaData<CustomFieldMetadata, Field, FieldDefinition>

Parameters

Returns | undefined | SchemaData<CustomObjectMetadata, DescribeSObjectResult, EntityDefinition> | SchemaData<CustomFieldMetadata, Field, FieldDefinition>

has

Parameters

Returns boolean

load

Parameters

Returns Promise<SchemaDataStore>

PrivateloadCacheVersion1

Parameters

Returns void

PrivateloadCacheVersion2

Parameters

Returns void

loadFromFile

Parameters

Returns Promise<SchemaDataStore>

PrivatemergeStoreData

Type Parameters

Parameters

Returns void

saveToFile

Parameters

Returns Promise<void>

Settings

On This Page

`Private` `Readonly`fieldInfo

`Private` `Readonly`objectInfo

`Private` `Readonly`storeVersion

Returns
| undefined
| SchemaData<CustomObjectMetadata, DescribeSObjectResult, EntityDefinition>

Returns
| undefined
| SchemaData<CustomObjectMetadata, DescribeSObjectResult, EntityDefinition>
| SchemaData<CustomFieldMetadata, Field, FieldDefinition>

`Private`loadCacheVersion1

`Private`loadCacheVersion2

`Private`mergeStoreData