Skip to content

Commit 3af04ef

Browse files
committed
Add UPGRADING guide.
1 parent 1844d7e commit 3af04ef

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

UPGRADING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!--
2+
Copyright 2020 Google LLC
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
https://www.apache.org/licenses/LICENSE-2.0
7+
Unless required by applicable law or agreed to in writing, software
8+
distributed under the License is distributed on an "AS IS" BASIS,
9+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10+
See the License for the specific language governing permissions and
11+
limitations under the License.
12+
-->
13+
14+
15+
# 2.0.0 Migration Guide
16+
17+
The 2.0 release of the `google-cloud-bigquery` client drops support for Python
18+
versions below 3.6. The client surface itself has not changed, but the 1.x series
19+
will not be receiving any more feature updates or bug fixes. You are thus
20+
encouraged to upgrade to the 2.x series.
21+
22+
If you experience issues or have questions, please file an
23+
[issue](https://github.com/googleapis/python-bigquery/issues).
24+
25+
26+
## Supported Python Versions
27+
28+
> **WARNING**: Breaking change
29+
30+
The 2.0.0 release requires Python 3.6+.
31+
32+
33+
## Supported BigQuery Storage Clients
34+
35+
The 2.0.0 release requires BigQuery Storage `>= 2.0.0`, which dropped support
36+
for `v1beta1` and `v1beta2` versions of the BigQuery Storage API. If you want to
37+
use a BigQuery Storage client, it must be the one supporting the `v1` API version.

docs/UPGRADING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../UPGRADING.md

docs/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,16 @@ API Reference
2727
reference
2828
dbapi
2929

30+
Migration Guide
31+
---------------
32+
33+
See the guide below for instructions on migrating to the 2.x release of this library.
34+
35+
.. toctree::
36+
:maxdepth: 2
37+
38+
UPGRADING
39+
3040
Changelog
3141
---------
3242

0 commit comments

Comments
 (0)