pyspark.sql.DataFrame.hint

DataFrame.hint(name, *parameters)[source]

Specifies some hint on the current DataFrame.

New in version 2.2.0.

Parameters:
namestr

A name of the hint.

parametersstr, list, float or int

Optional parameters.

Returns:
DataFrame

Examples

>>> df.join(df2.hint("broadcast"), "name").show()
+----+---+------+
|name|age|height|
+----+---+------+
| Bob|  5|    85|
+----+---+------+