| Package | Description |
|---|---|
| com.snowflake.snowpark_java |
Provides most of the classes for the Snowpark Java API.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CaseExpr
Represents a CASE
expression.
|
| Modifier and Type | Method and Description |
|---|---|
static Column |
Functions.abs(Column col)
Returns the absolute value of a numeric expression.
|
static Column |
Functions.acos(Column col)
Computes the inverse cosine (arc cosine) of its input; the result is a number in the interval
[-pi, pi].
|
static Column |
Functions.add_months(Column startDate,
Column numMonths)
Adds or subtracts a specified number of months to a date or timestamp, preserving the
end-of-month information.
|
Column |
Column.alias(String alias)
Retrieves s new renamed Column.
|
Column |
Column.and(Column other)
And.
|
static Column |
Functions.any_value(Column e)
Returns a non-deterministic value for the specified column.
|
Column |
UserDefinedFunction.apply(Column... exprs)
Apply the UDF to one or more columns to generate a Column expression.
|
static Column |
Functions.approx_count_distinct(Column col)
Uses HyperLogLog to return an approximation of the distinct cardinality of the input (i.e.
|
static Column |
Functions.approx_percentile_accumulate(Column col)
Returns the internal representation of the t-Digest state (as a JSON object) at the end of
aggregation.
|
static Column |
Functions.approx_percentile_combine(Column state)
Combines (merges) percentile input states into a single output state.
|
static Column |
Functions.approx_percentile_estimate(Column col,
double percentile)
Returns the desired approximated percentile value for the specified t-Digest state.
|
static Column |
Functions.approx_percentile(Column col,
double percentile)
Returns an approximated value for the desired percentile.
|
static Column |
Functions.array_agg(Column col)
Returns the input values, pivoted into an ARRAY.
|
static Column |
Functions.array_append(Column array,
Column element)
Returns an ARRAY containing all elements from the source ARRAYas well as the new element.
|
static Column |
Functions.array_cat(Column array1,
Column array2)
Returns the concatenation of two ARRAYs.
|
static Column |
Functions.array_compact(Column array)
Returns a compacted ARRAY with missing and null values removed, effectively converting sparse
arrays into dense arrays.
|
static Column |
Functions.array_construct_compact(Column... cols)
Returns an ARRAY constructed from zero, one, or more inputs; the constructed ARRAY omits any
NULL input values.
|
static Column |
Functions.array_construct(Column... cols)
Returns an ARRAY constructed from zero, one, or more inputs.
|
static Column |
Functions.array_contains(Column variant,
Column array)
Returns
true if the specified VARIANT is found in the specified ARRAY. |
static Column |
Functions.array_insert(Column array,
Column pos,
Column element)
Returns an ARRAY containing all elements from the source ARRAY as well as the new element.
|
static Column |
Functions.array_intersection(Column col1,
Column col2)
Returns an ARRAY that contains the matching elements in the two input ARRAYs.
|
static Column |
Functions.array_position(Column variant,
Column array)
Returns the index of the first occurrence of an element in an ARRAY.
|
static Column |
Functions.array_prepend(Column array,
Column element)
Returns an ARRAY containing the new element as well as all elements from the source ARRAY.
|
static Column |
Functions.array_size(Column array)
Returns the size of the input ARRAY.
|
static Column |
Functions.array_slice(Column array,
Column from,
Column to)
Returns an ARRAY constructed from a specified subset of elements of the input ARRAY.
|
static Column |
Functions.array_to_string(Column array,
Column separator)
Returns an input ARRAY converted to a string by casting all values to strings (using
TO_VARCHAR) and concatenating them (using the string from the second argument to separate the
elements).
|
static Column |
Functions.arrays_overlap(Column a1,
Column a2)
Compares whether two arrays have at least one element in common.
|
static Column |
Functions.as_array(Column variant)
Casts a VARIANT value to an array.
|
static Column |
Functions.as_binary(Column variant)
Casts a VARIANT value to a binary string.
|
static Column |
Functions.as_char(Column variant)
Casts a VARIANT value to a string.
|
static Column |
Functions.as_date(Column variant)
Casts a VARIANT value to a date.
|
static Column |
Functions.as_decimal(Column variant)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values).
|
static Column |
Functions.as_decimal(Column variant,
int precision)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values), with
precision.
|
static Column |
Functions.as_decimal(Column variant,
int precision,
int scale)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values), with
precision and scale.
|
static Column |
Functions.as_double(Column variant)
Casts a VARIANT value to a floating-point value.
|
static Column |
Functions.as_integer(Column variant)
Casts a VARIANT value to an integer.
|
static Column |
Functions.as_number(Column variant)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values).
|
static Column |
Functions.as_number(Column variant,
int precision)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values), with
precision and scale.
|
static Column |
Functions.as_number(Column variant,
int precision,
int scale)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values), with
precision.
|
static Column |
Functions.as_object(Column variant)
Casts a VARIANT value to an object.
|
static Column |
Functions.as_real(Column variant)
Casts a VARIANT value to a floating-point value.
|
static Column |
Functions.as_time(Column variant)
Casts a VARIANT value to a time value.
|
static Column |
Functions.as_timestamp_ltz(Column variant)
Casts a VARIANT value to a TIMESTAMP value with local timezone.
|
static Column |
Functions.as_timestamp_ntz(Column variant)
Casts a VARIANT value to a TIMESTAMP value with no timezone.
|
static Column |
Functions.as_timestamp_tz(Column variant)
Casts a VARIANT value to a TIMESTAMP value with timezone.
|
static Column |
Functions.as_varchar(Column variant)
Casts a VARIANT value to a string.
|
Column |
Column.as(String alias)
Retrieves s new renamed Column.
|
Column |
Column.asc_nulls_first()
Sorts this column in ascending order, null values sorted before non-null values.
|
Column |
Column.asc_nulls_last()
Sorts this column in ascending order, null values sorted after non-null values.
|
Column |
Column.asc()
Sorts this column in ascending order.
|
static Column |
Functions.ascii(Column e)
Returns the ASCII code for the first character of a string.
|
static Column |
Functions.asin(Column col)
Computes the inverse sine (arc sine) of its argument; the result is a number in the interval
[-pi, pi].
|
static Column |
Functions.atan(Column col)
Computes the inverse tangent (arc tangent) of its argument; the result is a number in the
interval [-pi, pi].
|
static Column |
Functions.atan2(Column y,
Column x)
Computes the inverse tangent (arc tangent) of the ratio of its two arguments.
|
static Column |
Functions.avg(Column col)
Returns the average of non-NULL records.
|
Column |
Column.between(Column lowerBound,
Column upperBound)
Between lower bound (including) and upper bound (including).
|
Column |
Column.bitand(Column other)
Bitwise and.
|
static Column |
Functions.bitnot(Column col)
Returns the bitwise negation of a numeric expression.
|
Column |
Column.bitor(Column other)
Bitwise or.
|
static Column |
Functions.bitshiftleft(Column e,
Column numBits)
Shifts the bits for a numeric expression numBits positions to the left.
|
static Column |
Functions.bitshiftright(Column e,
Column numBits)
Shifts the bits for a numeric expression numBits positions to the right.
|
Column |
Column.bitxor(Column other)
Bitwise xor.
|
static Column |
Functions.callUDF(String udfName,
Column... cols)
Calls a user-defined function (UDF) by name.
|
Column |
Column.cast(DataType to)
Casts the values in the Column to the specified data type.
|
static Column |
Functions.ceil(Column col)
Returns values from the specified column rounded to the nearest equal or larger integer.
|
static Column |
Functions.charindex(Column targetExpr,
Column sourceExpr)
Searches for targetExpr in sourceExpr and, if successful, returns the position (1-based) of the
targetExpr in sourceExpr.
|
static Column |
Functions.charindex(Column targetExpr,
Column sourceExpr,
Column position)
Searches for targetExpr in sourceExpr and, if successful, returns the position (1-based) of the
targetExpr in sourceExpr.
|
static Column |
Functions.check_json(Column col)
Checks the validity of a JSON document.
|
static Column |
Functions.check_xml(Column col)
Checks the validity of an XML document.
|
static Column |
Functions.chr(Column col)
Converts a Unicode code point (including 7-bit ASCII) into the character that matches the input
Unicode.
|
static Column |
Functions.coalesce(Column... cols)
Returns the first non-NULL expression among its arguments, or NULL if all its arguments are
NULL.
|
static Column |
Functions.col(DataFrame df)
Generates a Column representing the result of the input DataFrame.
|
static Column |
Functions.col(String name)
Creates a Column with the specified name.
|
Column |
DataFrame.col(String colName)
Retrieves a reference to a column in this DataFrame.
|
static Column |
Functions.collate(Column expr,
String collationSpec)
Returns a copy of expr, but with the specified collationSpec property instead of the original
collation specification property.
|
Column |
Column.collate(String collateSpec)
Returns a copy of the original Column with the specified 'collateSpec` property, rather than
the original collation specification property.
|
static Column |
Functions.collation(Column expr)
Returns the collation specification of expr.
|
static Column |
Functions.concat_ws(Column separator,
Column... exprs)
Concatenates two or more strings, or concatenates two or more binary values.
|
static Column |
Functions.concat(Column... exprs)
Concatenates one or more strings, or concatenates one or more binary values.
|
static Column |
Functions.contains(Column col,
Column str)
Returns true if col contains str.
|
static Column |
Functions.convert_timezone(Column targetTimeZone,
Column sourceTimestamp)
Converts the given sourceTimestampNTZ to targetTimeZone.
|
static Column |
Functions.convert_timezone(Column sourceTimeZone,
Column targetTimeZone,
Column sourceTimestampNTZ)
Converts the given sourceTimestampNTZ from sourceTimeZone to targetTimeZone.
|
static Column |
Functions.corr(Column col1,
Column col2)
Returns the correlation coefficient for non-null pairs in a group.
|
static Column |
Functions.cos(Column col)
Computes the cosine of its argument; the argument should be expressed in radians.
|
static Column |
Functions.cosh(Column col)
Computes the hyperbolic cosine of its argument.
|
static Column |
Functions.count_distinct(Column first,
Column... remaining)
Returns either the number of non-NULL distinct records for the specified columns, or the total
number of the distinct records.
|
static Column |
Functions.count(Column col)
Returns either the number of non-NULL records for the specified columns, or the total number of
records.
|
static Column |
Functions.covar_pop(Column col1,
Column col2)
Calculates the population covariance for non-null pairs in a group.
|
static Column |
Functions.covar_samp(Column col1,
Column col2)
Calculates the sample covariance for non-null pairs in a group.
|
static Column |
Functions.cume_dist()
Finds the cumulative distribution of a value with regard to other values within the same window
partition.
|
static Column |
Functions.current_account()
Returns the account used by the user's current session.
|
static Column |
Functions.current_available_roles()
Returns a JSON string that lists all roles granted to the current user.
|
static Column |
Functions.current_database()
Returns the name of the database in use for the current session.
|
static Column |
Functions.current_date()
Returns the current date of the system.
|
static Column |
Functions.current_region()
Returns the name of the region for the account where the current user is logged in.
|
static Column |
Functions.current_role()
Returns the name of the role in use for the current session.
|
static Column |
Functions.current_schema()
Returns the name of the schema in use by the current session.
|
static Column |
Functions.current_schemas()
Returns active search path schemas.
|
static Column |
Functions.current_session()
Returns a unique system identifier for the Snowflake session corresponding to the present
connection.
|
static Column |
Functions.current_statement()
Returns the SQL text of the statement that is currently executing.
|
static Column |
Functions.current_time()
Returns the current time for the system.
|
static Column |
Functions.current_timestamp()
Returns the current timestamp for the system.
|
static Column |
Functions.current_user()
Returns the name of the user currently logged into the system.
|
static Column |
Functions.current_version()
Returns the current Snowflake version.
|
static Column |
Functions.current_warehouse()
Returns the name of the warehouse in use for the current session.
|
static Column |
Functions.date_from_parts(Column year,
Column month,
Column day)
Creates a date from individual numeric components that represent the year, month, and day of
the month.
|
static Column |
Functions.date_trunc(String format,
Column timestamp)
Truncates a DATE, TIME, or TIMESTAMP to the specified precision.
|
static Column |
Functions.dateadd(String part,
Column value,
Column expr)
Adds the specified value for the specified date or time art to date or time expr.
|
static Column |
Functions.datediff(String part,
Column col1,
Column col2)
Calculates the difference between two date, time, or timestamp columns based on the date or
time part requested.
|
static Column |
Functions.dayname(Column expr)
Extracts the three-letter day-of-week name from the specified date or timestamp.
|
static Column |
Functions.dayofmonth(Column e)
Extracts the day of month from a date or timestamp.
|
static Column |
Functions.dayofweek(Column e)
Extracts the day of week from a date or timestamp.
|
static Column |
Functions.dayofyear(Column e)
Extracts the day of year from a date or timestamp.
|
static Column |
Functions.degrees(Column e)
Converts radians to degrees.
|
static Column |
Functions.dense_rank()
Returns the rank of a value within a group of values, without gaps in the ranks.
|
Column |
Column.desc_nulls_first()
Sorts this column in descending order, null values sorted before non-null values.
|
Column |
Column.desc_nulls_last()
Sorts this column in descending order, null values sorted after non-null values.
|
Column |
Column.desc()
Sorts this column in descending order.
|
static Column |
Functions.div0(Column dividend,
Column divisor)
Performs division like the division operator (/), but returns 0 when the divisor is 0 (rather
than reporting an error).
|
Column |
Column.divide(Column other)
Divide
|
static Column |
Functions.endswith(Column expr,
Column str)
Returns TRUE if expr ends with str.
|
Column |
Column.equal_nan()
Is NaN.
|
static Column |
Functions.equal_nan(Column col)
Returns true if the value in the column is not a number (NaN).
|
Column |
Column.equal_null(Column other)
Equal to.
|
Column |
Column.equal_to(Column other)
Equal to.
|
static Column |
Functions.exp(Column col)
Computes Euler's number e raised to a floating-point value.
|
static Column |
Functions.factorial(Column col)
Computes the factorial of its input.
|
static Column |
Functions.floor(Column col)
Returns values from the specified column rounded to the nearest equal or smaller integer.
|
Column |
Column.geq(Column other)
Greater than or equal to.
|
static Column |
Functions.get_ignore_case(Column obj,
Column field)
Extracts a field value from an object; returns NULL if either of the arguments is NULL.
|
static Column |
Functions.get_path(Column col,
Column path)
Extracts a value from semi-structured data using a path name.
|
static Column |
Functions.get(Column col1,
Column col2)
Extracts a value from an object or array; returns NULL if either of the arguments is NULL.
|
static Column |
Functions.greatest(Column... cols)
Returns the largest value from a list of expressions.
|
static Column |
Functions.grouping_id(Column... cols)
Describes which of a list of expressions are grouped in a row produced by a GROUP BY query.
|
static Column |
Functions.grouping(Column col)
Describes which of a list of expressions are grouped in a row produced by a GROUP BY query.
|
Column |
Column.gt(Column other)
Greater than.
|
static Column |
Functions.hash(Column... cols)
Returns a signed 64-bit hash value.
|
static Column |
Functions.hour(Column e)
Extracts the hour from a date or timestamp.
|
static Column |
Functions.iff(Column condition,
Column expr1,
Column expr2)
Returns one of two specified expressions, depending on a condition.
|
static Column |
Functions.in(Column[] columns,
DataFrame df)
Returns a conditional expression that you can pass to the filter or where method to perform the
equivalent of a WHERE ...
|
static Column |
Functions.in(Column[] columns,
List<List<Object>> values)
Returns a conditional expression that you can pass to the filter or where method to perform the
equivalent of a WHERE ...
|
Column |
Column.in(DataFrame df)
Returns a conditional expression that you can pass to the filter or where method to perform a
WHERE ...
|
Column |
Column.in(Object... values)
Returns a conditional expression that you can pass to the filter or where method to perform the
equivalent of a WHERE ...
|
static Column |
Functions.initcap(Column e)
Returns the input string with the first letter of each word in uppercase and the subsequent
letters in lowercase.
|
static Column |
Functions.insert(Column baseExpr,
Column position,
Column length,
Column insertExpr)
Replaces a substring of the specified length, starting at the specified position, with a new
string or binary value.
|
static Column |
Functions.is_array(Column col)
Returns true if the specified VARIANT column contains an ARRAY value.
|
static Column |
Functions.is_binary(Column col)
Returns true if the specified VARIANT column contains a binary value.
|
static Column |
Functions.is_boolean(Column col)
Returns true if the specified VARIANT column contains a Boolean value.
|
static Column |
Functions.is_char(Column col)
Returns true if the specified VARIANT column contains a string value.
|
static Column |
Functions.is_date_value(Column col)
Returns true if the specified VARIANT column contains a DATE value.
|
static Column |
Functions.is_date(Column col)
Returns true if the specified VARIANT column contains a DATE value.
|
static Column |
Functions.is_decimal(Column col)
Returns true if the specified VARIANT column contains a fixed-point decimal value or integer.
|
static Column |
Functions.is_double(Column col)
Returns true if the specified VARIANT column contains a floating-point value, fixed-point
decimal, or integer.
|
static Column |
Functions.is_integer(Column col)
Returns true if the specified VARIANT column contains an integer value.
|
Column |
Column.is_not_null()
Is not null.
|
static Column |
Functions.is_null_value(Column col)
Returns true if the specified VARIANT column is a JSON null value.
|
Column |
Column.is_null()
Is null.
|
static Column |
Functions.is_null(Column col)
Returns true if the value in the column is null.
|
static Column |
Functions.is_object(Column col)
Returns true if the specified VARIANT column contains an OBJECT value.
|
static Column |
Functions.is_real(Column col)
Returns true if the specified VARIANT column contains a floating-point value, fixed-point
decimal, or integer.
|
static Column |
Functions.is_time(Column col)
Returns true if the specified VARIANT column contains a TIME value.
|
static Column |
Functions.is_timestamp_ltz(Column col)
Returns true if the specified VARIANT column contains a TIMESTAMP value to be interpreted using
the local time zone.
|
static Column |
Functions.is_timestamp_ntz(Column col)
Returns true if the specified VARIANT column contains a TIMESTAMP value with no time zone.
|
static Column |
Functions.is_timestamp_tz(Column col)
Returns true if the specified VARIANT column contains a TIMESTAMP value with a time zone.
|
static Column |
Functions.is_varchar(Column col)
Returns true if the specified VARIANT column contains a string value.
|
static Column |
Functions.json_extract_path_text(Column col,
Column path)
Parses a JSON string and returns the value of an element at a specified path in the resulting
JSON document.
|
static Column |
Functions.kurtosis(Column col)
Returns the population excess kurtosis of non-NULL records.
|
static Column |
Functions.lag(Column col)
Accesses data in a previous row in the same result set without having to join the table to
itself.
|
static Column |
Functions.lag(Column col,
int offset)
Accesses data in a previous row in the same result set without having to join the table to
itself.
|
static Column |
Functions.lag(Column col,
int offset,
Column defaultValue)
Accesses data in a previous row in the same result set without having to join the table to
itself.
|
static Column |
Functions.last_day(Column e)
Returns the last day of the specified date part for a date or timestamp.
|
static Column |
Functions.lead(Column col)
Accesses data in a subsequent row in the same result set without having to join the table to
itself.
|
static Column |
Functions.lead(Column col,
int offset)
Accesses data in a subsequent row in the same result set without having to join the table to
itself.
|
static Column |
Functions.lead(Column col,
int offset,
Column defaultValue)
Accesses data in a subsequent row in the same result set without having to join the table to
itself.
|
static Column |
Functions.least(Column... cols)
Returns the smallest value from a list of expressions.
|
static Column |
Functions.left(Column strExpr,
Column lengthExpr)
Returns a left most substring of strExpr.
|
static Column |
Functions.length(Column e)
Returns the length of an input string or binary value.
|
Column |
Column.leq(Column other)
Less than or equal to.
|
Column |
Column.like(Column pattern)
Allows case-sensitive matching of strings based on comparison with a pattern.
|
static Column |
Functions.listagg(Column col)
Returns the concatenated input values, separated by empty string.
|
static Column |
Functions.listagg(Column col,
String delimiter)
Returns the concatenated input values, separated by `delimiter` string.
|
static Column |
Functions.listagg(Column col,
String delimiter,
boolean isDistinct)
Returns the concatenated input values, separated by `delimiter` string.
|
static Column |
Functions.lit(Object literal)
Creates a Column expression for a literal value.
|
static Column |
Functions.log(Column base,
Column a)
Returns the logarithm of a numeric expression.
|
static Column |
Functions.lower(Column e)
Returns the input string with all characters converted to lowercase.
|
static Column |
Functions.lpad(Column str,
Column len,
Column pad)
Left-pads a string with characters from another string, or left-pads a binary value with bytes
from another binary value.
|
Column |
Column.lt(Column other)
Less than.
|
static Column |
Functions.ltrim(Column e)
Removes leading characters, including whitespace, from a string.
|
static Column |
Functions.ltrim(Column e,
Column trimString)
Removes leading characters, including whitespace, from a string.
|
static Column |
Functions.max(Column col)
Returns the maximum value for the records in a group.
|
static Column |
Functions.md5(Column e)
Returns a 32-character hex-encoded string containing the 128-bit MD5 message digest.
|
static Column |
Functions.mean(Column col)
Returns the average of non-NULL records.
|
static Column |
Functions.median(Column col)
Returns the median value for the records in a group.
|
static Column |
Functions.min(Column col)
Returns the minimum value for the records in a group.
|
Column |
Column.minus(Column other)
Minus
|
static Column |
Functions.minute(Column e)
Extracts the minute from a date or timestamp.
|
Column |
Column.mod(Column other)
Remainder
|
static Column |
Functions.month(Column e)
Extracts the month from a date or timestamp.
|
static Column |
Functions.monthname(Column expr)
Extracts the three-letter month name from the specified date or timestamp.
|
Column |
Column.multiply(Column other)
Multiply
|
static Column |
Functions.negate(Column col)
Returns the negation of the value in the column (equivalent to a unary minus).
|
static Column |
Functions.next_day(Column date,
Column dayOfWeek)
Returns the date of the first specified DOW (day of week) that occurs after the input date.
|
Column |
Column.not_equal(Column other)
Not equal to.
|
static Column |
Functions.not(Column col)
Returns the inverse of a boolean expression.
|
static Column |
Functions.ntile(Column col)
Divides an ordered data set equally into the number of buckets specified by n.
|
static Column |
Functions.object_construct(Column... key_values)
Returns an OBJECT constructed from the arguments.
|
static Column |
Functions.object_delete(Column obj,
Column key1,
Column... keys)
Returns an object containing the contents of the input (i.e.source) object with one or more
keys removed.
|
static Column |
Functions.object_insert(Column obj,
Column key,
Column value)
Returns an object consisting of the input object with a new key-value pair inserted.
|
static Column |
Functions.object_insert(Column obj,
Column key,
Column value,
Column update_flag)
Returns an object consisting of the input object with a new key-value pair inserted (or an
existing key updated with a new value).
|
static Column |
Functions.object_keys(Column obj)
Returns an array containing the list of keys in the input object.
|
static Column |
Functions.object_pick(Column obj,
Column key1,
Column... keys)
Returns a new OBJECT containing some of the key-value pairs from an existing object.
|
static Column |
Functions.objectagg(Column key,
Column value)
Returns one OBJECT per group.
|
Column |
Column.or(Column other)
Or.
|
Column |
CaseExpr.otherwise(Column value)
Sets the default result for this CASE expression.
|
Column |
Column.over()
Returns a windows frame, based on the specified WindowSpec.
|
Column |
Column.over(WindowSpec windowSpec)
Returns a windows frame, based on the specified WindowSpec.
|
static Column |
Functions.parse_json(Column col)
Parse the value of the specified column as a JSON string and returns the resulting JSON
document.
|
static Column |
Functions.parse_xml(Column col)
Parse the value of the specified column as a JSON string and returns the resulting XML
document.
|
static Column |
Functions.percent_rank()
Returns the relative rank of a value within a group of values, specified as a percentage
ranging from 0.0 to 1.0.
|
Column |
Column.plus(Column other)
Plus
|
static Column |
Functions.pow(Column l,
Column r)
Returns a number (l) raised to the specified power (r).
|
static Column |
Functions.previous_day(Column date,
Column dayOfWeek)
Returns the date of the first specified DOW (day of week) that occurs before the input date.
|
static Column |
Functions.quarter(Column e)
Extracts the quarter from a date or timestamp.
|
static Column |
Functions.radians(Column e)
Converts degrees to radians.
|
static Column |
Functions.random()
Each call returns a pseudo-random 64-bit integer.
|
static Column |
Functions.random(long seed)
Each call returns a pseudo-random 64-bit integer.
|
static Column |
Functions.rank()
Returns the rank of a value within an ordered group of values.
|
static Column |
Functions.regexp_count(Column strExpr,
Column pattern)
Returns the number of times that a pattern occurs in a strExpr.
|
static Column |
Functions.regexp_count(Column strExpr,
Column pattern,
Column position,
Column parameters)
Returns the number of times that a pattern occurs in a strExpr.
|
Column |
Column.regexp(Column pattern)
Returns true if this column matches the specified regular expression.
|
static Column |
Functions.repeat(Column str,
Column n)
Builds a string by repeating the input for the specified number of times.
|
static Column |
Functions.replace(Column strExpr,
Column pattern)
Removes all occurrences of a specified strExpr, and optionally replaces them with replacement.
|
static Column |
Functions.replace(Column strExpr,
Column pattern,
Column replacement)
Removes all occurrences of a specified strExpr, and optionally replaces them with replacement.
|
static Column |
Functions.right(Column strExpr,
Column lengthExpr)
Returns a right most substring of strExpr.
|
static Column |
Functions.round(Column e)
Returns rounded values for the specified column.
|
static Column |
Functions.round(Column e,
Column scale)
Returns rounded values for the specified column.
|
static Column |
Functions.row_number()
Returns a unique row number for each row within a window partition.
|
static Column |
Functions.rpad(Column str,
Column len,
Column pad)
Right-pads a string with characters from another string, or right-pads a binary value with
bytes from another binary value.
|
static Column |
Functions.rtrim(Column e)
Removes trailing characters, including whitespace, from a string.
|
static Column |
Functions.rtrim(Column e,
Column trimString)
Removes trailing characters, including whitespace, from a string.
|
static Column |
Functions.second(Column e)
Extracts the second from a date or timestamp.
|
static Column |
Functions.seq1()
Generates a sequence of monotonically increasing integers, with wrap-around.
|
static Column |
Functions.seq1(boolean startsFromZero)
Generates a sequence of monotonically increasing integers, with wrap-around.
|
static Column |
Functions.seq2()
Generates a sequence of monotonically increasing integers, with wrap-around.
|
static Column |
Functions.seq2(boolean startsFromZero)
Generates a sequence of monotonically increasing integers, with wrap-around.
|
static Column |
Functions.seq4()
Generates a sequence of monotonically increasing integers, with wrap-around.
|
static Column |
Functions.seq4(boolean startsFromZero)
Generates a sequence of monotonically increasing integers, with wrap-around.
|
static Column |
Functions.seq8()
Generates a sequence of monotonically increasing integers, with wrap-around.
|
static Column |
Functions.seq8(boolean startsFromZero)
Generates a sequence of monotonically increasing integers, with wrap-around.
|
static Column |
Functions.sha1(Column e)
Returns a 40-character hex-encoded string containing the 160-bit SHA-1 message digest.
|
static Column |
Functions.sha2(Column e,
int numBits)
Returns a hex-encoded string containing the N-bit SHA-2 message digest, where N is the
specified output digest size.
|
static Column |
Functions.sin(Column e)
Computes the sine of its argument; the argument should be expressed in radians.
|
static Column |
Functions.sinh(Column e)
Computes the hyperbolic sine of its argument.
|
static Column |
Functions.skew(Column col)
Returns the sample skewness of non-NULL records.
|
static Column |
Functions.soundex(Column e)
Returns a string that contains a phonetic representation of the input string.
|
static Column |
Functions.split(Column str,
Column pattern)
Splits a given string with a given separator and returns the result in an array of strings.
|
static Column |
Functions.sqlExpr(String sqlText)
Creates a Column expression from row SQL text.
|
static Column |
Functions.sqrt(Column col)
Returns the square-root of a non-negative numeric expression.
|
static Column |
Functions.startswith(Column col,
Column str)
Returns true if col starts with str.
|
static Column |
Functions.stddev_pop(Column col)
Returns the population standard deviation (square root of variance) of non-NULL values.
|
static Column |
Functions.stddev_samp(Column col)
Returns the sample standard deviation (square root of sample variance) of non-NULL values.
|
static Column |
Functions.stddev(Column col)
Returns the sample standard deviation (square root of sample variance) of non-NULL values.
|
static Column |
Functions.strip_null_value(Column col)
Converts a JSON "null" value in the specified column to a SQL NULL value.
|
static Column |
Functions.strtok_to_array(Column array)
Tokenizes the given string using the given set of delimiters and returns the tokens as an
array.
|
static Column |
Functions.strtok_to_array(Column array,
Column delimiter)
Tokenizes the given string using the given set of delimiters and returns the tokens as an
array.
|
Column |
Column.subField(int index)
Retrieves the element (field) at the specified index in a column that contains semi-structured
data.
|
Column |
Column.subField(String field)
Retrieves the specified element (field) in a column that contains semi-structured
data.
|
static Column |
Functions.substring(Column str,
Column pos,
Column len)
Returns the portion of the string or binary value str, starting from the character/byte
specified by pos, with limited length.
|
static Column |
Functions.sum_distinct(Column col)
Returns the sum of non-NULL distinct records in a group.
|
static Column |
Functions.sum(Column col)
Returns the sum of non-NULL records in a group.
|
static Column |
Functions.sysdate()
Returns the current timestamp for the system, but in the UTC time zone.
|
static Column |
Functions.tan(Column e)
Computes the tangent of its argument; the argument should be expressed in radians.
|
static Column |
Functions.tanh(Column e)
Computes the hyperbolic tangent of its argument.
|
static Column |
Functions.time_from_parts(Column hour,
Column minute,
Column second)
Creates a time from individual numeric components.
|
static Column |
Functions.time_from_parts(Column hour,
Column minute,
Column second,
Column nanosecond)
Creates a time from individual numeric components.
|
static Column |
Functions.timestamp_from_parts(Column dateExpr,
Column timeExpr)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second,
Column nanosecond)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_ltz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_ltz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second,
Column nanosecond)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_ntz_from_parts(Column dateExpr,
Column timeExpr)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_ntz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_ntz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second,
Column nanosecond)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_tz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_tz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second,
Column nanosecond)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_tz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second,
Column nanosecond,
Column timezone)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.to_array(Column col)
Converts the input expression into an array:
|
static Column |
Functions.to_date(Column e)
Converts an input expression to a date.
|
static Column |
Functions.to_date(Column e,
Column fmt)
Converts an input expression to a date.
|
static Column |
Functions.to_decimal(Column expr,
int precision,
int scale)
Converts an input expression to a decimal
|
static Column |
Functions.to_json(Column col)
Converts any VARIANT value to a string containing the JSON representation of the value.
|
static Column |
Functions.to_object(Column col)
Converts the input value to an object:
|
static Column |
Functions.to_timestamp(Column s)
Converts an input expression into the corresponding timestamp.
|
static Column |
Functions.to_timestamp(Column s,
Column fmt)
Converts an input expression into the corresponding timestamp.
|
static Column |
Functions.to_variant(Column col)
Converts any value to VARIANT value or NULL (if input is NULL).
|
static Column |
Functions.to_xml(Column col)
Converts any VARIANT value to a string containing the XML representation of the value.
|
static Column |
Functions.toScalar(DataFrame df)
Generates a Column representing the result of the input DataFrame.
|
static Column |
Functions.translate(Column src,
Column matchingString,
Column replaceString)
Translates src from the characters in matchingString to the characters in replaceString.
|
static Column |
Functions.trim(Column e,
Column trimString)
Removes leading and trailing characters from a string.
|
static Column |
Functions.trunc(Column expr,
Column scale)
Rounds the input expression down to the nearest (or equal) integer closer to zero, or to the
nearest equal or smaller value with the specified number of places after the decimal point.
|
Column |
Column.unary_minus()
Unary minus.
|
Column |
Column.unary_not()
Unary not.
|
static Column |
Functions.uniform(Column min,
Column max,
Column gen)
Returns a uniformly random number, in the inclusive range (`min`, `max`)
|
static Column |
Functions.upper(Column e)
Returns the input string with all characters converted to uppercase.
|
static Column |
Functions.var_pop(Column col)
Returns the population variance of non-NULL records in a group.
|
static Column |
Functions.var_samp(Column col)
Returns the sample variance of non-NULL records in a group.
|
static Column |
Functions.variance(Column col)
Returns the sample variance of non-NULL records in a group.
|
static Column |
Functions.weekofyear(Column e)
Extracts the week of year from a date or timestamp.
|
Column |
Column.withinGroup(Column... cols)
Returns a Column expression that adds a WITHIN GROUP clause to sort the rows by the specified
sequence of columns.
|
static Column |
Functions.xmlget(Column xml,
Column tag)
Extracts the first XML element object (often referred to as simply a tag) from a content of
outer XML element object by the name of the tag
|
static Column |
Functions.xmlget(Column xml,
Column tag,
Column instance)
Extracts an XML element object (often referred to as simply a tag) from a content of outer XML
element object by the name of the tag and its instance number (counting from 0).
|
static Column |
Functions.year(Column e)
Extracts the year from a date or timestamp.
|
| Modifier and Type | Method and Description |
|---|---|
static Column |
Functions.abs(Column col)
Returns the absolute value of a numeric expression.
|
static Column |
Functions.acos(Column col)
Computes the inverse cosine (arc cosine) of its input; the result is a number in the interval
[-pi, pi].
|
static Column |
Functions.add_months(Column startDate,
Column numMonths)
Adds or subtracts a specified number of months to a date or timestamp, preserving the
end-of-month information.
|
DataFrame |
RelationalGroupedDataFrame.agg(Column... cols)
Returns a DataFrame with aggregated computed according to the supplied Column expressions.
|
DataFrame |
DataFrame.agg(Column... exprs)
Aggregate the data in the DataFrame.
|
Column |
Column.and(Column other)
And.
|
DataFrame |
RelationalGroupedDataFrame.any_value(Column... cols)
Returns non-deterministic values for the specified columns.
|
static Column |
Functions.any_value(Column e)
Returns a non-deterministic value for the specified column.
|
Column |
UserDefinedFunction.apply(Column... exprs)
Apply the UDF to one or more columns to generate a Column expression.
|
static Column |
Functions.approx_count_distinct(Column col)
Uses HyperLogLog to return an approximation of the distinct cardinality of the input (i.e.
|
static Column |
Functions.approx_percentile_accumulate(Column col)
Returns the internal representation of the t-Digest state (as a JSON object) at the end of
aggregation.
|
static Column |
Functions.approx_percentile_combine(Column state)
Combines (merges) percentile input states into a single output state.
|
static Column |
Functions.approx_percentile_estimate(Column col,
double percentile)
Returns the desired approximated percentile value for the specified t-Digest state.
|
static Column |
Functions.approx_percentile(Column col,
double percentile)
Returns an approximated value for the desired percentile.
|
static Column |
Functions.array_agg(Column col)
Returns the input values, pivoted into an ARRAY.
|
static Column |
Functions.array_append(Column array,
Column element)
Returns an ARRAY containing all elements from the source ARRAYas well as the new element.
|
static Column |
Functions.array_cat(Column array1,
Column array2)
Returns the concatenation of two ARRAYs.
|
static Column |
Functions.array_compact(Column array)
Returns a compacted ARRAY with missing and null values removed, effectively converting sparse
arrays into dense arrays.
|
static Column |
Functions.array_construct_compact(Column... cols)
Returns an ARRAY constructed from zero, one, or more inputs; the constructed ARRAY omits any
NULL input values.
|
static Column |
Functions.array_construct(Column... cols)
Returns an ARRAY constructed from zero, one, or more inputs.
|
static Column |
Functions.array_contains(Column variant,
Column array)
Returns
true if the specified VARIANT is found in the specified ARRAY. |
static Column |
Functions.array_insert(Column array,
Column pos,
Column element)
Returns an ARRAY containing all elements from the source ARRAY as well as the new element.
|
static Column |
Functions.array_intersection(Column col1,
Column col2)
Returns an ARRAY that contains the matching elements in the two input ARRAYs.
|
static Column |
Functions.array_position(Column variant,
Column array)
Returns the index of the first occurrence of an element in an ARRAY.
|
static Column |
Functions.array_prepend(Column array,
Column element)
Returns an ARRAY containing the new element as well as all elements from the source ARRAY.
|
static Column |
Functions.array_size(Column array)
Returns the size of the input ARRAY.
|
static Column |
Functions.array_slice(Column array,
Column from,
Column to)
Returns an ARRAY constructed from a specified subset of elements of the input ARRAY.
|
static Column |
Functions.array_to_string(Column array,
Column separator)
Returns an input ARRAY converted to a string by casting all values to strings (using
TO_VARCHAR) and concatenating them (using the string from the second argument to separate the
elements).
|
static Column |
Functions.arrays_overlap(Column a1,
Column a2)
Compares whether two arrays have at least one element in common.
|
static Column |
Functions.as_array(Column variant)
Casts a VARIANT value to an array.
|
static Column |
Functions.as_binary(Column variant)
Casts a VARIANT value to a binary string.
|
static Column |
Functions.as_char(Column variant)
Casts a VARIANT value to a string.
|
static Column |
Functions.as_date(Column variant)
Casts a VARIANT value to a date.
|
static Column |
Functions.as_decimal(Column variant)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values).
|
static Column |
Functions.as_decimal(Column variant,
int precision)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values), with
precision.
|
static Column |
Functions.as_decimal(Column variant,
int precision,
int scale)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values), with
precision and scale.
|
static Column |
Functions.as_double(Column variant)
Casts a VARIANT value to a floating-point value.
|
static Column |
Functions.as_integer(Column variant)
Casts a VARIANT value to an integer.
|
static Column |
Functions.as_number(Column variant)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values).
|
static Column |
Functions.as_number(Column variant,
int precision)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values), with
precision and scale.
|
static Column |
Functions.as_number(Column variant,
int precision,
int scale)
Casts a VARIANT value to a fixed-point decimal (does not match floating-point values), with
precision.
|
static Column |
Functions.as_object(Column variant)
Casts a VARIANT value to an object.
|
static Column |
Functions.as_real(Column variant)
Casts a VARIANT value to a floating-point value.
|
static Column |
Functions.as_time(Column variant)
Casts a VARIANT value to a time value.
|
static Column |
Functions.as_timestamp_ltz(Column variant)
Casts a VARIANT value to a TIMESTAMP value with local timezone.
|
static Column |
Functions.as_timestamp_ntz(Column variant)
Casts a VARIANT value to a TIMESTAMP value with no timezone.
|
static Column |
Functions.as_timestamp_tz(Column variant)
Casts a VARIANT value to a TIMESTAMP value with timezone.
|
static Column |
Functions.as_varchar(Column variant)
Casts a VARIANT value to a string.
|
static Column |
Functions.ascii(Column e)
Returns the ASCII code for the first character of a string.
|
static Column |
Functions.asin(Column col)
Computes the inverse sine (arc sine) of its argument; the result is a number in the interval
[-pi, pi].
|
static Column |
Functions.atan(Column col)
Computes the inverse tangent (arc tangent) of its argument; the result is a number in the
interval [-pi, pi].
|
static Column |
Functions.atan2(Column y,
Column x)
Computes the inverse tangent (arc tangent) of the ratio of its two arguments.
|
DataFrame |
RelationalGroupedDataFrame.avg(Column... cols)
Return the average for the specified numeric columns.
|
static Column |
Functions.avg(Column col)
Returns the average of non-NULL records.
|
Column |
Column.between(Column lowerBound,
Column upperBound)
Between lower bound (including) and upper bound (including).
|
Column |
Column.bitand(Column other)
Bitwise and.
|
static Column |
Functions.bitnot(Column col)
Returns the bitwise negation of a numeric expression.
|
Column |
Column.bitor(Column other)
Bitwise or.
|
static Column |
Functions.bitshiftleft(Column e,
Column numBits)
Shifts the bits for a numeric expression numBits positions to the left.
|
static Column |
Functions.bitshiftright(Column e,
Column numBits)
Shifts the bits for a numeric expression numBits positions to the right.
|
Column |
Column.bitxor(Column other)
Bitwise xor.
|
DataFrame |
RelationalGroupedDataFrame.builtin(String aggName,
Column... cols)
Computes the builtin aggregate 'aggName' over the specified columns.
|
static Column |
Functions.callUDF(String udfName,
Column... cols)
Calls a user-defined function (UDF) by name.
|
static Column |
Functions.ceil(Column col)
Returns values from the specified column rounded to the nearest equal or larger integer.
|
static Column |
Functions.charindex(Column targetExpr,
Column sourceExpr)
Searches for targetExpr in sourceExpr and, if successful, returns the position (1-based) of the
targetExpr in sourceExpr.
|
static Column |
Functions.charindex(Column targetExpr,
Column sourceExpr,
Column position)
Searches for targetExpr in sourceExpr and, if successful, returns the position (1-based) of the
targetExpr in sourceExpr.
|
static Column |
Functions.check_json(Column col)
Checks the validity of a JSON document.
|
static Column |
Functions.check_xml(Column col)
Checks the validity of an XML document.
|
static Column |
Functions.chr(Column col)
Converts a Unicode code point (including 7-bit ASCII) into the character that matches the input
Unicode.
|
static Column |
Functions.coalesce(Column... cols)
Returns the first non-NULL expression among its arguments, or NULL if all its arguments are
NULL.
|
static Column |
Functions.collate(Column expr,
String collationSpec)
Returns a copy of expr, but with the specified collationSpec property instead of the original
collation specification property.
|
static Column |
Functions.collation(Column expr)
Returns the collation specification of expr.
|
static Column |
Functions.concat_ws(Column separator,
Column... exprs)
Concatenates two or more strings, or concatenates two or more binary values.
|
static Column |
Functions.concat_ws(Column separator,
Column... exprs)
Concatenates two or more strings, or concatenates two or more binary values.
|
static Column |
Functions.concat(Column... exprs)
Concatenates one or more strings, or concatenates one or more binary values.
|
static Column |
Functions.contains(Column col,
Column str)
Returns true if col contains str.
|
static Column |
Functions.convert_timezone(Column targetTimeZone,
Column sourceTimestamp)
Converts the given sourceTimestampNTZ to targetTimeZone.
|
static Column |
Functions.convert_timezone(Column sourceTimeZone,
Column targetTimeZone,
Column sourceTimestampNTZ)
Converts the given sourceTimestampNTZ from sourceTimeZone to targetTimeZone.
|
TypedAsyncJob<Void> |
CopyableDataFrameAsyncActor.copyInto(String tableName,
Column[] transformations)
Executes `CopyableDataFrame.copyInto` asynchronously.
|
void |
CopyableDataFrame.copyInto(String tableName,
Column[] transformations)
Executes a `COPY INTO 'table_name'` command with the specified transformations to load data
from files in a stage into a specified table.
|
TypedAsyncJob<Void> |
CopyableDataFrameAsyncActor.copyInto(String tableName,
Column[] transformations,
Map<String,?> options)
Executes `CopyableDataFrame.copyInto` asynchronously.
|
void |
CopyableDataFrame.copyInto(String tableName,
Column[] transformations,
Map<String,?> options)
Executes a `COPY INTO 'table_name'` command with the specified transformations to load data
from files in a stage into a specified table.
|
TypedAsyncJob<Void> |
CopyableDataFrameAsyncActor.copyInto(String tableName,
String[] targetColumnNames,
Column[] transformations,
Map<String,?> options)
Executes `CopyableDataFrame.copyInto` asynchronously.
|
void |
CopyableDataFrame.copyInto(String tableName,
String[] targetColumnNames,
Column[] transformations,
Map<String,?> options)
Executes a `COPY INTO 'table_name'` command with the specified transformations to load data
from files in a stage into a specified table.
|
static Column |
Functions.corr(Column col1,
Column col2)
Returns the correlation coefficient for non-null pairs in a group.
|
static Column |
Functions.cos(Column col)
Computes the cosine of its argument; the argument should be expressed in radians.
|
static Column |
Functions.cosh(Column col)
Computes the hyperbolic cosine of its argument.
|
static Column |
Functions.count_distinct(Column first,
Column... remaining)
Returns either the number of non-NULL distinct records for the specified columns, or the total
number of the distinct records.
|
static Column |
Functions.count_distinct(Column first,
Column... remaining)
Returns either the number of non-NULL distinct records for the specified columns, or the total
number of the distinct records.
|
static Column |
Functions.count(Column col)
Returns either the number of non-NULL records for the specified columns, or the total number of
records.
|
static Column |
Functions.covar_pop(Column col1,
Column col2)
Calculates the population covariance for non-null pairs in a group.
|
static Column |
Functions.covar_samp(Column col1,
Column col2)
Calculates the sample covariance for non-null pairs in a group.
|
RelationalGroupedDataFrame |
DataFrame.cube(Column... cols)
Performs an SQL GROUP BY
CUBE on the DataFrame.
|
static Column |
Functions.date_from_parts(Column year,
Column month,
Column day)
Creates a date from individual numeric components that represent the year, month, and day of
the month.
|
static Column |
Functions.date_trunc(String format,
Column timestamp)
Truncates a DATE, TIME, or TIMESTAMP to the specified precision.
|
static Column |
Functions.dateadd(String part,
Column value,
Column expr)
Adds the specified value for the specified date or time art to date or time expr.
|
static Column |
Functions.datediff(String part,
Column col1,
Column col2)
Calculates the difference between two date, time, or timestamp columns based on the date or
time part requested.
|
static Column |
Functions.dayname(Column expr)
Extracts the three-letter day-of-week name from the specified date or timestamp.
|
static Column |
Functions.dayofmonth(Column e)
Extracts the day of month from a date or timestamp.
|
static Column |
Functions.dayofweek(Column e)
Extracts the day of week from a date or timestamp.
|
static Column |
Functions.dayofyear(Column e)
Extracts the day of year from a date or timestamp.
|
static Column |
Functions.degrees(Column e)
Converts radians to degrees.
|
TypedAsyncJob<DeleteResult> |
UpdatableAsyncActor.delete(Column condition)
Executes `Updatable.delete` asynchronously.
|
DeleteResult |
Updatable.delete(Column condition)
Deletes all rows in the updatable that satisfy specified condition and returns a
DeleteResult, representing number of rows deleted. |
TypedAsyncJob<DeleteResult> |
UpdatableAsyncActor.delete(Column condition,
DataFrame sourceData)
Executes `Updatable.delete` asynchronously.
|
DeleteResult |
Updatable.delete(Column condition,
DataFrame sourceData)
Deletes all rows in the updatable that satisfy specified condition where condition includes
columns in other
DataFrame, and returns a DeleteResult, representing number of
rows deleted. |
static Column |
Functions.div0(Column dividend,
Column divisor)
Performs division like the division operator (/), but returns 0 when the divisor is 0 (rather
than reporting an error).
|
Column |
Column.divide(Column other)
Divide
|
DataFrame |
DataFrame.drop(Column... columns)
Returns a new DataFrame that excludes the columns with the specified names from the output.
|
static Column |
Functions.endswith(Column expr,
Column str)
Returns TRUE if expr ends with str.
|
static Column |
Functions.equal_nan(Column col)
Returns true if the value in the column is not a number (NaN).
|
Column |
Column.equal_null(Column other)
Equal to.
|
Column |
Column.equal_to(Column other)
Equal to.
|
static Column |
Functions.exp(Column col)
Computes Euler's number e raised to a floating-point value.
|
static Column |
Functions.factorial(Column col)
Computes the factorial of its input.
|
DataFrame |
DataFrame.filter(Column condition)
Filters rows based on the specified conditional expression (similar to WHERE in SQL).
|
DataFrame |
Session.flatten(Column input)
Creates a new DataFrame by flattening compound values into multiple rows.
|
DataFrame |
DataFrame.flatten(Column input)
Flattens (explodes) compound values into multiple rows (similar to the SQL FLATTEN
|
DataFrame |
Session.flatten(Column input,
String path,
boolean outer,
boolean recursive,
String mode)
Creates a new DataFrame by flattening compound values into multiple rows.
|
DataFrame |
DataFrame.flatten(Column input,
String path,
boolean outer,
boolean recursive,
String mode)
Flattens (explodes) compound values into multiple rows (similar to the SQL FLATTEN
|
static Column |
Functions.floor(Column col)
Returns values from the specified column rounded to the nearest equal or smaller integer.
|
DataFrame |
Session.generator(long rowCount,
Column... columns)
Creates a new DataFrame via Generator function.
|
Column |
Column.geq(Column other)
Greater than or equal to.
|
static Column |
Functions.get_ignore_case(Column obj,
Column field)
Extracts a field value from an object; returns NULL if either of the arguments is NULL.
|
static Column |
Functions.get_path(Column col,
Column path)
Extracts a value from semi-structured data using a path name.
|
static Column |
Functions.get(Column col1,
Column col2)
Extracts a value from an object or array; returns NULL if either of the arguments is NULL.
|
static Column |
Functions.greatest(Column... cols)
Returns the largest value from a list of expressions.
|
RelationalGroupedDataFrame |
DataFrame.groupBy(Column... cols)
Groups rows by the columns specified by expressions (similar to GROUP BY in SQL).
|
static Column |
Functions.grouping_id(Column... cols)
Describes which of a list of expressions are grouped in a row produced by a GROUP BY query.
|
static Column |
Functions.grouping(Column col)
Describes which of a list of expressions are grouped in a row produced by a GROUP BY query.
|
Column |
Column.gt(Column other)
Greater than.
|
static Column |
Functions.hash(Column... cols)
Returns a signed 64-bit hash value.
|
static Column |
Functions.hour(Column e)
Extracts the hour from a date or timestamp.
|
static Column |
Functions.iff(Column condition,
Column expr1,
Column expr2)
Returns one of two specified expressions, depending on a condition.
|
static Column |
Functions.in(Column[] columns,
DataFrame df)
Returns a conditional expression that you can pass to the filter or where method to perform the
equivalent of a WHERE ...
|
static Column |
Functions.in(Column[] columns,
List<List<Object>> values)
Returns a conditional expression that you can pass to the filter or where method to perform the
equivalent of a WHERE ...
|
static Column |
Functions.initcap(Column e)
Returns the input string with the first letter of each word in uppercase and the subsequent
letters in lowercase.
|
MergeBuilder |
NotMatchedClauseBuilder.insert(Column[] values)
Defines an insert action for the not matched clause, when a row in source is not matched,
insert a row in target with 'values'.
|
static Column |
Functions.insert(Column baseExpr,
Column position,
Column length,
Column insertExpr)
Replaces a substring of the specified length, starting at the specified position, with a new
string or binary value.
|
static Column |
Functions.is_array(Column col)
Returns true if the specified VARIANT column contains an ARRAY value.
|
static Column |
Functions.is_binary(Column col)
Returns true if the specified VARIANT column contains a binary value.
|
static Column |
Functions.is_boolean(Column col)
Returns true if the specified VARIANT column contains a Boolean value.
|
static Column |
Functions.is_char(Column col)
Returns true if the specified VARIANT column contains a string value.
|
static Column |
Functions.is_date_value(Column col)
Returns true if the specified VARIANT column contains a DATE value.
|
static Column |
Functions.is_date(Column col)
Returns true if the specified VARIANT column contains a DATE value.
|
static Column |
Functions.is_decimal(Column col)
Returns true if the specified VARIANT column contains a fixed-point decimal value or integer.
|
static Column |
Functions.is_double(Column col)
Returns true if the specified VARIANT column contains a floating-point value, fixed-point
decimal, or integer.
|
static Column |
Functions.is_integer(Column col)
Returns true if the specified VARIANT column contains an integer value.
|
static Column |
Functions.is_null_value(Column col)
Returns true if the specified VARIANT column is a JSON null value.
|
static Column |
Functions.is_null(Column col)
Returns true if the value in the column is null.
|
static Column |
Functions.is_object(Column col)
Returns true if the specified VARIANT column contains an OBJECT value.
|
static Column |
Functions.is_real(Column col)
Returns true if the specified VARIANT column contains a floating-point value, fixed-point
decimal, or integer.
|
static Column |
Functions.is_time(Column col)
Returns true if the specified VARIANT column contains a TIME value.
|
static Column |
Functions.is_timestamp_ltz(Column col)
Returns true if the specified VARIANT column contains a TIMESTAMP value to be interpreted using
the local time zone.
|
static Column |
Functions.is_timestamp_ntz(Column col)
Returns true if the specified VARIANT column contains a TIMESTAMP value with no time zone.
|
static Column |
Functions.is_timestamp_tz(Column col)
Returns true if the specified VARIANT column contains a TIMESTAMP value with a time zone.
|
static Column |
Functions.is_varchar(Column col)
Returns true if the specified VARIANT column contains a string value.
|
DataFrame |
DataFrame.join(DataFrame right,
Column joinExpr)
Performs a default inner join of the current DataFrame and another DataFrame (`right`) using
the join condition specified in an expression (`joinExpr`).
|
DataFrame |
DataFrame.join(DataFrame right,
Column joinExpr,
String joinType)
Performs a join of the specified type (`joinType`) with the current DataFrame and another
DataFrame (`right`) using the join condition specified in an expression (`joinExpr`).
|
DataFrame |
DataFrame.join(TableFunction func,
Column... args)
Joins the current DataFrame with the output of the specified table function `func`.
|
static Column |
Functions.json_extract_path_text(Column col,
Column path)
Parses a JSON string and returns the value of an element at a specified path in the resulting
JSON document.
|
static Column |
Functions.kurtosis(Column col)
Returns the population excess kurtosis of non-NULL records.
|
static Column |
Functions.lag(Column col)
Accesses data in a previous row in the same result set without having to join the table to
itself.
|
static Column |
Functions.lag(Column col,
int offset)
Accesses data in a previous row in the same result set without having to join the table to
itself.
|
static Column |
Functions.lag(Column col,
int offset,
Column defaultValue)
Accesses data in a previous row in the same result set without having to join the table to
itself.
|
static Column |
Functions.last_day(Column e)
Returns the last day of the specified date part for a date or timestamp.
|
static Column |
Functions.lead(Column col)
Accesses data in a subsequent row in the same result set without having to join the table to
itself.
|
static Column |
Functions.lead(Column col,
int offset)
Accesses data in a subsequent row in the same result set without having to join the table to
itself.
|
static Column |
Functions.lead(Column col,
int offset,
Column defaultValue)
Accesses data in a subsequent row in the same result set without having to join the table to
itself.
|
static Column |
Functions.least(Column... cols)
Returns the smallest value from a list of expressions.
|
static Column |
Functions.left(Column strExpr,
Column lengthExpr)
Returns a left most substring of strExpr.
|
static Column |
Functions.length(Column e)
Returns the length of an input string or binary value.
|
Column |
Column.leq(Column other)
Less than or equal to.
|
Column |
Column.like(Column pattern)
Allows case-sensitive matching of strings based on comparison with a pattern.
|
static Column |
Functions.listagg(Column col)
Returns the concatenated input values, separated by empty string.
|
static Column |
Functions.listagg(Column col,
String delimiter)
Returns the concatenated input values, separated by `delimiter` string.
|
static Column |
Functions.listagg(Column col,
String delimiter,
boolean isDistinct)
Returns the concatenated input values, separated by `delimiter` string.
|
static Column |
Functions.log(Column base,
Column a)
Returns the logarithm of a numeric expression.
|
static Column |
Functions.lower(Column e)
Returns the input string with all characters converted to lowercase.
|
static Column |
Functions.lpad(Column str,
Column len,
Column pad)
Left-pads a string with characters from another string, or left-pads a binary value with bytes
from another binary value.
|
Column |
Column.lt(Column other)
Less than.
|
static Column |
Functions.ltrim(Column e)
Removes leading characters, including whitespace, from a string.
|
static Column |
Functions.ltrim(Column e,
Column trimString)
Removes leading characters, including whitespace, from a string.
|
DataFrame |
RelationalGroupedDataFrame.max(Column... cols)
Return the max for the specified numeric columns.
|
static Column |
Functions.max(Column col)
Returns the maximum value for the records in a group.
|
static Column |
Functions.md5(Column e)
Returns a 32-character hex-encoded string containing the 128-bit MD5 message digest.
|
DataFrame |
RelationalGroupedDataFrame.mean(Column... cols)
Return the average for the specified numeric columns.
|
static Column |
Functions.mean(Column col)
Returns the average of non-NULL records.
|
DataFrame |
RelationalGroupedDataFrame.median(Column... cols)
Return the median for the specified numeric columns.
|
static Column |
Functions.median(Column col)
Returns the median value for the records in a group.
|
MergeBuilder |
Updatable.merge(DataFrame source,
Column joinExpr)
Initiates a merge action for this updatable with
DataFrame source on specified join
expression. |
DataFrame |
RelationalGroupedDataFrame.min(Column... cols)
Return the min for the specified numeric columns.
|
static Column |
Functions.min(Column col)
Returns the minimum value for the records in a group.
|
Column |
Column.minus(Column other)
Minus
|
static Column |
Functions.minute(Column e)
Extracts the minute from a date or timestamp.
|
Column |
Column.mod(Column other)
Remainder
|
static Column |
Functions.month(Column e)
Extracts the month from a date or timestamp.
|
static Column |
Functions.monthname(Column expr)
Extracts the three-letter month name from the specified date or timestamp.
|
Column |
Column.multiply(Column other)
Multiply
|
static Column |
Functions.negate(Column col)
Returns the negation of the value in the column (equivalent to a unary minus).
|
static Column |
Functions.next_day(Column date,
Column dayOfWeek)
Returns the date of the first specified DOW (day of week) that occurs after the input date.
|
Column |
Column.not_equal(Column other)
Not equal to.
|
static Column |
Functions.not(Column col)
Returns the inverse of a boolean expression.
|
static Column |
Functions.ntile(Column col)
Divides an ordered data set equally into the number of buckets specified by n.
|
static Column |
Functions.object_construct(Column... key_values)
Returns an OBJECT constructed from the arguments.
|
static Column |
Functions.object_delete(Column obj,
Column key1,
Column... keys)
Returns an object containing the contents of the input (i.e.source) object with one or more
keys removed.
|
static Column |
Functions.object_delete(Column obj,
Column key1,
Column... keys)
Returns an object containing the contents of the input (i.e.source) object with one or more
keys removed.
|
static Column |
Functions.object_insert(Column obj,
Column key,
Column value)
Returns an object consisting of the input object with a new key-value pair inserted.
|
static Column |
Functions.object_insert(Column obj,
Column key,
Column value,
Column update_flag)
Returns an object consisting of the input object with a new key-value pair inserted (or an
existing key updated with a new value).
|
static Column |
Functions.object_keys(Column obj)
Returns an array containing the list of keys in the input object.
|
static Column |
Functions.object_pick(Column obj,
Column key1,
Column... keys)
Returns a new OBJECT containing some of the key-value pairs from an existing object.
|
static Column |
Functions.object_pick(Column obj,
Column key1,
Column... keys)
Returns a new OBJECT containing some of the key-value pairs from an existing object.
|
static Column |
Functions.objectagg(Column key,
Column value)
Returns one OBJECT per group.
|
Column |
Column.or(Column other)
Or.
|
WindowSpec |
WindowSpec.orderBy(Column... cols)
Returns a new WindowSpec object with the new order by clause.
|
static WindowSpec |
Window.orderBy(Column... cols)
Returns WindowSpec object with order by clause.
|
Column |
CaseExpr.otherwise(Column value)
Sets the default result for this CASE expression.
|
static Column |
Functions.parse_json(Column col)
Parse the value of the specified column as a JSON string and returns the resulting JSON
document.
|
static Column |
Functions.parse_xml(Column col)
Parse the value of the specified column as a JSON string and returns the resulting XML
document.
|
WindowSpec |
WindowSpec.partitionBy(Column... cols)
Returns a new WindowSpec object with the new partition by clause.
|
static WindowSpec |
Window.partitionBy(Column... cols)
Returns WindowSpec object with partition by clause.
|
RelationalGroupedDataFrame |
DataFrame.pivot(Column pivotColumn,
Object[] values)
Rotates this DataFrame by turning the unique values from one column in the input expression
into multiple columns and aggregating results where required on any remaining column values.
|
Column |
Column.plus(Column other)
Plus
|
static Column |
Functions.pow(Column l,
Column r)
Returns a number (l) raised to the specified power (r).
|
static Column |
Functions.previous_day(Column date,
Column dayOfWeek)
Returns the date of the first specified DOW (day of week) that occurs before the input date.
|
static Column |
Functions.quarter(Column e)
Extracts the quarter from a date or timestamp.
|
static Column |
Functions.radians(Column e)
Converts degrees to radians.
|
static Column |
Functions.regexp_count(Column strExpr,
Column pattern)
Returns the number of times that a pattern occurs in a strExpr.
|
static Column |
Functions.regexp_count(Column strExpr,
Column pattern,
Column position,
Column parameters)
Returns the number of times that a pattern occurs in a strExpr.
|
Column |
Column.regexp(Column pattern)
Returns true if this column matches the specified regular expression.
|
DataFrame |
DataFrame.rename(String newName,
Column col)
Returns a DataFrame with the specified column `col` renamed as `newName`.
|
static Column |
Functions.repeat(Column str,
Column n)
Builds a string by repeating the input for the specified number of times.
|
static Column |
Functions.replace(Column strExpr,
Column pattern)
Removes all occurrences of a specified strExpr, and optionally replaces them with replacement.
|
static Column |
Functions.replace(Column strExpr,
Column pattern,
Column replacement)
Removes all occurrences of a specified strExpr, and optionally replaces them with replacement.
|
static Column |
Functions.right(Column strExpr,
Column lengthExpr)
Returns a right most substring of strExpr.
|
RelationalGroupedDataFrame |
DataFrame.rollup(Column... cols)
Performs an SQL GROUP BY
ROLLUP on the DataFrame.
|
static Column |
Functions.round(Column e)
Returns rounded values for the specified column.
|
static Column |
Functions.round(Column e,
Column scale)
Returns rounded values for the specified column.
|
static Column |
Functions.rpad(Column str,
Column len,
Column pad)
Right-pads a string with characters from another string, or right-pads a binary value with
bytes from another binary value.
|
static Column |
Functions.rtrim(Column e)
Removes trailing characters, including whitespace, from a string.
|
static Column |
Functions.rtrim(Column e,
Column trimString)
Removes trailing characters, including whitespace, from a string.
|
DataFrame |
DataFrameStatFunctions.sampleBy(Column col,
Map<?,Double> fractions)
Returns a DataFrame containing a stratified sample without replacement, based on a Map that
specifies the fraction for each stratum.
|
static Column |
Functions.second(Column e)
Extracts the second from a date or timestamp.
|
DataFrame |
DataFrame.select(Column... columns)
Generates a new DataFrame with the specified Column expressions as output (similar to SELECT in
SQL).
|
static Column |
Functions.sha1(Column e)
Returns a 40-character hex-encoded string containing the 160-bit SHA-1 message digest.
|
static Column |
Functions.sha2(Column e,
int numBits)
Returns a hex-encoded string containing the N-bit SHA-2 message digest, where N is the
specified output digest size.
|
static Column |
Functions.sin(Column e)
Computes the sine of its argument; the argument should be expressed in radians.
|
static Column |
Functions.sinh(Column e)
Computes the hyperbolic sine of its argument.
|
static Column |
Functions.skew(Column col)
Returns the sample skewness of non-NULL records.
|
DataFrame |
DataFrame.sort(Column... sortExprs)
Sorts a DataFrame by the specified expressions (similar to ORDER BY in SQL).
|
static Column |
Functions.soundex(Column e)
Returns a string that contains a phonetic representation of the input string.
|
static Column |
Functions.split(Column str,
Column pattern)
Splits a given string with a given separator and returns the result in an array of strings.
|
static Column |
Functions.sqrt(Column col)
Returns the square-root of a non-negative numeric expression.
|
static Column |
Functions.startswith(Column col,
Column str)
Returns true if col starts with str.
|
static Column |
Functions.stddev_pop(Column col)
Returns the population standard deviation (square root of variance) of non-NULL values.
|
static Column |
Functions.stddev_samp(Column col)
Returns the sample standard deviation (square root of sample variance) of non-NULL values.
|
static Column |
Functions.stddev(Column col)
Returns the sample standard deviation (square root of sample variance) of non-NULL values.
|
static Column |
Functions.strip_null_value(Column col)
Converts a JSON "null" value in the specified column to a SQL NULL value.
|
static Column |
Functions.strtok_to_array(Column array)
Tokenizes the given string using the given set of delimiters and returns the tokens as an
array.
|
static Column |
Functions.strtok_to_array(Column array,
Column delimiter)
Tokenizes the given string using the given set of delimiters and returns the tokens as an
array.
|
static Column |
Functions.substring(Column str,
Column pos,
Column len)
Returns the portion of the string or binary value str, starting from the character/byte
specified by pos, with limited length.
|
static Column |
Functions.sum_distinct(Column col)
Returns the sum of non-NULL distinct records in a group.
|
DataFrame |
RelationalGroupedDataFrame.sum(Column... cols)
Return the sum for the specified numeric columns.
|
static Column |
Functions.sum(Column col)
Returns the sum of non-NULL records in a group.
|
DataFrame |
Session.tableFunction(TableFunction func,
Column... args)
Creates a new DataFrame from the given table function and arguments.
|
static Column |
Functions.tan(Column e)
Computes the tangent of its argument; the argument should be expressed in radians.
|
static Column |
Functions.tanh(Column e)
Computes the hyperbolic tangent of its argument.
|
static Column |
Functions.time_from_parts(Column hour,
Column minute,
Column second)
Creates a time from individual numeric components.
|
static Column |
Functions.time_from_parts(Column hour,
Column minute,
Column second,
Column nanosecond)
Creates a time from individual numeric components.
|
static Column |
Functions.timestamp_from_parts(Column dateExpr,
Column timeExpr)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second,
Column nanosecond)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_ltz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_ltz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second,
Column nanosecond)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_ntz_from_parts(Column dateExpr,
Column timeExpr)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_ntz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_ntz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second,
Column nanosecond)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_tz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_tz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second,
Column nanosecond)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.timestamp_tz_from_parts(Column year,
Column month,
Column day,
Column hour,
Column minute,
Column second,
Column nanosecond,
Column timezone)
Creates a timestamp from individual numeric components.
|
static Column |
Functions.to_array(Column col)
Converts the input expression into an array:
|
static Column |
Functions.to_date(Column e)
Converts an input expression to a date.
|
static Column |
Functions.to_date(Column e,
Column fmt)
Converts an input expression to a date.
|
static Column |
Functions.to_decimal(Column expr,
int precision,
int scale)
Converts an input expression to a decimal
|
static Column |
Functions.to_json(Column col)
Converts any VARIANT value to a string containing the JSON representation of the value.
|
static Column |
Functions.to_object(Column col)
Converts the input value to an object:
|
static Column |
Functions.to_timestamp(Column s)
Converts an input expression into the corresponding timestamp.
|
static Column |
Functions.to_timestamp(Column s,
Column fmt)
Converts an input expression into the corresponding timestamp.
|
static Column |
Functions.to_variant(Column col)
Converts any value to VARIANT value or NULL (if input is NULL).
|
static Column |
Functions.to_xml(Column col)
Converts any VARIANT value to a string containing the XML representation of the value.
|
static Column |
Functions.translate(Column src,
Column matchingString,
Column replaceString)
Translates src from the characters in matchingString to the characters in replaceString.
|
static Column |
Functions.trim(Column e,
Column trimString)
Removes leading and trailing characters from a string.
|
static Column |
Functions.trunc(Column expr,
Column scale)
Rounds the input expression down to the nearest (or equal) integer closer to zero, or to the
nearest equal or smaller value with the specified number of places after the decimal point.
|
static Column |
Functions.uniform(Column min,
Column max,
Column gen)
Returns a uniformly random number, in the inclusive range (`min`, `max`)
|
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.update(Map<Column,Column> assignments,
Column condition)
Executes `Updatable.update` asynchronously.
|
UpdateResult |
Updatable.update(Map<Column,Column> assignments,
Column condition)
Updates all rows in the updatable that satisfy specified condition with specified assignments
and returns a
UpdateResult, representing number of rows modified and number of
multi-joined rows modified. |
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.update(Map<Column,Column> assignments,
Column condition,
DataFrame sourceData)
Executes `Updatable.update` asynchronously.
|
UpdateResult |
Updatable.update(Map<Column,Column> assignments,
Column condition,
DataFrame sourceData)
Updates all rows in the updatable that satisfy specified condition where condition includes
columns in other
DataFrame, and returns a UpdateResult, representing number of
rows modified and number of multi-joined rows modified. |
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.updateColumn(Map<String,Column> assignments,
Column condition)
Executes `Updatable.update` asynchronously.
|
UpdateResult |
Updatable.updateColumn(Map<String,Column> assignments,
Column condition)
Updates all rows in the updatable that satisfy specified condition with specified assignments
and returns a
UpdateResult, representing number of rows modified and number of
multi-joined rows modified. |
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.updateColumn(Map<String,Column> assignments,
Column condition,
DataFrame sourceData)
Executes `Updatable.update` asynchronously.
|
UpdateResult |
Updatable.updateColumn(Map<String,Column> assignments,
Column condition,
DataFrame sourceData)
Updates all rows in the updatable that satisfy specified condition where condition includes
columns in other
DataFrame, and returns a UpdateResult, representing number of
rows modified and number of multi-joined rows modified. |
static Column |
Functions.upper(Column e)
Returns the input string with all characters converted to uppercase.
|
static Column |
Functions.var_pop(Column col)
Returns the population variance of non-NULL records in a group.
|
static Column |
Functions.var_samp(Column col)
Returns the sample variance of non-NULL records in a group.
|
static Column |
Functions.variance(Column col)
Returns the sample variance of non-NULL records in a group.
|
static Column |
Functions.weekofyear(Column e)
Extracts the week of year from a date or timestamp.
|
static CaseExpr |
Functions.when(Column condition,
Column value)
Works like a cascading if-then-else statement.
|
CaseExpr |
CaseExpr.when(Column condition,
Column value)
Appends one more WHEN condition to the CASE expression.
|
MatchedClauseBuilder |
MergeBuilder.whenMatched(Column condition)
Adds a matched clause into the merge action.
|
NotMatchedClauseBuilder |
MergeBuilder.whenNotMatched(Column condition)
Adds a matched clause into the merge action.
|
DataFrame |
DataFrame.where(Column condition)
Filters rows based on the specified conditional expression (similar to WHERE in SQL).
|
DataFrame |
DataFrame.withColumn(String colName,
Column col)
Returns a DataFrame with an additional column with the specified name (`colName`).
|
DataFrame |
DataFrame.withColumns(String[] colNames,
Column[] values)
Returns a DataFrame with additional columns with the specified names (`colNames`).
|
Column |
Column.withinGroup(Column... cols)
Returns a Column expression that adds a WITHIN GROUP clause to sort the rows by the specified
sequence of columns.
|
static Column |
Functions.xmlget(Column xml,
Column tag)
Extracts the first XML element object (often referred to as simply a tag) from a content of
outer XML element object by the name of the tag
|
static Column |
Functions.xmlget(Column xml,
Column tag,
Column instance)
Extracts an XML element object (often referred to as simply a tag) from a content of outer XML
element object by the name of the tag and its instance number (counting from 0).
|
static Column |
Functions.year(Column e)
Extracts the year from a date or timestamp.
|
| Modifier and Type | Method and Description |
|---|---|
MergeBuilder |
NotMatchedClauseBuilder.insert(Map<Column,Column> assignments)
Defines an insert action for the not matched clause, when a row in source is not matched,
insert a row in target with 'assignments', where the key specifies column name and value
specifies its assigned value.
|
MergeBuilder |
NotMatchedClauseBuilder.insert(Map<Column,Column> assignments)
Defines an insert action for the not matched clause, when a row in source is not matched,
insert a row in target with 'assignments', where the key specifies column name and value
specifies its assigned value.
|
MergeBuilder |
NotMatchedClauseBuilder.insertRow(Map<String,Column> assignments)
Defines an insert action for the not matched clause, when a row in source is not matched,
insert a row in target with 'assignments', where the key specifies column name and value
specifies its assigned value.
|
DataFrame |
DataFrame.join(TableFunction func,
Map<String,Column> args)
Joins the current DataFrame with the output of the specified table function `func` that takes
named parameters (e.g.
|
DataFrame |
Session.tableFunction(TableFunction func,
Map<String,Column> args)
Creates a new DataFrame from the given table function and arguments.
|
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.update(Map<Column,Column> assignments)
Executes `Updatable.update` asynchronously.
|
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.update(Map<Column,Column> assignments)
Executes `Updatable.update` asynchronously.
|
UpdateResult |
Updatable.update(Map<Column,Column> assignments)
Updates all rows in the Updatable with specified assignments and returns a
UpdateResult, representing number of rows modified and number of multi-joined rows modified. |
UpdateResult |
Updatable.update(Map<Column,Column> assignments)
Updates all rows in the Updatable with specified assignments and returns a
UpdateResult, representing number of rows modified and number of multi-joined rows modified. |
MergeBuilder |
MatchedClauseBuilder.update(Map<Column,Column> assignments)
Defines an update action for the matched clause, when a row in target is matched, update the
row in target with
assignments, where the key specifies column name and value specifies
its assigned value. |
MergeBuilder |
MatchedClauseBuilder.update(Map<Column,Column> assignments)
Defines an update action for the matched clause, when a row in target is matched, update the
row in target with
assignments, where the key specifies column name and value specifies
its assigned value. |
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.update(Map<Column,Column> assignments,
Column condition)
Executes `Updatable.update` asynchronously.
|
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.update(Map<Column,Column> assignments,
Column condition)
Executes `Updatable.update` asynchronously.
|
UpdateResult |
Updatable.update(Map<Column,Column> assignments,
Column condition)
Updates all rows in the updatable that satisfy specified condition with specified assignments
and returns a
UpdateResult, representing number of rows modified and number of
multi-joined rows modified. |
UpdateResult |
Updatable.update(Map<Column,Column> assignments,
Column condition)
Updates all rows in the updatable that satisfy specified condition with specified assignments
and returns a
UpdateResult, representing number of rows modified and number of
multi-joined rows modified. |
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.update(Map<Column,Column> assignments,
Column condition,
DataFrame sourceData)
Executes `Updatable.update` asynchronously.
|
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.update(Map<Column,Column> assignments,
Column condition,
DataFrame sourceData)
Executes `Updatable.update` asynchronously.
|
UpdateResult |
Updatable.update(Map<Column,Column> assignments,
Column condition,
DataFrame sourceData)
Updates all rows in the updatable that satisfy specified condition where condition includes
columns in other
DataFrame, and returns a UpdateResult, representing number of
rows modified and number of multi-joined rows modified. |
UpdateResult |
Updatable.update(Map<Column,Column> assignments,
Column condition,
DataFrame sourceData)
Updates all rows in the updatable that satisfy specified condition where condition includes
columns in other
DataFrame, and returns a UpdateResult, representing number of
rows modified and number of multi-joined rows modified. |
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.updateColumn(Map<String,Column> assignments)
Executes `Updatable.update` asynchronously.
|
UpdateResult |
Updatable.updateColumn(Map<String,Column> assignments)
Updates all rows in the updatable with specified assignments and returns a
UpdateResult, representing number of rows modified and number of multi-joined rows modified. |
MergeBuilder |
MatchedClauseBuilder.updateColumn(Map<String,Column> assignments)
Defines an update action for the matched clause, when a row in target is matched, update the
row in target with
assignments, where the key specifies column name and value specifies
its assigned value. |
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.updateColumn(Map<String,Column> assignments,
Column condition)
Executes `Updatable.update` asynchronously.
|
UpdateResult |
Updatable.updateColumn(Map<String,Column> assignments,
Column condition)
Updates all rows in the updatable that satisfy specified condition with specified assignments
and returns a
UpdateResult, representing number of rows modified and number of
multi-joined rows modified. |
TypedAsyncJob<UpdateResult> |
UpdatableAsyncActor.updateColumn(Map<String,Column> assignments,
Column condition,
DataFrame sourceData)
Executes `Updatable.update` asynchronously.
|
UpdateResult |
Updatable.updateColumn(Map<String,Column> assignments,
Column condition,
DataFrame sourceData)
Updates all rows in the updatable that satisfy specified condition where condition includes
columns in other
DataFrame, and returns a UpdateResult, representing number of
rows modified and number of multi-joined rows modified. |
© 2022 Snowflake Inc. All Rights Reserved