Class Options (1.27.0)

Version latest

• 1.27.0 (latest)
• 1.26.0
• 1.25.0
• 1.24.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.1
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.1
• 0.19.2
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0

Options()

Global options affecting BigQuery DataFrames behavior.

Properties

bigquery

Options to use with the BigQuery engine.

Returns
Type	Description
bigframes._config.bigquery_options.BigQueryOptions	Options for BigQuery engine.

compute

Thread-local options controlling object computation.

Returns
Type	Description
bigframes._config.compute_options.ComputeOptions	Thread-local options for controlling object computation

display

Options controlling object representation.

Returns
Type	Description
bigframes._config.display_options.DisplayOptions	Options for controlling object representation.

experiments

Options controlling experiments

Returns
Type	Description
bigframes._config.experiment_options.ExperimentOptions	Thread-local options for controlling experiments

is_bigquery_thread_local

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
Type	Description
bool	A boolean value, where a value is True if a thread-local session is in use; otherwise False.

sampling

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
Type	Description
bigframes._config.sampling_options.SamplingOptions	Options for controlling downsampling.