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. |
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 overriden by parameters in specific functions.
| Returns | |
|---|---|
| Type | Description |
bigframes._config.sampling_options.SamplingOptions |
Options for controlling downsampling. |