Writing Parameterized Queries
You can create dynamic spreadsheets by referencing cells in your SQL statement. The add-in executes the statement as a parameterized query. As you change the values in the sheet the add-in executes a new query.
Creating Searchable Spreadsheets
Use a parameterized SELECT WHERE query to create a spreadsheet that dynamically filters the data as you edit cells. The following filter criteria references the @InputSheet!A2 parameter -- cell A2 of the sheet InputSheet.
SELECT Id, Firstname FROM People WHERE Id = @InputSheet!A2
Defining Optional and Required Parameters
When you prefix a parameter with @@, empty values in the referenced cell do not affect the query (i.e. any condition that refers to a cell with an empty value is removed).
In the following query, Firstname is an optional search parameter, but Id must be specified.
SELECT * FROM People WHERE Id = @InputSheet!A2 AND Firstname = @@InputSheet!A3
Dynamic Table References
You can dynamically reference a table in a query by prefixing the cell reference with @@@. The following query will read the value from cell A1 on the InputSheet sheet and use that for the table name when executing the request.
SELECT * FROM @@@InputSheet!A1
Writing Other Search Conditions
By default, the add-in reports a match if the Highrise column contains the cell value. For example if the referenced cell has the value 'MyId', then the equivalent SQL predicate is:
LIKE '%MyId%'
You can execute starts-with and ends-with searches by adding a '%' to the cell value:
InputSheet!A2 Cell | Query | Equivalent Predicate |
'MyId' | SELECT * FROM People WHERE Id LIKE @InputSheet!A2 | LIKE '%MyId%' |
'%MyId' | SELECT * FROM People WHERE Id LIKE @InputSheet!A2 | LIKE '%MyId' |
'MyId%' | SELECT * FROM People WHERE Id LIKE @InputSheet!A2 | LIKE 'MyId%' |