nxcals.api.extraction.data.builders.DataFrame.hint

DataFrame.hint(name: str, *parameters: Union[PrimitiveType, List[PrimitiveType]]) → DataFrame

Specifies some hint on the current DataFrame.

New in version 2.2.0.

Parameters:

  • name (str) – A name of the hint.

  • parameters (str, list, float or int) – Optional parameters.

Return type:

DataFrame

Examples

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