Questa pagina è stata tradotta dall'API Cloud Translation.

Introduzione all'API Firestore in modalità Datastore

Questa pagina fornisce un breve esercizio sulla creazione di un'applicazione TasksList a riga di comando con l'API Firestore in modalità Datastore. L'applicazione TaskList archivia, elenca, aggiorna e rimuove le attività.

Prerequisiti

Capacità di scrivere ed eseguire un'applicazione a riga di comando nei linguaggi di programmazione utilizzati in questo argomento
Oltre a una conoscenza di base su come sviluppare applicazioni, dovresti essere in grado di scaricare e installare librerie aggiuntive prima di provare questo tutorial.
Un progetto Google Cloud con l'API in modalità Datastore abilitata
Le applicazioni che utilizzano la modalità Datastore sono associate a un progetto Google Cloud con l'API in modalità Datastore abilitata. Questo progetto fornisce le credenziali di autenticazione che utilizzi nell'applicazione per identificarlo a Google e autorizzarne l'utilizzo dell'API in modalità Datastore.
Segui queste istruzioni per creare un progetto, abilitare la relativa API in modalità Datastore e configurare l'ambiente di sviluppo locale con le credenziali di autenticazione utilizzando il comando gcloud auth login. Prendi nota dell'ID del progetto, che utilizzerai più avanti.

Installazione e configurazione

Installare le librerie client e configurare eventuali impostazioni aggiuntive per l'ambiente di sviluppo.

C#

Assicurati di aver installato Visual Studio (versione 2013 o successive).
Scarica l'applicazione di esempio TaskList dal repository di esempi.
Estrai i file dallo zip e spostali in una directory all'interno della cartella Documenti.
In Visual Studio, apri il file dotnet-docs-samples-master\datastore\api\Datastore.sln.
Nella finestra Esplora soluzioni di Visual Studio, fai clic con il pulsante destro del mouse sul progetto TaskList e scegli Imposta come progetto di avvio.
Fai di nuovo clic con il pulsante destro del mouse sul progetto TaskList e scegli Proprietà.
Nella finestra Proprietà, fai clic su Debug e digita l'ID del progetto Google Cloud nella casella Argomenti della riga di comando:.
Fai clic su File e poi su Salva per salvare le modifiche.
Esegui l'applicazione. Premi F5 sulla tastiera.

Go

Clona l'applicazione di esempio TaskList.

go get github.com/GoogleCloudPlatform/golang-samples/datastore/tasks

Cambia la directory in cui hai clonato l'esempio:

cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/datastore/tasks

A un prompt dei comandi, esegui quanto segue, dove <project-id> è l'ID del tuo progetto Google Cloud.
```
export DATASTORE_PROJECT_ID=<project-id>
```
(Utenti di Windows: utilizza set anziché export.)
Esegui l'applicazione.
```
go run tasks.go
```

Java

Assicurati di avere installato Maven e Java (versione 8 o successive).
Scarica l'applicazione di esempio TaskList dal repository di esempi.
A un prompt dei comandi, estrai il download:
```
unzip main.zip
```
Cambia directory nell'applicazione TaskList:
```
cd java-datastore-main/samples/snippets
```
Esegui il comando riportato di seguito, dove <project-id> è l'ID del tuo progetto Google Cloud.
```
gcloud config set project <project-id>
```

Compila ed esegui l'applicazione.

mvn clean compile
mvn exec:java -Dexec.mainClass="com.google.datastore.snippets.TaskList"

Node.js

Prepara l'ambiente per lo sviluppo Node.js.
Scarica l'applicazione di esempio TaskList dal repository di esempi.
Estrai il download:
```
unzip master.zip
```
Cambia directory nell'applicazione TaskList:
```
cd nodejs-datastore-master/samples
```
Installa le dipendenze e collega l'applicazione:
```
npm install
```
A un prompt dei comandi, esegui quanto segue, dove <project-id> è l'ID del tuo progetto Google Cloud.
```
export GCLOUD_PROJECT=<project-id>
```
(Utenti di Windows: utilizza set anziché export.)
Esegui l'applicazione.
```
node tasks.js
```

PHP

Assicurati di avere installato PHP (versione 5.6 o successive) e Composer.
Scarica l'applicazione di esempio TaskList dal repository di esempi.
Estrai il download:
```
unzip master.zip
```

Cambia directory nell'applicazione TaskList:

cd php-docs-samples-master/datastore/tutorial

Installare le dipendenze.
```
composer install
```
Esegui l'applicazione.
```
php src/list_tasks.php
```

Python

Assicurati di avere installato Python (versione 2.7.9 o successive), pip e virtualenv.

Attiva una sessione virtualenv.

virtualenv venv
source venv/bin/activate

Scarica l'applicazione di esempio TaskList dal repository di esempi.
Estrai il download:
```
unzip master.zip
```

Cambia directory nell'applicazione TaskList:

cd python-docs-samples-master/datastore/cloud-client

Installa le dipendenze:
```
pip install -r requirements.txt
```
Esegui l'applicazione. Utilizza l'ID del tuo progetto Google Cloud per <project-id>.
```
python tasks.py new project-id
```

Ruby

Assicurati di avere installato Ruby e Bundler.
Scarica l'applicazione di esempio TaskList dal repository di esempi.
Estrai il download:
```
unzip master.zip
```

Cambia directory nell'applicazione TaskList:

cd google-cloud-ruby-master/google-cloud-datastore/samples

Installa le dipendenze:
```
bundle install
```
A un prompt dei comandi, esegui quanto segue, dove <project-id> è l'ID del tuo progetto Google Cloud.
```
export GOOGLE_CLOUD_PROJECT=<project-id>
```
(Utenti di Windows: utilizza set anziché export.)
Esegui l'applicazione.
```
bundle exec ruby tasks.rb
```

Creazione di un oggetto di servizio autorizzato

Per effettuare richieste autenticate alle API di Google Cloud utilizzando le librerie client delle API di Google, devi:

Recupera la credenziale da utilizzare per le richieste.
Creare un oggetto di servizio che utilizzi questa credenziale.

Quindi puoi effettuare chiamate API richiamando metodi sull'oggetto di servizio in modalità Datastore.

Per questo esempio, recupererai le credenziali predefinite dell'applicazione dall'ambiente e le passerai come argomento per creare l'oggetto di servizio.

Ecco la chiamata per creare l'oggetto di servizio autorizzato in modalità Datastore:

C#

Per informazioni su come installare e utilizzare la libreria client per Cloud Datastore, consulta Librerie client di Cloud Datastore. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API C# di Cloud Datastore.

Per eseguire l'autenticazione su Cloud Datastore, configura le Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.

// Create an authorized Datastore service using Application Default Credentials.
_db = DatastoreDb.Create(projectId);
// Create a Key factory to construct keys associated with this project.
_keyFactory = _db.CreateKeyFactory("Task");

Go

import (
	"context"
	"log"

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

func createClient(projectID string) (*datastore.Client, error) {
	ctx := context.Background()
	client, err := datastore.NewClient(ctx, projectID)
	if err != nil {
		log.Fatalf("Could not create datastore client: %v", err)
	}
	// Note: call the following from main() to ensure the client
	// properly frees all resources.
	// defer client.Close()
	return client, nil
}

Java

// Create an authorized Datastore service using Application Default Credentials.
private final Datastore datastore = DatastoreOptions.getDefaultInstance().getService();

// Create a Key factory to construct keys associated with this project.
private final KeyFactory keyFactory = datastore.newKeyFactory().setKind("Task");

Node.js

// By default, the client will authenticate using the service account file
// specified by the GOOGLE_APPLICATION_CREDENTIALS environment variable and use
// the project specified by the GCLOUD_PROJECT environment variable. See
// https://googlecloudplatform.github.io/google-cloud-node/#/docs/datastore/latest/guides/authentication
const {Datastore} = require('@google-cloud/datastore');

// Creates a client
const datastore = new Datastore();

PHP

use Google\Cloud\Datastore\DatastoreClient;

/**
 * Create a Cloud Datastore client.
 *
 * @param string $projectId The Google Cloud project ID.
 */
function build_service(string $projectId)
{
    $datastore = new DatastoreClient(['projectId' => $projectId]);
    return $datastore;
}

Python

from google.cloud import datastore

def create_client(project_id):
    return datastore.Client(project_id)

Ruby

require "google/cloud/datastore"

datastore = Google::Cloud::Datastore.new

Archiviazione dei dati

Gli oggetti in modalità Datastore sono noti come entità e ogni entità è di un determinato tipo. L'applicazione TaskList memorizzerà entità di tipo Task, con le seguenti proprietà:

description: una stringa specificata dall'utente come descrizione dell'attività
created: una data che mostra la data di creazione iniziale dell'attività
done: un valore booleano che indica se l'attività è stata completata

Quando l'utente aggiunge una nuova attività, l'applicazione TaskList crea un'entità Task con i valori per le proprietà elencate in precedenza:

C#

/// <summary>
///  Adds a task entity to the Datastore
/// </summary>
/// <param name="description">The task description.</param>
/// <returns>The key of the entity.</returns>
Key AddTask(string description)
{
    Entity task = new Entity()
    {
        Key = _keyFactory.CreateIncompleteKey(),
        ["description"] = new Value()
        {
            StringValue = description,
            ExcludeFromIndexes = true
        },
        ["created"] = DateTime.UtcNow,
        ["done"] = false
    };
    return _db.Insert(task);
}

Go

import (
	"context"
	"log"
	"time"

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

// Task is the model used to store tasks in the datastore.
type Task struct {
	Desc    string    `datastore:"description"`
	Created time.Time `datastore:"created"`
	Done    bool      `datastore:"done"`
	id      int64     // The integer ID used in the datastore.
}

// AddTask adds a task with the given description to the datastore,
// returning the key of the newly created entity.
func AddTask(projectID string, desc string) (*datastore.Key, error) {
	ctx := context.Background()
	client, err := datastore.NewClient(ctx, projectID)
	if err != nil {
		log.Fatalf("Could not create datastore client: %v", err)
	}
	defer client.Close()
	task := &Task{
		Desc:    desc,
		Created: time.Now(),
	}
	key := datastore.IncompleteKey("Task", nil)
	return client.Put(ctx, key, task)

}

Java

/**
 * Adds a task entity to the Datastore.
 *
 * @param description The task description
 * @return The {@link Key} of the entity
 * @throws DatastoreException if the ID allocation or put fails
 */
Key addTask(String description) {
  Key key = datastore.allocateId(keyFactory.newKey());
  Entity task =
      Entity.newBuilder(key)
          .set(
              "description",
              StringValue.newBuilder(description).setExcludeFromIndexes(true).build())
          .set("created", Timestamp.now())
          .set("done", false)
          .build();
  datastore.put(task);
  return key;
}

Node.js

async function addTask(description) {
  const taskKey = datastore.key('Task');
  const entity = {
    key: taskKey,
    data: [
      {
        name: 'created',
        value: new Date().toJSON(),
      },
      {
        name: 'description',
        value: description,
        excludeFromIndexes: true,
      },
      {
        name: 'done',
        value: false,
      },
    ],
  };

  try {
    await datastore.save(entity);
    console.log(`Task ${taskKey.id} created successfully.`);
  } catch (err) {
    console.error('ERROR:', err);
  }
}

PHP

use Google\Cloud\Datastore\DatastoreClient;

/**
 * Create a new task with a given description.
 *
 * @param string $projectId The Google Cloud project ID.
 * @param string $description
 */
function add_task(string $projectId, string $description)
{
    $datastore = new DatastoreClient(['projectId' => $projectId]);

    $taskKey = $datastore->key('Task');
    $task = $datastore->entity(
        $taskKey,
        [
            'created' => new DateTime(),
            'description' => $description,
            'done' => false
        ],
        ['excludeFromIndexes' => ['description']]
    );
    $datastore->insert($task);
    printf('Created new task with ID %d.' . PHP_EOL, $task->key()->pathEnd()['id']);
}

Python

from google.cloud import datastore

def add_task(client: datastore.Client, description: str):
    # Create an incomplete key for an entity of kind "Task". An incomplete
    # key is one where Datastore will automatically generate an Id
    key = client.key("Task")

    # Create an unsaved Entity object, and tell Datastore not to index the
    # `description` field
    task = datastore.Entity(key, exclude_from_indexes=("description",))

    # Apply new field values and save the Task entity to Datastore
    task.update(
        {
            "created": datetime.datetime.now(tz=datetime.timezone.utc),
            "description": description,
            "done": False,
        }
    )
    client.put(task)
    return task.key

Ruby

def add_task description
  require "google/cloud/datastore"

  datastore = Google::Cloud::Datastore.new

  task = datastore.entity "Task" do |t|
    t["description"] = description
    t["created"]     = Time.now
    t["done"]        = false
    t.exclude_from_indexes! "description", true
  end

  datastore.save task

  puts task.key.id

  task.key.id
end

Per questa applicazione, forniamo anche un metodo per aggiornare la proprietà done, per indicare che l'attività è stata completata:

C#

/// <summary>
/// Marks a task entity as done.
/// </summary>
/// <param name="id">The ID of the task entity as given by Key.</param>
/// <returns>true if the task was found.</returns>
bool MarkDone(long id)
{
    using (var transaction = _db.BeginTransaction())
    {
        Entity task = transaction.Lookup(_keyFactory.CreateKey(id));
        if (task != null)
        {
            task["done"] = true;
            transaction.Update(task);
        }
        transaction.Commit();
        return task != null;
    }
}

Go

import (
	"context"
	"log"

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

// MarkDone marks the task done with the given ID.
func MarkDone(projectID string, taskID int64) error {
	ctx := context.Background()
	client, err := datastore.NewClient(ctx, projectID)
	if err != nil {
		log.Fatalf("Could not create datastore client: %v", err)
	}
	defer client.Close()
	// Create a key using the given integer ID.
	key := datastore.IDKey("Task", taskID, nil)

	// In a transaction load each task, set done to true and store.
	_, err = client.RunInTransaction(ctx, func(tx *datastore.Transaction) error {
		var task Task
		if err := tx.Get(key, &task); err != nil {
			return err
		}
		task.Done = true
		_, err := tx.Put(key, &task)
		return err
	})
	return err
}

Java

/**
 * Marks a task entity as done.
 *
 * @param id The ID of the task entity as given by {@link Key#id()}
 * @return true if the task was found, false if not
 * @throws DatastoreException if the transaction fails
 */
boolean markDone(long id) {
  Transaction transaction = datastore.newTransaction();
  try {
    Entity task = transaction.get(keyFactory.newKey(id));
    if (task != null) {
      transaction.put(Entity.newBuilder(task).set("done", true).build());
    }
    transaction.commit();
    return task != null;
  } finally {
    if (transaction.isActive()) {
      transaction.rollback();
    }
  }
}

Node.js

async function markDone(taskId) {
  const transaction = datastore.transaction();
  const taskKey = datastore.key(['Task', datastore.int(taskId)]);

  try {
    await transaction.run();
    const [task] = await transaction.get(taskKey);
    task.done = true;
    transaction.save({
      key: taskKey,
      data: task,
    });
    await transaction.commit();
    console.log(`Task ${taskId} updated successfully.`);
  } catch (err) {
    await transaction.rollback();
  }
}

PHP

use Google\Cloud\Datastore\DatastoreClient;

/**
 * Mark a task with a given id as done.
 *
 * @param string $projectId The Google Cloud project ID.
 * @param string $taskId
 */
function mark_done(string $projectId, string $taskId)
{
    $datastore = new DatastoreClient(['projectId' => $projectId]);

    $taskKey = $datastore->key('Task', $taskId);
    $transaction = $datastore->transaction();
    $task = $transaction->lookup($taskKey);
    $task['done'] = true;
    $transaction->upsert($task);
    $transaction->commit();
    printf('Task %d updated successfully.' . PHP_EOL, $taskId);
}

Python

from google.cloud import datastore

def mark_done(client: datastore.Client, task_id: str | int):
    with client.transaction():
        # Create a key for an entity of kind "Task", and with the supplied
        # `task_id` as its Id
        key = client.key("Task", task_id)
        # Use that key to load the entity
        task = client.get(key)

        if not task:
            raise ValueError(f"Task {task_id} does not exist.")

        # Update a field indicating that the associated
        # work has been completed
        task["done"] = True

        # Persist the change back to Datastore
        client.put(task)

Ruby

def mark_done task_id
  require "google/cloud/datastore"

  datastore = Google::Cloud::Datastore.new

  task = datastore.find "Task", task_id

  task["done"] = true

  datastore.save task
end

Ecco il metodo per eliminare un'entità Task, utilizzando la chiave dell'entità Task:

C#

/// <summary>
/// Deletes a task entity.
/// </summary>
/// <param name="id">The ID of the task entity as given by Key.</param>
void DeleteTask(long id)
{
    _db.Delete(_keyFactory.CreateKey(id));
}

Go

import (
	"context"
	"log"

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

// DeleteTask deletes the task with the given ID.
func DeleteTask(projectID string, taskID int64) error {
	ctx := context.Background()
	client, err := datastore.NewClient(ctx, projectID)
	if err != nil {
		log.Fatalf("Could not create datastore client: %v", err)
	}
	return client.Delete(ctx, datastore.IDKey("Task", taskID, nil))
}

Java

/**
 * Deletes a task entity.
 *
 * @param id The ID of the task entity as given by {@link Key#id()}
 * @throws DatastoreException if the delete fails
 */
void deleteTask(long id) {
  datastore.delete(keyFactory.newKey(id));
}

Node.js

async function deleteTask(taskId) {
  const taskKey = datastore.key(['Task', datastore.int(taskId)]);

  await datastore.delete(taskKey);
  console.log(`Task ${taskId} deleted successfully.`);
}

PHP

use Google\Cloud\Datastore\DatastoreClient;

/**
 * Delete a task with a given id.
 *
 * @param string $projectId The Google Cloud project ID.
 * @param string $taskId
 */
function delete_task(string $projectId, string $taskId)
{
    $datastore = new DatastoreClient(['projectId' => $projectId]);

    $taskKey = $datastore->key('Task', $taskId);
    $datastore->delete($taskKey);

    printf('Task %d deleted successfully.' . PHP_EOL, $taskId);
}

Python

from google.cloud import datastore

def delete_task(client: datastore.Client, task_id: str | int):
    # Create a key for an entity of kind "Task", and with the supplied
    # `task_id` as its Id
    key = client.key("Task", task_id)
    # Use that key to delete its associated document, if it exists
    client.delete(key)

Ruby

def delete_task task_id
  require "google/cloud/datastore"

  datastore = Google::Cloud::Datastore.new

  task = datastore.find "Task", task_id

  datastore.delete task
end

Esecuzione di una query

Oltre a recuperare le entità dalla modalità Datastore direttamente tramite le rispettive chiavi, un'applicazione può eseguire una query per recuperarle in base ai valori delle relative proprietà. Una query tipica include quanto segue:

Un tipo di entità a cui si applica la query
Zero o più filtri, ad esempio per selezionare tipi con proprietà corrispondenti a un valore
Zero o più ordinamenti per sequenziare i risultati

Per questa applicazione, eseguiremo una query in modalità Datastore per Task entità ordinate in base alla data di creazione:

C#

/// <summary>
/// Returns a list of all task entities in ascending order of creation time.
/// </summary>
IEnumerable<Entity> ListTasks()
{
    Query query = new Query("Task")
    {
        Order = { { "created", PropertyOrder.Types.Direction.Descending } }
    };
    return _db.RunQuery(query).Entities;
}

Go

import (
	"context"
	"log"

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

// ListTasks returns all the tasks in ascending order of creation time.
func ListTasks(projectID string) ([]*Task, error) {
	ctx := context.Background()
	client, err := datastore.NewClient(ctx, projectID)
	if err != nil {
		log.Fatalf("Could not create datastore client: %v", err)
	}

	var tasks []*Task
	// Create a query to fetch all Task entities, ordered by "created".
	query := datastore.NewQuery("Task").Order("created")
	keys, err := client.GetAll(ctx, query, &tasks)
	if err != nil {
		return nil, err
	}

	// Set the id field on each Task from the corresponding key.
	for i, key := range keys {
		tasks[i].id = key.ID
	}

	return tasks, nil
}

Java

/**
 * Returns a list of all task entities in ascending order of creation time.
 *
 * @throws DatastoreException if the query fails
 */
Iterator<Entity> listTasks() {
  Query<Entity> query =
      Query.newEntityQueryBuilder().setKind("Task").setOrderBy(OrderBy.asc("created")).build();
  return datastore.run(query);
}

Node.js

async function listTasks() {
  const query = datastore.createQuery('Task').order('created');

  const [tasks] = await datastore.runQuery(query);
  console.log('Tasks:');
  tasks.forEach(task => {
    const taskKey = task[datastore.KEY];
    console.log(taskKey.id, task);
  });
}

PHP

use Google\Cloud\Datastore\DatastoreClient;

/**
 * Return an iterator for all the tasks in ascending order of creation time.
 *
 * @param string $projectId The Google Cloud project ID.
 */
function list_tasks(string $projectId)
{
    $datastore = new DatastoreClient(['projectId' => $projectId]);

    $query = $datastore->query()
        ->kind('Task')
        ->order('created');
    $result = $datastore->runQuery($query);
    /* @var Entity $task */
    foreach ($result as $index => $task) {
        printf('ID: %s' . PHP_EOL, $task->key()->pathEnd()['id']);
        printf('  Description: %s' . PHP_EOL, $task['description']);
        printf('  Status: %s' . PHP_EOL, $task['done'] ? 'done' : 'created');
        printf('  Created: %s' . PHP_EOL, $task['created']->format('Y-m-d H:i:s e'));
        print(PHP_EOL);
    }
}

Python

from google.cloud import datastore

def list_tasks(client: datastore.Client):
    # Create a query against all of your objects of kind "Task"
    query = client.query(kind="Task")
    query.order = ["created"]

    return list(query.fetch())

Ruby

def list_tasks
  require "google/cloud/datastore"

  datastore = Google::Cloud::Datastore.new

  query = datastore.query("Task").order("created")
  tasks = datastore.run query

  tasks.each do |t|
    puts t["description"]
    puts t["done"] ? "  Done" : "  Not Done"
    puts "  ID: #{t.key.id}"
  end
end

Passaggi successivi

Questo tutorial illustra solo i passaggi di base necessari per effettuare chiamate all'API in modalità Datastore da un'applicazione a riga di comando. La modalità Datastore supporta transazioni ACID rapide e altamente scalabili, query di tipo SQL, indici e altro ancora.

Per una panoramica più approfondita delle funzionalità della modalità Datastore, consulta Che cos'è Firestore in modalità Datastore?.
Per informazioni sull'utilizzo dell'emulatore di modalità Datastore durante lo sviluppo dell'applicazione, consulta Emulatore di modalità Datastore.