SqlDataFrame in Expression Language - Revision history

Ollvihe: /* SqlDataFrame functions */

2025-10-29T22:04:30Z

SqlDataFrame functions

← Older revision		Revision as of 22:04, 29 October 2025
Line 217:		Line 217:
	</pre>		</pre>
	\|-		\|-
	\|\|TopInsights (~~SqlDataFrame~~)		\|\|TopInsights (In-memory DataFrame)
	\|\|		\|\|
	# Label column name (string)		# Label column name (string)
Line 244:		Line 244:
	* '''MetricControl''' (float): The total value of the metric in the control period for a specific segment.		* '''MetricControl''' (float): The total value of the metric in the control period for a specific segment.
	* '''MetricTest''' (float): The total value of the metric in the test period for a specific segment.		* '''MetricTest''' (float): The total value of the metric in the test period for a specific segment.
	* '''Contribution''' (float): The absolute impact of the segment on the change in the metric.		* '''Contribution''' (float): The absolute impact of the segment on the change in the metric. Calculation formula: MetricTest - MetricControl.
	* '''RelativeContribution''' (float): The segment's impact as a proportion of the overall change in the metric.		* '''RelativeContribution''' (float): The segment's impact as a proportion of the overall change in the metric. Calculation formula: Contribution - [Overall Contribution].
	* '''GrowthRate''' (float): The change in the metric within the segment as a proportion of the metric in the control group. Any 'infinity' value is automatically converted to null.		* '''GrowthRate''' (float): The change in the metric within the segment as a proportion of the metric in the control group. Any 'infinity' value is automatically converted to null. Calculation formula: Contribution / MetricControl.

	Example:<br>		Example:<br>

TeeHiet: /* SqlDataFrame functions */

2025-10-21T08:44:27Z

SqlDataFrame functions

← Older revision		Revision as of 08:44, 21 October 2025
Line 231:		Line 231:
	'''Returns:'''		'''Returns:'''
	An in-memory DataFrame containing the results. The result DataFrame has the following columns:		An in-memory DataFrame containing the results. The result DataFrame has the following columns:
	* '''Contributor''' (array of objects ~~encoded into JSON strings~~): Each ~~JSON~~ object in the array has the following properties:		* '''Contributor''' (array of dictionary objects): Each dictionary object in the array has the following properties:
	** '''Column''': Name of the column in the source data.		** '''Column''': Name of the column in the source data.
	** '''Value''': Value of the column.		** '''Value''': Value of the column.

TeeHiet: /* SqlDataFrame functions */

2025-10-21T08:40:50Z

SqlDataFrame functions

← Older revision		Revision as of 08:40, 21 October 2025
Line 223:		Line 223:
	\|\|		\|\|
	Uses Snowflake's [https://docs.snowflake.com/en/user-guide/ml-functions/top-insights TOP_INSIGHTS functionality] to determine the dimensions in the given data that have the most influence on a specified metric. See also the [https://docs.snowflake.com/en/sql-reference/classes/top-insights/methods/get_drivers Snowflake documentation for more details on the method used].<br /><br />		Uses Snowflake's [https://docs.snowflake.com/en/user-guide/ml-functions/top-insights TOP_INSIGHTS functionality] to determine the dimensions in the given data that have the most influence on a specified metric. See also the [https://docs.snowflake.com/en/sql-reference/classes/top-insights/methods/get_drivers Snowflake documentation for more details on the method used].<br /><br />
	Requires an instance of <code>TOP_INSIGHTS</code> class named <code>qprpa_top_insights</code> to exist in the database. The instance can be created with the following SQL query: <code>create SNOWFLAKE.ML.TOP_INSIGHTS if not exists qprpa_top_insights();</code>. An automatic attempt to create this instance is made if it is missing. If this attempt fails due to insufficient privileges, an exception with code 28 (InsufficientPrivilegesToOperateOnDatabaseSchema) is thrown.<br /><br />		Requires an instance of <code>TOP_INSIGHTS</code> class named <code>qprpa_top_insights</code> to exist in the database. The instance can be created with the following SQL query: <code>create SNOWFLAKE.ML.TOP_INSIGHTS if not exists qprpa_top_insights();</code>. An automatic attempt to create this instance is made if it is missing. If this attempt fails due to insufficient privileges, an exception with code 28 (InsufficientPrivilegesToOperateOnDatabaseSchema) is thrown. See [https://docs.snowflake.com/en/user-guide/ml-functions/top-insights#required-privileges the Snowflake documentation for the required privileges].<br /><br />
	The function uses the context SqlDataFrame as input. All columns, except for those specified by <code>labelColumnName</code> and <code>metricColumnName</code>, are treated as dimensions. Numeric columns are considered continuous, while string and Boolean columns are categorical. To treat a numeric column as categorical, it should be cast to a string.<br /><br />		The function uses the context SqlDataFrame as input. All columns, except for those specified by <code>labelColumnName</code> and <code>metricColumnName</code>, are treated as dimensions. Numeric columns are considered continuous, while string and Boolean columns are categorical. To treat a numeric column as categorical, it should be cast to a string.<br /><br />
	'''Parameters:'''		'''Parameters:'''

TeeHiet: TK-58230

2025-10-21T07:53:16Z

TK-58230

@@ Line 215: / Line 215: @@
    .TakeSample(100)
    .Collect();
 </pre>
 |-

Ollvihe: /* SqlDataFrame functions */

2024-10-07T13:15:08Z

SqlDataFrame functions

← Older revision		Revision as of 13:15, 7 October 2024
Line 90:		Line 90:
	\|-		\|-
	\|\|Collect (SqlDataFrame)		\|\|Collect (SqlDataFrame)
	\|\|(~~none~~)		\|\|Enable result caching (boolean)
	\|\|		\|\|
	Executes the SQL query for the SqlDataFrame in the datasource and returns results as an in-memory DataFrame. Then processing of the data can be continued as the in-memory DataFrame.		Executes the SQL query for the SqlDataFrame in the datasource and returns results as an in-memory DataFrame. Then processing of the data can be continued as the in-memory DataFrame. The ''Enable result caching'' parameter determines whether unique (false) or repeatable (true) object names are used in the query that affects whether query results may come from a cache or need to be recalculated each time.

	Examples:		Examples:

Ollvihe: /* SqlDataFrame functions */

2024-08-07T10:41:38Z

SqlDataFrame functions

← Older revision		Revision as of 10:41, 7 August 2024
Line 52:		Line 52:
	\|-		\|-
	\|\|Append		\|\|Append
	\|\|DataFrame to append		\|\|
			# DataFrame to append
			# Include all columns (boolean)
	\|\|Same functionality as in the [[DataFrame_in_Expression_Language\|DataFrame]].		\|\|Same functionality as in the [[DataFrame_in_Expression_Language\|DataFrame]].
	\|-		\|-

Ollvihe: /* SqlDataFrame functions */

2024-05-30T11:28:06Z

SqlDataFrame functions

← Older revision		Revision as of 11:28, 30 May 2024
Line 178:		Line 178:
	\|\|RemoveColumns (SqlDataFrame)		\|\|RemoveColumns (SqlDataFrame)
	\|\|Column names (string array)		\|\|Column names (string array)
			\|\|Same functionality as in the [[DataFrame_in_Expression_Language\|DataFrame]].
			\|-
			\|\|RenameColumns (SqlDataFrame)
			\|\|Key-value pairs of name mappings
			\|\|Same functionality as in the [[DataFrame_in_Expression_Language\|DataFrame]].
			\|-
			\|\|RenameAllColumns (SqlDataFrame)
			\|\|Template string
	\|\|Same functionality as in the [[DataFrame_in_Expression_Language\|DataFrame]].		\|\|Same functionality as in the [[DataFrame_in_Expression_Language\|DataFrame]].
	\|-		\|-

Ollvihe: /* SqlDataFrame properties */

2024-05-16T20:23:19Z

SqlDataFrame properties

← Older revision		Revision as of 20:23, 16 May 2024
Line 27:		Line 27:
	Returns: ["Integer", "String"]		Returns: ["Integer", "String"]
	</pre>		</pre>
			\|-
			\|\|DataSourceConnection
			\|\|Returns connection object used by this SqlDataFrame to connect to its datasource.
	\|-		\|-
	\|\|NColumns (Integer)		\|\|NColumns (Integer)

Ollvihe: /* SqlDataFrame functions */

2024-02-21T20:12:43Z

SqlDataFrame functions

← Older revision		Revision as of 20:12, 21 February 2024
Line 125:		Line 125:
	# Columns to match (String or key-value pairs)		# Columns to match (String or key-value pairs)
	# Join type (String)		# Join type (String)
	\|\|Same functionality as in the [[~~DataFrame_in_Expression_Language#~~Joining_DataFrames\|DataFrame]].		\|\|Same functionality as in the [[Joining_DataFrames\|DataFrame]].
	\|-		\|-
	\|\|OrderByColumns (SqlDataFrame)		\|\|OrderByColumns (SqlDataFrame)

Ollvihe: /* SqlDataFrame functions */

2023-11-17T15:22:59Z

SqlDataFrame functions

← Older revision		Revision as of 15:22, 17 November 2023
Line 193:		Line 193:
	\|\|TakeSample (SqlDataFrame)		\|\|TakeSample (SqlDataFrame)
	\|\|Number of rows (Integer)		\|\|Number of rows (Integer)
	\|\|~~Same functionality as in~~ the ~~[[DataFrame_in_Expression_Language\|DataFrame]]~~.		\|\|
			Takes a random sample of given number of rows of the original rows. Parameter is the number of rows to take.

			Example: Returns 100 random rows out of a datatable.
			<pre>
			DatatableById(1)
			.SqlDataFrame
			.TakeSample(100)
			.Collect();
			</pre>
	\|-		\|-
	\|\|Unpivot (SqlDataFrame)		\|\|Unpivot (SqlDataFrame)

← Older revision		Revision as of 11:28, 30 May 2024
Line 178:		Line 178:
	\|\|RemoveColumns (SqlDataFrame)		\|\|RemoveColumns (SqlDataFrame)
	\|\|Column names (string array)		\|\|Column names (string array)
			\|\|Same functionality as in the [[DataFrame_in_Expression_Language\|DataFrame]].
			\|-
			\|\|RenameColumns (SqlDataFrame)
			\|\|Key-value pairs of name mappings
			\|\|Same functionality as in the [[DataFrame_in_Expression_Language\|DataFrame]].
			\|-
			\|\|RenameAllColumns (SqlDataFrame)
			\|\|Template string
	\|\|Same functionality as in the [[DataFrame_in_Expression_Language\|DataFrame]].		\|\|Same functionality as in the [[DataFrame_in_Expression_Language\|DataFrame]].
	\|-		\|-