Class ExtOpsService

Extended non-standard Haystack ops.

Index

Constructors

Methods

commit eval evalAll isDefsLoaded loadDefs read

Constructors

constructor

new ExtOpsService(serviceConfig: ClientServiceConfig): ExtOpsService
Constructs a service object.
Parameters
- serviceConfig: ClientServiceConfig
  Service configuration.
Returns ExtOpsService
- Defined in src/client/ExtOpsService.ts:53

Methods

commit

commit(
type: CommitType,
data: HaysonDict | HDict | HGrid | HaysonDict[] | HList<HDict> | HDict[],
): Promise<HGrid>
Commit changes to the database. The caller must have 'admin' permissions in order to use this op.

The commit type can be one of the following...
- add: adds new records into the database and returns a grid with the newly minted record identifiers. As a general rule you should not have an id column in your commit grid. However if you wish to predefine the id of the records, you can specify an id column in the commit grid.
- update: modified existing records, the records must have both an id and mod column
- remove: removes existing records, the records should have only an id and mod column
https://skyfoundry.com/doc/docSkySpark/Ops#commit
Parameters
- type: CommitType
  The commit operation type (add, update or remove).
- data: HaysonDict | HDict | HGrid | HaysonDict[] | HList<HDict> | HDict[]
  The data to commit.
Returns Promise<HGrid>
- Defined in src/client/ExtOpsService.ts:113

eval

eval(expr: string): Promise<HGrid>
Evaluate some code server side and return the response.

This operation will automatically attempt to batch network calls together to optimize client network requests.

https://skyfoundry.com/doc/docSkySpark/Ops#eval
Parameters
- expr: string
  The expression to evaluate.
Returns Promise<HGrid>
The evaluated expression response.
- Defined in src/client/ExtOpsService.ts:174

evalAll

evalAll(exprs: string[]): Promise<HGrid[]>
Evalulate all the expressions and return the grids.

https://skyfoundry.com/doc/docSkySpark/Ops#evalAll
Parameters
- exprs: string[]
  The expressions to evaluate.
Returns Promise<HGrid[]>
The evalulated expression responses.

Throws
Any fetch or grid responses.
- Defined in src/client/ExtOpsService.ts:207

isDefsLoaded

isDefsLoaded(): boolean
Returns boolean
True if the defs have been loaded using this service.
- Defined in src/client/ExtOpsService.ts:85

loadDefs

loadDefs(): Promise<void>
Asynchronously load the defs library using this service.

Please note, this will overwrite any existing defs loaded.

Returns Promise<void>
A promise that's resolved once the defs have been loaded.
- Defined in src/client/ExtOpsService.ts:67

read

read(filter: string): Promise<HGrid>
Evalulate a haystack filter request and return the result.

This operation will automatically attempt to batch network calls together to optimize client network requests.
Parameters
- filter: string
  The haystack filter.
Returns Promise<HGrid>
The result of the filter query.
- Defined in src/client/ExtOpsService.ts:140