本页面将引导您完成将 Cloud Spanner API 与 Google Cloud CLI、客户端库和 Spanner 驱动程序搭配使用所需的设置步骤。
如果您要将 Spanner 与 Google Cloud 控制台搭配使用,请参阅快速入门:使用控制台。
所需的角色
如需获得使用和互动 Spanner 数据库所需的权限,请让您的管理员为您授予以下 IAM 角色:
-
读取和写入数据:
实例上的 Cloud Spanner Database User (
roles/spanner.databaseUser
) -
对数据库的只读权限:
实例上的 Cloud Spanner Database Reader (
roles/spanner.databaseReader
)
如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
设置 Google Cloud 项目
-
前往 Google Cloud 控制台中的项目页面。
- 创建新的 Google Cloud 项目,或者通过点击项目名称来打开现有项目。
-
打开一个终端窗口,将您的项目设置为 Google Cloud CLI 的默认项目,注意将
MY_PROJECT_ID
替换为您的项目 ID(不是您的项目名称):gcloud config set project MY_PROJECT_ID
-
Verify that billing is enabled for your Google Cloud project.
您还可以了解 Spanner 价格。
-
为项目启用 Cloud Spanner API。
注意:如果您使用其他项目中的服务账号来访问 Spanner 实例,则需要在这两个项目中启用 Spanner API。
设置身份验证
Select the tabs for how you plan to access the API:
Console
When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.
gcloud
安装 Google Cloud CLI。 安装完成后,运行以下命令初始化 Google Cloud CLI:
gcloud init
如果您使用的是外部身份提供方 (IdP),则必须先 使用联合身份登录 gcloud CLI。
如需设置 gcloud CLI 以使用服务账号模拟(而不是您的用户凭据)向 Google API 进行身份验证,请运行以下命令:
gcloud config set auth/impersonate_service_account SERVICE_ACCT_EMAIL
如需了解详情,请参阅服务账号模拟。
Terraform
如需在本地开发环境中使用 Terraform 代码,请安装并初始化 gcloud CLI,然后使用您的用户凭证设置应用默认凭证。
安装 Google Cloud CLI。
如果您使用的是外部身份提供方 (IdP),则必须先 使用联合身份登录 gcloud CLI。
If you're using a local shell, then create local authentication credentials for your user account:
gcloud auth application-default login
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
如需了解详情,请参阅 Set up authentication for a local development environment。
客户端库
如需在本地开发环境中使用客户端库,请安装并初始化 gcloud CLI,然后使用您的用户凭证设置应用默认凭证。
安装 Google Cloud CLI。
如果您使用的是外部身份提供方 (IdP),则必须先 使用联合身份登录 gcloud CLI。
If you're using a local shell, then create local authentication credentials for your user account:
gcloud auth application-default login
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
如需了解详情,请参阅 Set up authentication for a local development environment。 如需了解详情,请参阅身份验证文档中的为本地开发环境设置 ADC。
如需设置本地 ADC 文件以使用服务账号模拟(而不是您的用户凭据)向 Google API 进行身份验证,请运行以下命令:
gcloud auth application-default login --impersonate-service-account=SERVICE_ACCT_EMAIL
如需了解详情,请参阅服务账号模拟。
REST
如需在本地开发环境中使用 REST API,请使用您提供给 gcloud CLI 的凭据。
安装 Google Cloud CLI。
如果您使用的是外部身份提供方 (IdP),则必须先 使用联合身份登录 gcloud CLI。
如需了解详情,请参阅 Google Cloud 身份验证文档中的使用 REST 时进行身份验证。
您可以使用服务账号模拟为 REST API 请求生成访问令牌。如需了解详情,请参阅模拟的服务账号。
运行 Google Cloud CLI
在设置了开发环境和身份验证后,请运行 gcloud
命令行工具与 Spanner 进行互动:
gcloud spanner instance-configs list
您应该会看到您的项目可以访问的 Spanner 实例配置的列表,包括区域级、双区域和多区域配置。如需了解详情,请参阅实例概览。
您已完成设置!
后续步骤
了解如何使用 Cloud 客户端库和驱动程序创建 Spanner 实例、数据库、表和索引。然后在 Spanner 中存储、查询和读取数据。
- Spanner 使用入门 (C++)
- Spanner 使用入门 (C#)
- Spanner 使用入门 (Go)
- Spanner 使用入门 (Java)
- Spanner 使用入门 (JDBC)
- Spanner 使用入门 (Node.js)
- Spanner 使用入门 (PHP)
- Spanner 使用入门 (Python)
- Spanner 使用入门 (Ruby)
- Spanner 使用入门 (REST)
- Spanner 使用入门 (gcloud)
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-30。