Constructor
new FlexSchema(flexSessionnon-null, dnsPathnullable)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
flexSession |
FlexSession | The FlexSession this FlexSchema belongs | |
dnsPath |
string |
<nullable> |
The /Domain/Nexus/Schema path |
Classes
Methods
close()
Should be called when this FlexSchema is no longer needed.
(async) deleteConnection(flexConnectionnon-null)
Deletes the specified FlexConnection. FlexSchema.save() must be called to complete the deletion.
Parameters:
| Name | Type | Description |
|---|---|---|
flexConnection |
FlexConnection |
(async) deleteConnectionByKey(objectKeynon-null)
Deletes a FlexConnection by specifying its ObjectKey. FlexSchema.save() must be called to complete the deletion.
Parameters:
| Name | Type | Description |
|---|---|---|
objectKey |
string |
(async) deleteObject(flexObjectnon-null)
Deletes the specified FlexObject. FlexSchema.save() must be called to complete the deletion.
Parameters:
| Name | Type | Description |
|---|---|---|
flexObject |
FlexObject |
(async) deleteObjectByKey(objectKeynon-null)
Deletes a FlexObject by specifying its ObjectKey. FlexSchema.save() must be called to complete the deletion.
Parameters:
| Name | Type | Description |
|---|---|---|
objectKey |
string |
(async) executeVoyage(voyagenon-null, namedParamsopt) → {FlexCargo}
Executes a Voyage from the passed-in string
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
voyage |
string | The Voyager contents | |
namedParams |
Object |
<optional> |
Each property in the object is passed to Voyager as a namedParams property |
Returns:
- Type
- FlexCargo
(async) executeVoyagerAsset(assetPathnon-null, namedParamsopt) → {FlexCargo}
Executes a Voyage from a remote asset
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
assetPath |
string | The asset path to the Voyager file | |
namedParams |
Object |
<optional> |
Each property in the object is passed to Voyager as a namedParams property |
Returns:
- Type
- FlexCargo
(async) executeVoyagerFile(voyagerFilePathnon-null, namedParamsopt) → {FlexCargo}
Executes a Voyage from a local file
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
voyagerFilePath |
string | The path to the Voyager file | |
namedParams |
Object |
<optional> |
Each property in the object is passed to Voyager as a namedParams property |
Returns:
- Type
- FlexCargo
(async) loadConnection(objectKeynon-null)
Loads and returns a FlexConnection from the specified ObjectKey
Parameters:
| Name | Type | Description |
|---|---|---|
objectKey |
string |
Returns:
FlexConnection
(async) loadObject(objectKeynon-null)
Loads and returns a FlexObject from the specified ObjectKey
Parameters:
| Name | Type | Description |
|---|---|---|
objectKey |
string |
Returns:
FlexObject
(async) query(sqlnon-null, namedParamsopt) → {FlexResultSet}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
sql |
string | ||
namedParams |
Object |
<optional> |
Each property in the object is passed to the SQL executor as a named parameter |
Returns:
- Type
- FlexResultSet
(async) save()
Must be called anytime a FlexObject or FlexConnection needs to be saved or deleted.