本頁面由 Cloud Translation API 翻譯而成。

使用伺服器用戶端程式庫建立 Firestore 資料庫

本快速入門導覽課程說明如何使用 C#、Go、Java、Node.js、PHP、Python 或 Ruby 伺服器用戶端程式庫，設定 Firestore、新增資料及讀取資料。

事前準備

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

以原生模式建立 Firestore 資料庫

如果是新專案，您需要建立 Firestore 資料庫執行個體。

前往 Firestore 檢視器。
在「選取資料庫服務」畫面中，選擇「原生模式的 Firestore」。
選取 Firestore 的位置。

如果無法選取位置，表示專案的「預設資源位置」 Google Cloud 已設定完畢。專案的部分資源 (例如預設 Firestore 執行個體) 共用常見的位置依附元件，您可以在建立專案時或設定共用此位置依附元件的其他服務時，設定這些資源的位置。
按一下 [Create Database] (建立資料庫)。

建立 Firestore 專案時，系統也會在 Cloud API 管理工具中啟用 API。

設定驗證方法

如要執行用戶端程式庫，您必須先建立服務帳戶並設定環境變數以設定驗證。

Provide authentication credentials to your application code by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS. This variable applies only to your current shell session. If you want the variable to apply to future shell sessions, set the variable in your shell startup file, for example in the ~/.bashrc or ~/.profile file.

Linux 或 macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

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

Windows

For PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

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

For command prompt:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

Replace KEY_PATH with the path of the JSON file that contains your credentials.

在應用程式中加入伺服器用戶端程式庫

將必要的依附元件和用戶端程式庫新增至應用程式。

Java

將 Firestore Java 程式庫新增至應用程式：

使用 Maven：

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>26.63.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，請參閱 Firestore Client for Java README。

使用 IDE：
如果您使用 VS Code、IntelliJ 或 Eclipse，可以利用下列 IDE 外掛程式，將用戶端程式庫新增到專案中：
這些外掛程式會提供其他功能，例如服務帳戶的金鑰管理功能。詳情請參閱各外掛程式的說明文件。

Python

將 Firestore Python 程式庫新增至應用程式：

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
(Async)

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