Excel Add-In for API

Build 23.0.8839

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 Email, Username FROM NorthwindOData WHERE Email = @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, Username is an optional search parameter, but Email must be specified.

SELECT * FROM NorthwindOData WHERE Email = @InputSheet!A2 AND Username = @@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 API column contains the cell value. For example if the referenced cell has the value 'ana.trujilo@northwind.org', then the equivalent SQL predicate is:

LIKE '%ana.trujilo@northwind.org%'

You can execute starts-with and ends-with searches by adding a '%' to the cell value:

InputSheet!A2 Cell Query Equivalent Predicate
'ana.trujilo@northwind.org' SELECT * FROM NorthwindOData WHERE Email LIKE @InputSheet!A2 LIKE '%ana.trujilo@northwind.org%'
'%ana.trujilo@northwind.org' SELECT * FROM NorthwindOData WHERE Email LIKE @InputSheet!A2 LIKE '%ana.trujilo@northwind.org'
'ana.trujilo@northwind.org%' SELECT * FROM NorthwindOData WHERE Email LIKE @InputSheet!A2 LIKE 'ana.trujilo@northwind.org%'

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839