This article provides users with a general guide to the features listed.

These features may have been updated or superseded by additions found in the release notes.

Read the content below to become familiar with the feature and review the release notes to get the latest iteration.

Parameters

Concept of Parameters here in Goliath

Parameter Actions

Parameters can be used in query text area, GoBQ text area, Inline UDF text area, and Options input boxes

1. Parameters are identified by <var_parametername>, :var_parametername, @var_parametername, or @parametername

a. <> syntax - uses the value only - so parameter replaced with its value

b. : syntax - uses both the value and data type - so parameter replaced with its typed value. (for example - for string type parameter is replaced with "value"

c. @ syntax - uses both the value and data type - so parameter replaced with its typed value. (for example - for string type parameter is replaced with "value"

2. Click Parameters button to open Parameters window and add custom parameters defined in query/input boxes. If Parameters window is already open, this button will close the window.

3. A list of built-in parameters are displayed along with any custom parameters added when Parameters is clicked. Parameters not in use are greyed. Double-click on any parameter name to add it to the current editor.

4. Custom parameters can also be added by filling out name, type, and value from Parameters table and clicking +

5. Value fields that contain no value are bordered red when parameter is used and yellow when the parameter is not in use

6. Parameters with record type have accompanying schema input field

7. Click to refresh built-in parameter to reflect the current date/time.

8. Click to remove custom parameter

Parameter Menu Options

Menu Item	Action
Collect	Adds parameters not already included to list
Reset	Resets built-in parameter values to default and clears custom parameter values
Run-Time Preview	Opens modal and displays content with parameters substituted with values (see below)
Double Evaluation	Enables second round of parameter evaluation
Remove Unused	Removes all unused (greyed) custom parameters
Show: Built-In	When enabled built-in parameters are displayed When disabled built-in parameters are hidden
Show: Unused	When enabled parameters that are not in use are displayed When disabled parameters that are not in use are hidden

Run-Time Preview

Working with parameters

Run-Time Preview will display workspace in PopUp with substituted values

Click on Run-Time Preview to display substitution of parameters with their value

Click on Apply to Workspace to permanently substitute values to workspace. This action cannot be undone

Record Parameter

Record parameter consists two parts: Schema and Value. It is different from other parameter type in the sense that a record parameter can contain more than one field. For example, user can create a Record parameter named var_car that contains all attributes of a car. The attributes of the car can then be accessed by field name: <var_car[id]>, <var_car[brand]>, <var_car[color]>, <var_car[country]>, <var_car[year]>. They can also be accessed by index: <var_car[1]>, … <var_car[5]>. So instead of creating five separate parameters, the attributes of the car are encapsulated in one Record parameter.

To create

1. Enter name of the parameter.
2. Select record as its type.
3. Enter the value. If there is more than one field, separate the fields by comma. For example:

a. If a string field contains comma, wrap the string with quotes.
In this example, <var_car[3]> is the string "Red,Blue":

b. To escape double quote in a string field, use 2 double quotes:
In this example, <var_car[2]> is the string Ford "Falcon":

4. Enter the schema. It is expressed in the format of: name type [,name type …]
where type can be: string, number, or boolean.
For example:

a. The full schema from the example is:
id number,brand string,color string,country string,year number

b. Field type in the schema is optional. If it is not specified, all fields will be treated as string. For example, all fields will be treated as string for this schema:
id,brand,color,country,year

c. Schema is optional. If it is not specified, fields of the record parameter can be accessed by index (starts from 1): <var_car[1]>, <var_car[2]>, …, <var_car[5]>

To access

1. The field of a record parameter can be accessed:

a. By index (starts from 1):
This returns the first field of the record parameter:
<var_car[1]>, :var_car[1], @var_car[1], or @car[1]
b. By field name:
<var_car[brand], :var_car[brand], @var_car[brand], or @car[brand]

2. The index 0 returns the last field.
For example:
<var_car[0]> is equivalent to <var_car[5]> following the example where the record has 5 fields.

3. :var_car[#] returns the field count of the record parameter, which is 5 following the example.

4. If the subscript has no index or field name:

a. <var_car[]> is the string representation of the record parameter, for example:
10,Ford,Red,USA,2016

Workspace

Concept

Workspace includes Mode, Options, Query/Script Area, and Parameters

Mode
Query/Script Area
Options
Parameters

Save Workspace

	Click on Save to bring up Save Workspace dialogue
	Add name of file Check to include saving of options. Uncheck to not include saving of options Check to include saving parameters. Uncheck to not include saving of parameters Click Save button to save workspace. File is saved to default download folder
	Include Options Entries, selections, and UDF in options will be saved when checking Include Options from Save Query/Workspace
	Include Parameters Parameter options, built in parameters, and custom parameters are saved along with their type and value when include parameters is checked in Save Query/Workspace
	File is saved to default download folder The file extension is Sql when Include Options and Include Parameters are unchecked Workspace when either Include Options or Include Parameters is checked