# Class QueryService
Service for executing data queries.
# Constructors
# constructor
new QueryService(
sisenseContextService):QueryService
# Parameters
| Parameter | Type |
|---|---|
sisenseContextService | SisenseContextService |
# Returns
# Methods
# executeCsvQuery
executeCsvQuery(
params):Promise< {data:Blob|string; } >
Executes a CSV data query. Similar to QueryService.executeQuery, but returns the data in CSV format as text or as a stream.
# Parameters
| Parameter | Type | Description |
|---|---|---|
params | ExecuteCsvQueryParams | CSV query parameters |
# Returns
Promise< {
data: Blob | string;
} >
CSV query result
# executeCustomWidgetQuery
executeCustomWidgetQuery(
params):Promise< {data:QueryResultData; } >
Executes a data query from custom widget component props.
This method takes custom widget props (dataSource, dataOptions, filters, etc.) and executes the appropriate data query
# Parameters
| Parameter | Type | Description |
|---|---|---|
params | ExecuteCustomWidgetQueryParams | Custom widget component props containing data source, data options, filters, etc. |
# Returns
Promise< {
data: QueryResultData;
} >
Promise resolving to query result with formatted data
# executePivotQuery Beta
executePivotQuery(
params):Promise< {data:PivotQueryResultData; } >
Executes a data query for a pivot table.
# Parameters
| Parameter | Type | Description |
|---|---|---|
params | ExecutePivotQueryParams | Pivot query parameters |
# Returns
Promise< {
data: PivotQueryResultData;
} >
Pivot query result
# executeQuery
executeQuery(
params):Promise< {data:QueryResultData; } >
Executes a data query. If you want to display the query results, you can use them to populate Compose SDK UI elements or third party UI elements.
To learn how to populate third party UI elements with query results, see the External Charts Guide
# Parameters
| Parameter | Type | Description |
|---|---|---|
params | ExecuteQueryParams | Query parameters |
# Returns
Promise< {
data: QueryResultData;
} >
Query result
# executeQueryByWidgetId
executeQueryByWidgetId(
params):Promise< {data:QueryResultData; } &QueryByWidgetIdQueryParams>
Executes a data query extracted from an existing widget in the Sisense instance.
# Parameters
| Parameter | Type | Description |
|---|---|---|
params | ExecuteQueryByWidgetIdParams | Parameters to identify the target widget |
# Returns
Promise< {
data: QueryResultData;
} & QueryByWidgetIdQueryParams >
Query result