Parameters
Parameters allow your SQL queries to be parameterised so that users can pass their own values in at run time. These are passed into WHERE clauses in your SQL statement before being passed to the database.
Create a Parameter
To create a parameter, navigate to Parameters on the side bar and click on Create.
Fill in the fields to create your parameter.
| Field | Description |
|---|---|
| Name | The name of the parameter field in the database. |
| Type | The data type of the field. Can be one of string, integer, numeric or date. |
| Description | This description will appear to users when they call a sheet containing this parameter. Can be useful for giving more detailed information on what a parameter is for. |
| Required | Boolean true or false. If true Sheetloom will not run unless supplied with a value for this parameter |
| Default Value | A default value. Useful for non-required parameters that the user can leave blank to default to this value. |
When finished, click Add to create the parameter.