bigframes._config.Options#
- class bigframes._config.Options[source]#
Global options affecting BigQuery DataFrames behavior.
Do not construct directly. Instead, refer to
bigframes.pandas.options.- property bigquery: BigQueryOptions#
Options to use with the BigQuery engine.
- Returns:
Options for BigQuery engine.
- Return type:
- property compute: ComputeOptions#
Thread-local options controlling object computation.
- Returns:
Thread-local options for controlling object computation
- Return type:
- property display: DisplayOptions#
Options controlling object representation.
- Returns:
Options for controlling object representation.
- Return type:
bigframes._config.display_options.DisplayOptions
- property experiments: ExperimentOptions#
Options controlling experiments
- Returns:
Thread-local options for controlling experiments
- Return type:
- property is_bigquery_thread_local: bool#
Indicator that we’re using a thread-local session.
A thread-local session can be started by using with bigframes.option_context(“bigquery.some_option”, “some-value”):.
- Returns:
A boolean value, where a value is True if a thread-local session is in use; otherwise False.
- Return type:
- reset() Options[source]#
Reset the option settings to defaults.
- Returns:
Options object with default values.
- Return type:
- property sampling: SamplingOptions#
Options controlling downsampling when downloading data to memory.
The data can be downloaded into memory explicitly (e.g., to_pandas, to_numpy, values) or implicitly (e.g., matplotlib plotting). This option can be overridden by parameters in specific functions.
- Returns:
Options for controlling downsampling.
- Return type: