Skip to content

Commit

Permalink
chore: add RequestOptions proto; add optimizer_statistics_package to …
Browse files Browse the repository at this point in the history 
…QueryOptions (#288)

* changes without context

        autosynth cannot find the source of changes triggered by earlier changes in this
        repository, or by version upgrades to tools such as linters.

* chore: update gapic-generator-python to 0.40.11

PiperOrigin-RevId: 359562873

Source-Author: Google APIs <noreply@google.com>
Source-Date: Thu Feb 25 10:52:32 2021 -0800
Source-Repo: googleapis/googleapis
Source-Sha: 07932bb995e7dc91b43620ea8402c6668c7d102c
Source-Link: googleapis/googleapis@07932bb

* feat(spanner): add `optimizer_statistics_package` field in `QueryOptions`

PiperOrigin-RevId: 360758638

Source-Author: Google APIs <noreply@google.com>
Source-Date: Wed Mar 3 14:32:33 2021 -0800
Source-Repo: googleapis/googleapis
Source-Sha: dff6e4625d4ea0a16fc44d3b9be115219c403f07
Source-Link: googleapis/googleapis@dff6e46

* chore: upgrade gapic-generator-python to 0.42.2

PiperOrigin-RevId: 361662015

Source-Author: Google APIs <noreply@google.com>
Source-Date: Mon Mar 8 14:47:18 2021 -0800
Source-Repo: googleapis/googleapis
Source-Sha: 28a591963253d52ce3a25a918cafbdd9928de8cf
Source-Link: googleapis/googleapis@28a5919

* chore: upgrade gapic-generator-python to 0.43.1

PiperOrigin-RevId: 364411656

Source-Author: Google APIs <noreply@google.com>
Source-Date: Mon Mar 22 14:40:22 2021 -0700
Source-Repo: googleapis/googleapis
Source-Sha: 149a3a84c29c9b8189576c7442ccb6dcf6a8f95b
Source-Link: googleapis/googleapis@149a3a8

* feat: add RPC Priority request options

PiperOrigin-RevId: 364449524

Source-Author: Google APIs <noreply@google.com>
Source-Date: Mon Mar 22 17:39:37 2021 -0700
Source-Repo: googleapis/googleapis
Source-Sha: 6598bb829c9e9a534be674649ffd1b4671a821f9
Source-Link: googleapis/googleapis@6598bb8

* feat: add tagging request options

PiperOrigin-RevId: 365498709

Source-Author: Google APIs <noreply@google.com>
Source-Date: Sun Mar 28 20:54:25 2021 -0700
Source-Repo: googleapis/googleapis
Source-Sha: 6ce40ff8faf68226782f507ca6b2d497a77044de
Source-Link: googleapis/googleapis@6ce40ff

* fix: fix dependencies

* chore: revert changes taht break tests

* style: fix lint

Co-authored-by: Bu Sun Kim <busunkim@google.com>
Co-authored-by: larkee <larkee@users.noreply.github.com>
  • Loading branch information
@yoshi-automation @busunkim96 @larkee
3 people committed Apr 6, 2021
1 parent 7ae8e0b commit 83adb1e
Show file tree
Hide file tree
Showing 39 changed files with 1,601 additions and 623 deletions.
44 changes: 22 additions & 22 deletions UPGRADING.md
View file
Expand Up @@ -14,13 +14,13 @@ limitations under the License.

# 2.0.0 Migration Guide

The 2.0 release of the `google-cloud-spanner` client is a significant update based on a
The 2.0 release of the `google-cloud-spanner` client is a significant update based on a
[next-gen code generator](https://github.com/googleapis/gapic-generator-python).
It drops support for Python versions below 3.6.
It drops support for Python versions below 3.6.

The handwritten client surfaces have minor changes which may require minimal updates to existing user code.

The generated client surfaces have substantial interface changes. Existing user code which uses these surfaces directly
The generated client surfaces have substantial interface changes. Existing user code which uses these surfaces directly
will require significant updates to use this version.

This document describes the changes that have been made, and what you need to do to update your usage.
Expand Down Expand Up @@ -89,7 +89,7 @@ for database_pb in instance.list_databases():
> **WARNING**: Breaking change
The library now handles pages for the user. Previously, the library would return a page generator which required a user
to then iterate over each page to get the resource. Now, the library handles iterating over the pages and only returns
to then iterate over each page to get the resource. Now, the library handles iterating over the pages and only returns
the resource protos.

**Before:**
Expand Down Expand Up @@ -176,14 +176,14 @@ for database_pb in instance.list_databases():
Methods expect request objects. We provide scripts that will convert most common use cases.

* Install the library
* Install the library with `libcst`.

```py
python3 -m pip install google-cloud-spanner
python3 -m pip install google-cloud-spanner[libcst]
```

* The scripts `fixup_spanner_v1_keywords.py`, `fixup_spanner_admin_database_v1_keywords.py`, and
`fixup_spanner_admin_instance_v1_keywords.py` are shipped with the library. They expect an input directory (with the
`fixup_spanner_admin_instance_v1_keywords.py` are shipped with the library. They expect an input directory (with the
code to convert) and an empty destination directory.

```sh
Expand All @@ -194,10 +194,10 @@ $ fixup_spanner_v1_keywords.py --input-directory .samples/ --output-directory sa
>the handwritten surfaces e.g. `client.list_instances()`
#### More details

In `google-cloud-spanner<2.0.0`, parameters required by the API were positional parameters and optional parameters were
keyword parameters.

**Before:**
```py
def list_instances(
Expand All @@ -210,14 +210,14 @@ def list_instances(
metadata=None,
):
```
In the 2.0.0 release, all methods have a single positional parameter `request`. Method docstrings indicate whether a

In the 2.0.0 release, all methods have a single positional parameter `request`. Method docstrings indicate whether a
parameter is required or optional.
Some methods have additional keyword only parameters. The available parameters depend on the

Some methods have additional keyword only parameters. The available parameters depend on the
[`google.api.method_signature` annotation](https://github.com/googleapis/googleapis/blob/master/google/spanner/admin/instance/v1/spanner_instance_admin.proto#L86) specified by the API producer.


**After:**
```py
def list_instances(
Expand All @@ -230,30 +230,30 @@ def list_instances(
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListInstancesPager:
```

> **NOTE:** The `request` parameter and flattened keyword parameters for the API are mutually exclusive.
> Passing both will result in an error.

Both of these calls are valid:

```py
response = client.list_instances(
request={
"parent": project_name,
}
)
```

```py
response = client.execute_sql(
parent=project_name,
)
```

This call is invalid because it mixes `request` with a keyword argument `parent`. Executing this code
will result in an error.

```py
response = client.execute_sql(
request={},
Expand Down
2 changes: 1 addition & 1 deletion google/cloud/spanner_admin_database_v1/proto/spanner_database_admin.proto
View file
Expand Up @@ -736,7 +736,7 @@ message RestoreDatabaseRequest {
// to. If this field is not specified, the restored database will use the same
// encryption configuration as the backup by default, namely
// [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type]
// = `USE_CONFIG_DEFAULT_OR_DATABASE_ENCRYPTION`.
// = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
RestoreDatabaseEncryptionConfig encryption_config = 4
[(google.api.field_behavior) = OPTIONAL];
}
Expand Down
44 changes: 42 additions & 2 deletions google/cloud/spanner_admin_database_v1/services/database_admin/async_client.py
View file
Expand Up @@ -103,8 +103,36 @@ class DatabaseAdminAsyncClient:
DatabaseAdminClient.parse_common_location_path
)

from_service_account_info = DatabaseAdminClient.from_service_account_info
from_service_account_file = DatabaseAdminClient.from_service_account_file
@classmethod
def from_service_account_info(cls, info: dict, *args, **kwargs):
"""Creates an instance of this client using the provided credentials info.
Args:
info (dict): The service account private key info.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
DatabaseAdminAsyncClient: The constructed client.
"""
return DatabaseAdminClient.from_service_account_info.__func__(DatabaseAdminAsyncClient, info, *args, **kwargs) # type: ignore

@classmethod
def from_service_account_file(cls, filename: str, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
file.
Args:
filename (str): The path to the service account private key json
file.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
DatabaseAdminAsyncClient: The constructed client.
"""
return DatabaseAdminClient.from_service_account_file.__func__(DatabaseAdminAsyncClient, filename, *args, **kwargs) # type: ignore

from_service_account_json = from_service_account_file

@property
Expand Down Expand Up @@ -236,6 +264,7 @@ async def list_databases(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=3600.0,
),
default_timeout=3600.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down Expand Up @@ -431,6 +460,7 @@ async def get_database(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=3600.0,
),
default_timeout=3600.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down Expand Up @@ -559,6 +589,7 @@ async def update_database_ddl(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=3600.0,
),
default_timeout=3600.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down Expand Up @@ -642,6 +673,7 @@ async def drop_database(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=3600.0,
),
default_timeout=3600.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down Expand Up @@ -726,6 +758,7 @@ async def get_database_ddl(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=3600.0,
),
default_timeout=3600.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down Expand Up @@ -1007,6 +1040,7 @@ async def get_iam_policy(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=30.0,
),
default_timeout=30.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down Expand Up @@ -1302,6 +1336,7 @@ async def get_backup(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=3600.0,
),
default_timeout=3600.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down Expand Up @@ -1402,6 +1437,7 @@ async def update_backup(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=3600.0,
),
default_timeout=3600.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down Expand Up @@ -1481,6 +1517,7 @@ async def delete_backup(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=3600.0,
),
default_timeout=3600.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down Expand Up @@ -1566,6 +1603,7 @@ async def list_backups(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=3600.0,
),
default_timeout=3600.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down Expand Up @@ -1795,6 +1833,7 @@ async def list_database_operations(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=3600.0,
),
default_timeout=3600.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down Expand Up @@ -1897,6 +1936,7 @@ async def list_backup_operations(
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded, exceptions.ServiceUnavailable,
),
deadline=3600.0,
),
default_timeout=3600.0,
client_info=DEFAULT_CLIENT_INFO,
Expand Down
15 changes: 6 additions & 9 deletions google/cloud/spanner_admin_database_v1/services/database_admin/client.py
View file
Expand Up @@ -1082,11 +1082,10 @@ def set_iam_policy(
"the individual field arguments should be set."
)

# The request isn't a proto-plus wrapped type,
# so it must be constructed via keyword expansion.
if isinstance(request, dict):
# The request isn't a proto-plus wrapped type,
# so it must be constructed via keyword expansion.
request = iam_policy.SetIamPolicyRequest(**request)

elif not request:
# Null request, just make one.
request = iam_policy.SetIamPolicyRequest()
Expand Down Expand Up @@ -1219,11 +1218,10 @@ def get_iam_policy(
"the individual field arguments should be set."
)

# The request isn't a proto-plus wrapped type,
# so it must be constructed via keyword expansion.
if isinstance(request, dict):
# The request isn't a proto-plus wrapped type,
# so it must be constructed via keyword expansion.
request = iam_policy.GetIamPolicyRequest(**request)

elif not request:
# Null request, just make one.
request = iam_policy.GetIamPolicyRequest()
Expand Down Expand Up @@ -1311,11 +1309,10 @@ def test_iam_permissions(
"the individual field arguments should be set."
)

# The request isn't a proto-plus wrapped type,
# so it must be constructed via keyword expansion.
if isinstance(request, dict):
# The request isn't a proto-plus wrapped type,
# so it must be constructed via keyword expansion.
request = iam_policy.TestIamPermissionsRequest(**request)

elif not request:
# Null request, just make one.
request = iam_policy.TestIamPermissionsRequest()
Expand Down

0 comments on commit 83adb1e

Please sign in to comment.