此页面由 Cloud Translation API 翻译。

使用服务器客户端库创建 Firestore 数据库

本快速入门介绍如何使用 C＃、Go、Java、Node.js、PHP、Python 或 Ruby 服务器客户端库设置 Firestore、添加数据和读取数据。

准备工作

登录您的 Google Cloud 账号。如果您是 Google Cloud 新手，请创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金，用于运行、测试和部署工作负载。

在 Google Cloud Console 中的项目选择器页面上，选择或创建一个 Google Cloud 项目。

转到“项目选择器”

在 Google Cloud Console 中的项目选择器页面上，选择或创建一个 Google Cloud 项目。

转到“项目选择器”

在原生模式数据库下创建 Firestore

如果是全新项目，您需要创建一个 Firestore 数据库实例。

转到 Firestore 查看器。
从选择数据库服务屏幕中，选择“原生模式下的 Firestore”。
选择 Firestore 的位置。

此位置设置是您项目的默认 Google Cloud Platform (GCP) 资源位置。请注意：此位置将用于项目中需要位置设置的 GCP 服务，具体地说，包括您的默认 Cloud Storage 存储桶和 App Engine 应用（如果您使用 Cloud Scheduler，就需要该应用）。

警告：项目的默认 GCP 资源位置一经设置便无法更改。
点击创建数据库。

您在创建 Firestore 项目时，也会在 Cloud API Manager 中启用 API。

设置身份验证

要运行客户端库，必须先创建服务账号并设置环境变量来设置身份验证。

通过设置环境变量 GOOGLE_APPLICATION_CREDENTIALS 向应用代码提供身份验证凭据。此变量仅适用于当前的 Shell 会话。如果您希望变量应用于未来的 Shell 会话，请在 shell 启动文件中设置变量，例如在 ~/.bashrc 或 ~/.profile 文件中。

Linux 或 macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

将 KEY_PATH 替换为包含凭据的 JSON 文件的路径。

例如：

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

对于 PowerShell：

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

将 KEY_PATH 替换为包含凭据的 JSON 文件的路径。

例如：

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

对于命令提示符：

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

将 KEY_PATH 替换为包含凭据的 JSON 文件的路径。

将服务器客户端库添加到您的应用中

将所需的依赖项和客户端库添加到您的应用。

Java

将 Firestore Java 库添加到您的应用中：

使用 Maven：

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>26.37.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-firestore</artifactId>
  </dependency>pom.xml

如果您使用的是 Gradle 或者进行了没有 BoM 的设置，请参阅 Java 版 Firestore 客户端自述文件。

使用 IDE：
如果您使用的是 VS Code、IntelliJ 或 Eclipse，则可使用以下 IDE 插件将客户端库添加到您的项目中：
上述插件还提供其他功能，例如服务账号密钥管理。如需了解详情，请参阅各个插件相应的文档。

Python

将 Firestore Python 库添加到您的应用中：

注意：我们建议您使用虚拟 Python 环境来安装 Firestore Python 库：

pip install virtualenv
virtualenv env
source env/bin/activate

pip install --upgrade google-cloud-firestore

Node.js

将 Firestore Node.js 库添加到您的应用中：

npm install --save @google-cloud/firestore

Go

安装 Firestore Go 库：

go get cloud.google.com/go/firestore

将 Firestore Go 库添加到您的应用中：

import "cloud.google.com/go/firestore"

PHP

安装并启用 PHP 版 gRPC 扩展程序（您在使用客户端库时需用到它）。
将 Firestore PHP 库添加到您的应用中：
```
composer require google/cloud-firestore
```

C#

在您的 .csproj 文件中，将 Firestore C# 库添加到您的应用中：

<ItemGroup>
  <PackageReference Include="Google.Cloud.Firestore" Version="1.1.0-beta01" />
</ItemGroup>

将以下内容添加到 Program.cs 文件：
```
using Google.Cloud.Firestore;
```

Ruby

在您的 Gemfile 中，将 Firestore Ruby 库添加到您的应用中：
```
gem "google-cloud-firestore"
```
使用以下命令从 Gemfile 安装依赖项：
```
bundle install
```

初始化 Firestore

初始化 Firestore 的实例：

Java

import com.google.cloud.firestore.Firestore;
import com.google.cloud.firestore.FirestoreOptions;

FirestoreOptions firestoreOptions =
    FirestoreOptions.getDefaultInstance().toBuilder()
        .setProjectId(projectId)
        .setCredentials(GoogleCredentials.getApplicationDefault())
        .build();
Firestore db = firestoreOptions.getService();Quickstart.java

Python

from google.cloud import firestore

# The `project` parameter is optional and represents which project the client
# will act on behalf of. If not supplied, the client falls back to the default
# project inferred from the environment.
db = firestore.Client(project="my-project-id")snippets.py

Python
（异步）

from google.cloud import firestore

# The `project` parameter is optional and represents which project the client
# will act on behalf of. If not supplied, the client falls back to the default
# project inferred from the environment.
db = firestore.AsyncClient(project="my-project-id")snippets.py

Node.js

const Firestore = require('@google-cloud/firestore');

const db = new Firestore({
  projectId: 'YOUR_PROJECT_ID',
  keyFilename: '/path/to/keyfile.json',
});

Go

import (
	"context"
	"flag"
	"fmt"
	"log"

	"google.golang.org/api/iterator"

	"cloud.google.com/go/firestore"
)

func createClient(ctx context.Context) *firestore.Client {
	// Sets your Google Cloud Platform project ID.
	projectID := "YOUR_PROJECT_ID"

	client, err := firestore.NewClient(ctx, projectID)
	if err != nil {
		log.Fatalf("Failed to create client: %v", err)
	}
	// Close client when done with
	// defer client.Close()
	return client
}
main.go

PHP

use Google\Cloud\Firestore\FirestoreClient;

/**
 * Initialize Cloud Firestore with default project ID.
 */
function setup_client_create(string $projectId = null)
{
    // Create the Cloud Firestore client
    if (empty($projectId)) {
        // The `projectId` parameter is optional and represents which project the
        // client will act on behalf of. If not supplied, the client falls back to
        // the default project inferred from the environment.
        $db = new FirestoreClient();
        printf('Created Cloud Firestore client with default project ID.' . PHP_EOL);
    } else {
        $db = new FirestoreClient([
            'projectId' => $projectId,
        ]);
        printf('Created Cloud Firestore client with project ID: %s' . PHP_EOL, $projectId);
    }
}setup_client_create.php

C#

FirestoreDb db = FirestoreDb.Create(project);
Console.WriteLine("Created Cloud Firestore client with project ID: {0}", project);Program.cs

Ruby

require "google/cloud/firestore"

# The `project_id` parameter is optional and represents which project the
# client will act on behalf of. If not supplied, the client falls back to the
# default project inferred from the environment.
firestore = Google::Cloud::Firestore.new project_id: project_id

puts "Created Cloud Firestore client with given project ID."quickstart.rb