pyspark.pandas.get_option#
- pyspark.pandas.get_option(key, default=<no value>, *, spark_session=None)[source]#
Retrieves the value of the specified option.
- Parameters
- keystr
The key which should match a single option.
- defaultobject
The default value if the option is not set yet. The value should be JSON serializable.
- spark_session
SparkSession, optional The explicit
SparkSessionobject to get the option. If not specified, the default session will be used.
- Returns
- resultthe value of the option
- Raises
- OptionErrorif no such option exists and the default is not provided