Skip to content

Commit 18d9580

Browse files
authored
docs: reference BigQuery REST API defaults in LoadJobConfig descrip… (#1132)
…tion Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-bigquery/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) Fixes internal issue 213442215 🦕
1 parent 8edc10d commit 18d9580

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

google/cloud/bigquery/job/load.py

+15-3
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,21 @@
3333
class LoadJobConfig(_JobConfig):
3434
"""Configuration options for load jobs.
3535
36-
All properties in this class are optional. Values which are :data:`None` ->
37-
server defaults. Set properties on the constructed configuration by using
38-
the property name as the name of a keyword argument.
36+
Set properties on the constructed configuration by using the property name
37+
as the name of a keyword argument. Values which are unset or :data:`None`
38+
use the BigQuery REST API default values. See the `BigQuery REST API
39+
reference documentation
40+
<https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationLoad>`_
41+
for a list of default values.
42+
43+
Required options differ based on the
44+
:attr:`~google.cloud.bigquery.job.LoadJobConfig.source_format` value.
45+
For example, the BigQuery API's default value for
46+
:attr:`~google.cloud.bigquery.job.LoadJobConfig.source_format` is ``"CSV"``.
47+
When loading a CSV file, either
48+
:attr:`~google.cloud.bigquery.job.LoadJobConfig.schema` must be set or
49+
:attr:`~google.cloud.bigquery.job.LoadJobConfig.autodetect` must be set to
50+
:data:`True`.
3951
"""
4052

4153
def __init__(self, **kwargs):

0 commit comments

Comments
 (0)