Query Result To Grid
Public preview
The Query Result To Grid component allows you to query a table and return rows of data that are loaded into a predefined grid variable for use elsewhere in the pipeline. The component features both basic and advanced modes that allow you to set up a simple query via the component interface or to write your own SQL query.
This component is the grid equivalent of the Query Result To Scalar component.
Properties
Name = string
A human-readable name for the component.
Mode = drop-down
- Basic: This mode will build a query for you using the settings you configure in the Database, Schema, Table, Table Columns, Order By, Sort, Limit, Filter Conditions, and Combine Conditions properties. In most cases, this mode will be sufficient.
- Advanced: This mode will require you to write an SQL-like query in the Query property, to call data from Snowflake. The available fields and their descriptions are documented in the data model.
Query = code editor
Input an SQL-like query, written according to the profile definition.
This property is only available when Mode is set to Advanced.
Warning
Do not end SQL statements with a semicolon in this component.
Database = drop-down
The Snowflake database. The special value, [Environment Default], will use the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.
Schema = drop-down
The Snowflake schema. The special value, [Environment Default], will use the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.
Table = string
The name of the table to be queried.
Table Columns = dual listbox
Select which columns to take from the table as part of the query.
Order By = dual listbox
Choose the columns by which to sort rows. If multiple columns are selected, rows are sorted by the first-listed column first, then by the next listed column, and so on.
Warning
An update to Snowflake has resulted in a change in the behaviour of this parameter. The LIMIT 5000 clause (which the Advanced Mode parameter automatically wraps the query in) no longer guarantees that the order specified by the ORDER BY in the sub-query is preserved.
Sort = drop-down
Select whether rows are sorted in Ascending or Descending order.
Limit = integer
Set the limit of returned rows.
Grid Variable = drop-down
Choose the grid variable to be loaded with data resulting from the query.
Grid Variable Mapping = column editor
Map columns from the queried table to the columns of the grid variable.
Filter Conditions = column editor
- Input Column: Select an input column. The available input columns vary depending upon the data source.
- Qualifier:
- Is: Compares the column to the value using the comparator.
- Not: Reverses the effect of the comparison, so "Equals" becomes "Not equals", "Less than" becomes "Greater than or equal to", etc.
- Comparator: Choose a method of comparing the column to the value. Possible comparators include: "Equal to", "Greater than", "Less than", "Greater than or equal to", "Less than or equal to", "Like", "Null". "Equal to" can match exact strings and numeric values, while other comparators, such as "Greater than" and "Less than", will work only with numerics. The "Like" operator allows the wildcard character [%] to be used at the start and end of a string value to match a column. The Null operator matches only null values, ignoring whatever the value is set to. Not all data sources support all comparators, meaning that it is likely that only a subset of the above comparators will be available to choose from.
- Value: The value to be compared.
Combine Filters = drop-down
Select whether to use the defined filters in combination with one another according to either And or Or.
Name = string
A human-readable name for the component.
Mode = drop-down
- Basic: This mode will build a query for you using the settings you configure in the Catalog, Database, Table, Table Columns, Order By, Sort, Limit, Filter Conditions, and Combine Conditions properties. In most cases, this mode will be sufficient.
- Advanced: This mode will require you to write an SQL-like query in the Query property, to call data from Databricks. The available fields and their descriptions are documented in the data model.
Query = code editor
Input an SQL-like query, written according to the profile definition.
This property is only available when Mode is set to Advanced.
Warning
Do not end SQL statements with a semicolon in this component.
Catalog = drop-down
Select a Databricks Unity Catalog. The special value, [Environment Default], will use the catalog specified in the Data Productivity Cloud environment setup. Selecting a catalog will determine which databases are available in the next parameter.
Schema (Database) = drop-down
The Databricks schema. The special value, [Environment Default], will use the schema defined in the environment. Read Create and manage schemas to learn more.
Table = string
A name for the table. Only available when the table type is Native.
Table Columns = dual listbox
Select which columns to take from the table as part of the query.
Order By = dual listbox
Choose the columns by which to sort rows. If multiple columns are selected, rows are sorted by the first-listed column first, then by the next listed column, and so on.
Sort = drop-down
Select whether rows are sorted in Ascending or Descending order.
Limit = integer
Set the limit of returned rows.
Grid Variable = drop-down
Choose the grid variable to be loaded with data resulting from the query.
Grid Variable Mapping = column editor
Map columns from the queried table to the columns of the grid variable.
Filter Conditions = column editor
- Input Column Name: Select an input column. The available input columns vary depending upon the data source.
- Qualifier:
- Is: Compares the column to the value using the comparator.
- Not: Reverses the effect of the comparison, so "Equals" becomes "Not equals", "Less than" becomes "Greater than or equal to", etc.
- Comparator: Choose a method of comparing the column to the value. Possible comparators include: "Equal to", "Greater than", "Less than", "Greater than or equal to", "Less than or equal to", "Like", "Null". "Equal to" can match exact strings and numeric values, while other comparators, such as "Greater than" and "Less than", will work only with numerics. The "Like" operator allows the wildcard character [%] to be used at the start and end of a string value to match a column. The Null operator matches only null values, ignoring whatever the value is set to. Not all data sources support all comparators, meaning that it is likely that only a subset of the above comparators will be available to choose from.
- Value: The value to be compared.
Combine Filters = drop-down
Select whether to use the defined filters in combination with one another according to either And or Or.
Name = string
A human-readable name for the component.
Mode = drop-down
- Basic: This mode will build a query for you using the settings you configure in the Schema, Table, Table Columns, Order By, Sort, Limit, Filter Conditions, and Combine Conditions properties. In most cases, this mode will be sufficient.
- Advanced: This mode will require you to write an SQL-like query in the Query property, to call data from Redshift. The available fields and their descriptions are documented in the data model.
Query = code editor
Input an SQL-like query, written according to the profile definition.
This property is only available when Mode is set to Advanced.
Warning
Do not end SQL statements with a semicolon in this component.
Schema = drop-down
Select the table schema. The special value, [Environment Default], will use the schema defined in the environment. For more information on using multiple schemas, read Schemas.
Table = string
A name for the table. Only available when the table type is Native.
Table Columns = dual listbox
Select which columns to take from the table as part of the query.
Order By = dual listbox
Choose the columns by which to sort rows. If multiple columns are selected, rows are sorted by the first-listed column first, then by the next listed column, and so on.
Sort = drop-down
Select whether rows are sorted in Ascending or Descending order.
Limit = integer
Set the limit of returned rows.
Grid Variable = drop-down
Choose the grid variable to be loaded with data resulting from the query.
Grid Variable Mapping = column editor
Map columns from the queried table to the columns of the grid variable.
Filter Conditions = column editor
- Input Column Name: Select an input column. The available input columns vary depending upon the data source.
- Qualifier:
- Is: Compares the column to the value using the comparator.
- Not: Reverses the effect of the comparison, so "Equals" becomes "Not equals", "Less than" becomes "Greater than or equal to", etc.
- Comparator: Choose a method of comparing the column to the value. Possible comparators include: "Equal to", "Greater than", "Less than", "Greater than or equal to", "Less than or equal to", "Like", "Null". "Equal to" can match exact strings and numeric values, while other comparators, such as "Greater than" and "Less than", will work only with numerics. The "Like" operator allows the wildcard character [%] to be used at the start and end of a string value to match a column. The Null operator matches only null values, ignoring whatever the value is set to. Not all data sources support all comparators, meaning that it is likely that only a subset of the above comparators will be available to choose from.
- Value: The value to be compared.
Combine Filters = drop-down
Select whether to use the defined filters in combination with one another according to either And or Or.
| Snowflake | Databricks | Amazon Redshift |
|---|---|---|
| ✅ | ✅ | ✅ |