Send feedback
Class Options (2.17.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
Global options affecting BigQuery DataFrames behavior.
Properties
bigquery
Options to use with the BigQuery engine.
compute
Thread-local options controlling object computation.
display
Options controlling object representation.
experiments
Options controlling experiments
Returns
Type Description
bigframes._config.experiment_options.ExperimentOptionsThread-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
boolA 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.
Methods
reset
reset () - > bigframes . _config . Options
Reset the option settings to defaults.
Returns
Type Description
bigframes._config.OptionsOptions object with default values.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class Options (2.17.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.0 (latest)](/python/docs/reference/bigframes/latest/bigframes._config.Options)\n- [2.16.0](/python/docs/reference/bigframes/2.16.0/bigframes._config.Options)\n- [2.15.0](/python/docs/reference/bigframes/2.15.0/bigframes._config.Options)\n- [2.14.0](/python/docs/reference/bigframes/2.14.0/bigframes._config.Options)\n- [2.13.0](/python/docs/reference/bigframes/2.13.0/bigframes._config.Options)\n- [2.12.0](/python/docs/reference/bigframes/2.12.0/bigframes._config.Options)\n- [2.11.0](/python/docs/reference/bigframes/2.11.0/bigframes._config.Options)\n- [2.10.0](/python/docs/reference/bigframes/2.10.0/bigframes._config.Options)\n- [2.9.0](/python/docs/reference/bigframes/2.9.0/bigframes._config.Options)\n- [2.8.0](/python/docs/reference/bigframes/2.8.0/bigframes._config.Options)\n- [2.7.0](/python/docs/reference/bigframes/2.7.0/bigframes._config.Options)\n- [2.6.0](/python/docs/reference/bigframes/2.6.0/bigframes._config.Options)\n- [2.5.0](/python/docs/reference/bigframes/2.5.0/bigframes._config.Options)\n- [2.4.0](/python/docs/reference/bigframes/2.4.0/bigframes._config.Options)\n- [2.3.0](/python/docs/reference/bigframes/2.3.0/bigframes._config.Options)\n- [2.2.0](/python/docs/reference/bigframes/2.2.0/bigframes._config.Options)\n- [2.1.0](/python/docs/reference/bigframes/2.1.0/bigframes._config.Options)\n- [2.0.0](/python/docs/reference/bigframes/2.0.0/bigframes._config.Options)\n- [1.42.0](/python/docs/reference/bigframes/1.42.0/bigframes._config.Options)\n- [1.41.0](/python/docs/reference/bigframes/1.41.0/bigframes._config.Options)\n- [1.40.0](/python/docs/reference/bigframes/1.40.0/bigframes._config.Options)\n- [1.39.0](/python/docs/reference/bigframes/1.39.0/bigframes._config.Options)\n- [1.38.0](/python/docs/reference/bigframes/1.38.0/bigframes._config.Options)\n- [1.37.0](/python/docs/reference/bigframes/1.37.0/bigframes._config.Options)\n- [1.36.0](/python/docs/reference/bigframes/1.36.0/bigframes._config.Options)\n- [1.35.0](/python/docs/reference/bigframes/1.35.0/bigframes._config.Options)\n- [1.34.0](/python/docs/reference/bigframes/1.34.0/bigframes._config.Options)\n- [1.33.0](/python/docs/reference/bigframes/1.33.0/bigframes._config.Options)\n- [1.32.0](/python/docs/reference/bigframes/1.32.0/bigframes._config.Options)\n- [1.31.0](/python/docs/reference/bigframes/1.31.0/bigframes._config.Options)\n- [1.30.0](/python/docs/reference/bigframes/1.30.0/bigframes._config.Options)\n- [1.29.0](/python/docs/reference/bigframes/1.29.0/bigframes._config.Options)\n- [1.28.0](/python/docs/reference/bigframes/1.28.0/bigframes._config.Options)\n- [1.27.0](/python/docs/reference/bigframes/1.27.0/bigframes._config.Options)\n- [1.26.0](/python/docs/reference/bigframes/1.26.0/bigframes._config.Options)\n- [1.25.0](/python/docs/reference/bigframes/1.25.0/bigframes._config.Options)\n- [1.24.0](/python/docs/reference/bigframes/1.24.0/bigframes._config.Options)\n- [1.22.0](/python/docs/reference/bigframes/1.22.0/bigframes._config.Options)\n- [1.21.0](/python/docs/reference/bigframes/1.21.0/bigframes._config.Options)\n- [1.20.0](/python/docs/reference/bigframes/1.20.0/bigframes._config.Options)\n- [1.19.0](/python/docs/reference/bigframes/1.19.0/bigframes._config.Options)\n- [1.18.0](/python/docs/reference/bigframes/1.18.0/bigframes._config.Options)\n- [1.17.0](/python/docs/reference/bigframes/1.17.0/bigframes._config.Options)\n- [1.16.0](/python/docs/reference/bigframes/1.16.0/bigframes._config.Options)\n- [1.15.0](/python/docs/reference/bigframes/1.15.0/bigframes._config.Options)\n- [1.14.0](/python/docs/reference/bigframes/1.14.0/bigframes._config.Options)\n- [1.13.0](/python/docs/reference/bigframes/1.13.0/bigframes._config.Options)\n- [1.12.0](/python/docs/reference/bigframes/1.12.0/bigframes._config.Options)\n- [1.11.1](/python/docs/reference/bigframes/1.11.1/bigframes._config.Options)\n- [1.10.0](/python/docs/reference/bigframes/1.10.0/bigframes._config.Options)\n- [1.9.0](/python/docs/reference/bigframes/1.9.0/bigframes._config.Options)\n- [1.8.0](/python/docs/reference/bigframes/1.8.0/bigframes._config.Options)\n- [1.7.0](/python/docs/reference/bigframes/1.7.0/bigframes._config.Options)\n- [1.6.0](/python/docs/reference/bigframes/1.6.0/bigframes._config.Options)\n- [1.5.0](/python/docs/reference/bigframes/1.5.0/bigframes._config.Options)\n- [1.4.0](/python/docs/reference/bigframes/1.4.0/bigframes._config.Options)\n- [1.3.0](/python/docs/reference/bigframes/1.3.0/bigframes._config.Options)\n- [1.2.0](/python/docs/reference/bigframes/1.2.0/bigframes._config.Options)\n- [1.1.0](/python/docs/reference/bigframes/1.1.0/bigframes._config.Options)\n- [1.0.0](/python/docs/reference/bigframes/1.0.0/bigframes._config.Options)\n- [0.26.0](/python/docs/reference/bigframes/0.26.0/bigframes._config.Options)\n- [0.25.0](/python/docs/reference/bigframes/0.25.0/bigframes._config.Options)\n- [0.24.0](/python/docs/reference/bigframes/0.24.0/bigframes._config.Options)\n- [0.23.0](/python/docs/reference/bigframes/0.23.0/bigframes._config.Options)\n- [0.22.0](/python/docs/reference/bigframes/0.22.0/bigframes._config.Options)\n- [0.21.0](/python/docs/reference/bigframes/0.21.0/bigframes._config.Options)\n- [0.20.1](/python/docs/reference/bigframes/0.20.1/bigframes._config.Options)\n- [0.19.2](/python/docs/reference/bigframes/0.19.2/bigframes._config.Options)\n- [0.18.0](/python/docs/reference/bigframes/0.18.0/bigframes._config.Options)\n- [0.17.0](/python/docs/reference/bigframes/0.17.0/bigframes._config.Options)\n- [0.16.0](/python/docs/reference/bigframes/0.16.0/bigframes._config.Options)\n- [0.15.0](/python/docs/reference/bigframes/0.15.0/bigframes._config.Options)\n- [0.14.1](/python/docs/reference/bigframes/0.14.1/bigframes._config.Options)\n- [0.13.0](/python/docs/reference/bigframes/0.13.0/bigframes._config.Options)\n- [0.12.0](/python/docs/reference/bigframes/0.12.0/bigframes._config.Options)\n- [0.11.0](/python/docs/reference/bigframes/0.11.0/bigframes._config.Options)\n- [0.10.0](/python/docs/reference/bigframes/0.10.0/bigframes._config.Options)\n- [0.9.0](/python/docs/reference/bigframes/0.9.0/bigframes._config.Options)\n- [0.8.0](/python/docs/reference/bigframes/0.8.0/bigframes._config.Options)\n- [0.7.0](/python/docs/reference/bigframes/0.7.0/bigframes._config.Options)\n- [0.6.0](/python/docs/reference/bigframes/0.6.0/bigframes._config.Options)\n- [0.5.0](/python/docs/reference/bigframes/0.5.0/bigframes._config.Options)\n- [0.4.0](/python/docs/reference/bigframes/0.4.0/bigframes._config.Options)\n- [0.3.0](/python/docs/reference/bigframes/0.3.0/bigframes._config.Options)\n- [0.2.0](/python/docs/reference/bigframes/0.2.0/bigframes._config.Options) \n\n Options()\n\nGlobal options affecting BigQuery DataFrames behavior.\n\nProperties\n----------\n\n### bigquery\n\nOptions to use with the BigQuery engine.\n\n### compute\n\nThread-local options controlling object computation.\n\n### display\n\nOptions controlling object representation.\n\n### experiments\n\nOptions controlling experiments\n\n### is_bigquery_thread_local\n\nIndicator that we're using a thread-local session.\n\nA thread-local session can be started by using\n`with bigframes.option_context(\"bigquery.some_option\", \"some-value\"):`.\n\n### sampling\n\nOptions controlling downsampling when downloading data\nto memory.\n\nThe data can be downloaded into memory explicitly\n(e.g., to_pandas, to_numpy, values) or implicitly (e.g.,\nmatplotlib plotting). This option can be overridden by\nparameters in specific functions.\n\nMethods\n-------\n\n### reset\n\n reset() -\u003e bigframes._config.Options\n\nReset the option settings to defaults."]]
