Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ setuptools >= 36.4.0
sphinx >= 1.6.3
ipython >= 4
recommonmark >= 0.4.0
grpcio-gcp >= 0.2.2

-e api_core/
-e core/
Expand Down
4 changes: 3 additions & 1 deletion spanner/google/cloud/spanner_admin_database_v1/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Copyright 2017 Google LLC
# -*- coding: utf-8 -*-
#
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down

Large diffs are not rendered by default.

8 changes: 6 additions & 2 deletions spanner/google/cloud/spanner_admin_database_v1/gapic/enums.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Copyright 2017 Google LLC
# -*- coding: utf-8 -*-
#
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -13,9 +15,11 @@
# limitations under the License.
"""Wrappers for protocol buffer enum types."""

import enum


class Database(object):
class State(object):
class State(enum.IntEnum):
"""
Indicates the current state of the database.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
# -*- coding: utf-8 -*-
#
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import google.api_core.grpc_helpers
import google.api_core.operations_v1

from google.cloud.spanner_admin_database_v1.proto import spanner_database_admin_pb2_grpc


class DatabaseAdminGrpcTransport(object):
"""gRPC transport class providing stubs for
google.spanner.admin.database.v1 DatabaseAdmin API.

The transport provides access to the raw gRPC stubs,
which can be used to take advantage of advanced
features of gRPC.
"""
# The scopes needed to make gRPC calls to all of the methods defined
# in this service.
_OAUTH_SCOPES = (
'https://www.googleapis.com/auth/cloud-platform',
'https://www.googleapis.com/auth/spanner.admin',
)

def __init__(self,
channel=None,
credentials=None,
address='spanner.googleapis.com:443'):
"""Instantiate the transport class.

Args:
channel (grpc.Channel): A ``Channel`` instance through
which to make calls. This argument is mutually exclusive
with ``credentials``; providing both will raise an exception.
credentials (google.auth.credentials.Credentials): The
authorization credentials to attach to requests. These
credentials identify this application to the service. If none
are specified, the client will attempt to ascertain the
credentials from the environment.
address (str): The address where the service is hosted.
"""
# If both `channel` and `credentials` are specified, raise an
# exception (channels come with credentials baked in already).
if channel is not None and credentials is not None:
raise ValueError(
'The `channel` and `credentials` arguments are mutually '
'exclusive.', )

# Create the channel.
if channel is None:
channel = self.create_channel(
address=address,
credentials=credentials,
)

# gRPC uses objects called "stubs" that are bound to the
# channel and provide a basic method for each RPC.
self._stubs = {
'database_admin_stub':
spanner_database_admin_pb2_grpc.DatabaseAdminStub(channel),
}

# Because this API includes a method that returns a
# long-running operation (proto: google.longrunning.Operation),
# instantiate an LRO client.
self._operations_client = google.api_core.operations_v1.OperationsClient(
channel)

@classmethod
def create_channel(cls,
address='spanner.googleapis.com:443',
credentials=None):
"""Create and return a gRPC channel object.

Args:
address (str): The host for the channel to use.
credentials (~.Credentials): The
authorization credentials to attach to requests. These
credentials identify this application to the service. If
none are specified, the client will attempt to ascertain
the credentials from the environment.

Returns:
grpc.Channel: A gRPC channel object.
"""
return google.api_core.grpc_helpers.create_channel(
address,
credentials=credentials,
scopes=cls._OAUTH_SCOPES,
)

@property
def list_databases(self):
"""Return the gRPC stub for {$apiMethod.name}.

Lists Cloud Spanner databases.

Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['database_admin_stub'].ListDatabases

@property
def create_database(self):
"""Return the gRPC stub for {$apiMethod.name}.

Creates a new Cloud Spanner database and starts to prepare it for serving.
The returned ``long-running operation`` will
have a name of the format ``<database_name>/operations/<operation_id>`` and
can be used to track preparation of the database. The
``metadata`` field type is
``CreateDatabaseMetadata``. The
``response`` field type is
``Database``, if successful.

Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['database_admin_stub'].CreateDatabase

@property
def get_database(self):
"""Return the gRPC stub for {$apiMethod.name}.

Gets the state of a Cloud Spanner database.

Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['database_admin_stub'].GetDatabase

@property
def update_database_ddl(self):
"""Return the gRPC stub for {$apiMethod.name}.

Updates the schema of a Cloud Spanner database by
creating/altering/dropping tables, columns, indexes, etc. The returned
``long-running operation`` will have a name of
the format ``<database_name>/operations/<operation_id>`` and can be used to
track execution of the schema change(s). The
``metadata`` field type is
``UpdateDatabaseDdlMetadata``. The operation has no response.

Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['database_admin_stub'].UpdateDatabaseDdl

@property
def drop_database(self):
"""Return the gRPC stub for {$apiMethod.name}.

Drops (aka deletes) a Cloud Spanner database.

Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['database_admin_stub'].DropDatabase

@property
def get_database_ddl(self):
"""Return the gRPC stub for {$apiMethod.name}.

Returns the schema of a Cloud Spanner database as a list of formatted
DDL statements. This method does not show pending schema updates, those may
be queried using the ``Operations`` API.

Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['database_admin_stub'].GetDatabaseDdl

@property
def set_iam_policy(self):
"""Return the gRPC stub for {$apiMethod.name}.

Sets the access control policy on a database resource. Replaces any
existing policy.

Authorization requires ``spanner.databases.setIamPolicy`` permission on
``resource``.

Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['database_admin_stub'].SetIamPolicy

@property
def get_iam_policy(self):
"""Return the gRPC stub for {$apiMethod.name}.

Gets the access control policy for a database resource. Returns an empty
policy if a database exists but does not have a policy set.

Authorization requires ``spanner.databases.getIamPolicy`` permission on
``resource``.

Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['database_admin_stub'].GetIamPolicy

@property
def test_iam_permissions(self):
"""Return the gRPC stub for {$apiMethod.name}.

Returns permissions that the caller has on the specified database resource.

Attempting this RPC on a non-existent Cloud Spanner database will result in
a NOT_FOUND error if the user has ``spanner.databases.list`` permission on
the containing Cloud Spanner instance. Otherwise returns an empty set of
permissions.

Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['database_admin_stub'].TestIamPermissions
Loading