Criar e gerenciar instâncias

Nesta página, descrevemos como criar, listar, editar e excluir instâncias do Spanner.

Observação: para explorar o Spanner usando uma instância de teste gratuito de 90 dias, consulte Criar uma instância de teste gratuito do Spanner.

criar uma instância

É possível criar uma instância com o console do Google Cloud, a Google Cloud CLI ou as bibliotecas de cliente. Também é possível criar uma instância com uma configuração de instância personalizada adicionando réplicas somente leitura opcionais.

Observação: você não precisa provisionar o armazenamento no Spanner e será cobrado apenas pelo armazenamento que usar. Saiba mais sobre os preços de armazenamento.

Console

1. Acesse a página Criar uma instância no Console do Google Cloud.

   Criar uma instância

2. Digite um Nome de instância para exibir no console do Google Cloud. O nome da instância precisa ser exclusivo no projeto do Google Cloud.

3. Insira o ID da instância para identificá-la permanentemente. Ele também precisa ser exclusivo no projeto do Google Cloud. Não será possível alterá-lo depois.

4. Em Escolher uma configuração, clique em Regional ou Multirregional. Como alternativa, se você quiser comparar as especificações entre duas regiões, clique em Comparar configurações de região.

5. Selecione uma configuração no menu suspenso.

6. Opcional: adicione réplicas somente leitura para escalonar leituras e oferecer suporte a leituras desatualizadas de baixa latência. Quando você cria e adiciona uma réplica somente leitura a uma configuração de instância usando o console do Google Cloud, a configuração de instância personalizada é criada automaticamente. Para adicionar uma réplica somente leitura, faça o seguinte:

   1. Expanda Configurar réplicas somente leitura.

   2. Clique em Adicionar réplica somente leitura.

   3. Selecione uma região e um número.

7. Na seção Configurar capacidade de computação, em Selecionar unidade, clique em uma das seguintes opções:

   • Unidades de processamento para instâncias pequenas.
   • Nós para instâncias grandes. Um nó tem 1.000 unidades de processamento.

   Para mais informações, consulte Capacidade de computação, nós e unidades de processamento.

8. Em Escolha um modo de escalonamento, clique em uma das seguintes opções:

   • Alocação manual: se você quiser definir manualmente a capacidade de computação de custos e recursos fixos de computação.

     • Quantidade indica o número de nós ou unidades de processamento a serem usados para essa instância.

   • Escalonamento automático (Pré-lançamento) para permitir que o Spanner adicione e remova automaticamente a capacidade de computação. Para mais informações sobre o escalonador automático gerenciado, consulte Escalonador automático gerenciado para o Spanner. Configure as seguintes opções do escalonador automático gerenciado:

     • Mínimo indica o limite mínimo de redução da escala vertical, dependendo da unidade de medida escolhida para Capacidade de computação. Para mais informações, consulte Determinar o limite mínimo.
     • Máximo indica o limite máximo de escalonamento vertical, dependendo da unidade de medida escolhida para Capacidade de computação. Para mais informações, consulte Determinar o limite máximo.
     • Meta de utilização da CPU de alta prioridade indica a porcentagem desejada de CPU de alta prioridade a ser usada. Para mais informações, consulte Determinar a meta de utilização da CPU.
     • A meta de utilização do armazenamento indica a porcentagem desejada de armazenamento a ser usada. Para mais informações, consulte Determinar o destino de utilização do armazenamento.

9. Clique em Criar para gerar a instância.

gcloud

Use o comando gcloud spanner instances create para criar uma instância. Especifique a capacidade de computação como o número de nós ou unidades de processamento que você quer na instância.

gcloud spanner instances create INSTANCE-ID \
--config=INSTANCE-CONFIG \
--description=INSTANCE-DESCRIPTION \
--nodes=NODE-COUNT

ou

gcloud spanner instances create INSTANCE-ID \
--config=INSTANCE-CONFIG \
--description=INSTANCE-DESCRIPTION \
--processing-units=PROCESSING-UNIT-COUNT

Substitua:

• INSTANCE-ID: um identificador permanente exclusivo no projeto do Google Cloud. Não será possível alterá-lo depois.
• INSTANCE-CONFIG: identificador permanente da configuração da instância, que define a localização geográfica dela e afeta como os dados são replicados. Para configurações de instâncias personalizadas, ele começa com custom-. Para mais informações, consulte configurações de instâncias.
• INSTANCE-DESCRIPTION: o nome a ser exibido para a instância no console do Google Cloud. O nome da instância precisa ser exclusivo no projeto do Google Cloud.

• NODE-COUNT: a capacidade de computação da instância, expressa como um número de nós. Cada nó é igual a 1.000 unidades de processamento.

• PROCESSING-UNIT-COUNT: a capacidade de computação da instância, expressa como um número de unidades de processamento. Insira quantidades de até 1.000 em múltiplos de 100 (100, 200, 300 e assim por diante) e insira quantidades maiores em múltiplos de 1.000 (1.000, 2000, 3000 e assim por diante). Observação: não use esse parâmetro ao criar uma instância que você pretende ativar com o escalonador automático gerenciado mais tarde.

Adicionar escalonamento automático gerenciado (pré-lançamento)

Também é possível configurar novas instâncias para usar o escalonamento automático gerenciado com o comando gcloud beta spanner instances create. Para mais informações, consulte Escalonador automático gerenciado para o Spanner.

Use o comando a seguir para criar uma instância com o escalonador automático gerenciado.

  gcloud beta spanner instances create INSTANCE-ID \
    --config=INSTANCE-CONFIG \
    --description=INSTANCE-DESCRIPTION \
    --autoscaling-min-processing-units=MINIMUM_PROCESSING_UNITS \
    --autoscaling-max-processing-units=MAXIMUM_PROCESSING_UNITS \
    --autoscaling-high-priority-cpu-target=CPU_PERCENTAGE \
    --autoscaling-storage-target=STORAGE_PERCENTAGE

ou

  gcloud beta spanner instances create INSTANCE-ID \
    --config=INSTANCE-CONFIG \
    --description=INSTANCE-DESCRIPTION \
    --autoscaling-min-nodes=MINIMUM_NODES \
    --autoscaling-max-nodes=MAXIMUM_NODES \
    --autoscaling-high-priority-cpu-target=CPU_PERCENTAGE \
    --autoscaling-storage-target=STORAGE_PERCENTAGE

Substitua:

• INSTANCE-ID: um identificador permanente exclusivo no projeto do Google Cloud. Não será possível alterá-lo depois.
• INSTANCE-CONFIG: identificador permanente da configuração da instância, que define a localização geográfica dela e afeta como os dados são replicados. Para configurações de instâncias personalizadas, ele começa com custom-. Para mais informações, consulte configurações de instâncias.
• INSTANCE-DESCRIPTION: o nome a ser exibido para a instância no console do Google Cloud. O nome da instância precisa ser exclusivo no projeto do Google Cloud.
• MINIMUM_PROCESSING_UNITS, MINIMUM_NODES: o número mínimo de unidades de processamento ou nós ao reduzir a escala. Para mais informações, consulte Determinar o limite mínimo.
• MAXIMUM_PROCESSING_UNITS, MAXIMUM_NODES: o número máximo de unidades de processamento ou nós ao escalonar verticalmente. Para mais informações, consulte Determinar o limite máximo.
• CPU_PERCENTAGE: a porcentagem desejada de CPU de alta prioridade a ser usada, de 10 a 90%. Se você estiver otimizando o custo, use uma porcentagem maior. Para mais informações, consulte Determinar a meta de utilização da CPU.
• STORAGE_PERCENTAGE: a porcentagem desejada de armazenamento a ser usada, de 10 a 99%. Para mais informações, consulte Determinar a meta de utilização do armazenamento.

Exemplos de uso de configurações personalizadas

Para criar uma instância test-instance na configuração de instâncias regionais de base us-central1, execute:

gcloud spanner instances create test-instance --config=regional-us-central1 \
  --description="Test Instance" --nodes=1

Para criar uma instância custom-eur6-instance na configuração de instância multirregional personalizada custom-eur6, primeiro crie uma configuração de instância personalizada.

Depois, execute:

  gcloud spanner instances create custom-eur6-instance --config=custom-eur6 \
      --description="Instance with custom read-only" --nodes=1

Você verá uma mensagem semelhante ao exemplo a seguir depois de executar um dos comandos acima:

Creating instance...done.

C++

Para saber como instalar e usar a biblioteca de cliente para o Spanner, consulte Bibliotecas de cliente do Spanner.

Para autenticar no Spanner, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

void CreateInstance(google::cloud::spanner_admin::InstanceAdminClient client,
                    std::string const& project_id,
                    std::string const& instance_id,
                    std::string const& display_name,
                    std::string const& config_id) {
  namespace spanner = ::google::cloud::spanner;
  spanner::Instance in(project_id, instance_id);

  auto project = google::cloud::Project(project_id);
  std::string config_name =
      project.FullName() + "/instanceConfigs/" + config_id;
  auto instance =
      client
          .CreateInstance(spanner::CreateInstanceRequestBuilder(in, config_name)
                              .SetDisplayName(display_name)
                              .SetNodeCount(1)
                              .SetLabels({{"cloud_spanner_samples", "true"}})
                              .Build())
          .get();
  if (!instance) throw std::move(instance).status();
  std::cout << "Created instance [" << in << "]:\n" << instance->DebugString();
}

C#

Para saber como instalar e usar a biblioteca de cliente para o Spanner, consulte Bibliotecas de cliente do Spanner.

Para autenticar no Spanner, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

using Google.Api.Gax.ResourceNames;
using Google.Cloud.Spanner.Admin.Instance.V1;
using Google.Cloud.Spanner.Common.V1;
using Google.LongRunning;
using System;

public class CreateInstanceSample
{
    public Instance CreateInstance(string projectId, string instanceId)
    {
        // Create the InstanceAdminClient instance.
        InstanceAdminClient instanceAdminClient = InstanceAdminClient.Create();

        // Initialize request parameters.
        Instance instance = new Instance
        {
            InstanceName = InstanceName.FromProjectInstance(projectId, instanceId),
            ConfigAsInstanceConfigName = InstanceConfigName.FromProjectInstanceConfig(projectId, "regional-us-central1"),
            DisplayName = "This is a display name.",
            NodeCount = 1,
            Labels =
            {
                { "cloud_spanner_samples", "true" },
            }
        };
        ProjectName projectName = ProjectName.FromProject(projectId);

        // Make the CreateInstance request.
        Operation<Instance, CreateInstanceMetadata> response = instanceAdminClient.CreateInstance(projectName, instanceId, instance);

        Console.WriteLine("Waiting for the operation to finish.");

        // Poll until the returned long-running operation is complete.
        Operation<Instance, CreateInstanceMetadata> completedResponse = response.PollUntilCompleted();

        if (completedResponse.IsFaulted)
        {
            Console.WriteLine($"Error while creating instance: {completedResponse.Exception}");
            throw completedResponse.Exception;
        }

        Console.WriteLine($"Instance created successfully.");

        return completedResponse.Result;
    }
}

Go

Para saber como instalar e usar a biblioteca de cliente para o Spanner, consulte Bibliotecas de cliente do Spanner.

Para autenticar no Spanner, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

import (
	"context"
	"fmt"
	"io"

	instance "cloud.google.com/go/spanner/admin/instance/apiv1"
	instancepb "google.golang.org/genproto/googleapis/spanner/admin/instance/v1"
)

func createInstance(w io.Writer, projectID, instanceID string) error {
	// projectID := "my-project-id"
	// instanceID := "my-instance"
	ctx := context.Background()
	instanceAdmin, err := instance.NewInstanceAdminClient(ctx)
	if err != nil {
		return err
	}
	defer instanceAdmin.Close()

	op, err := instanceAdmin.CreateInstance(ctx, &instancepb.CreateInstanceRequest{
		Parent:     fmt.Sprintf("projects/%s", projectID),
		InstanceId: instanceID,
		Instance: &instancepb.Instance{
			Config:      fmt.Sprintf("projects/%s/instanceConfigs/%s", projectID, "regional-us-central1"),
			DisplayName: instanceID,
			NodeCount:   1,
			Labels:      map[string]string{"cloud_spanner_samples": "true"},
		},
	})
	if err != nil {
		return fmt.Errorf("could not create instance %s: %w", fmt.Sprintf("projects/%s/instances/%s", projectID, instanceID), err)
	}
	// Wait for the instance creation to finish.
	i, err := op.Wait(ctx)
	if err != nil {
		return fmt.Errorf("waiting for instance creation to finish failed: %w", err)
	}
	// The instance may not be ready to serve yet.
	if i.State != instancepb.Instance_READY {
		fmt.Fprintf(w, "instance state is not READY yet. Got state %v\n", i.State)
	}
	fmt.Fprintf(w, "Created instance [%s]\n", instanceID)
	return nil
}

Criar uma instância com escalonamento automático gerenciado usando Go (Prévia)

import (
	"context"
	"fmt"
	"io"

	instance "cloud.google.com/go/spanner/admin/instance/apiv1"
	"cloud.google.com/go/spanner/admin/instance/apiv1/instancepb"
	"google.golang.org/genproto/protobuf/field_mask"
)

// Example of creating an autoscaling instance with Go.
// projectID is the ID of the project that the new instance will be in.
// instanceID is the ID of the new instance to be created.
func createInstanceWithAutoscalingConfig(w io.Writer, projectID, instanceID string) error {
	// projectID := "my-project-id"
	// instanceID := "my-instance"
	ctx := context.Background()
	instanceAdmin, err := instance.NewInstanceAdminClient(ctx)
	if err != nil {
		return fmt.Errorf("could not create instance admin client for project %s: %w", projectID, err)
	}
	defer instanceAdmin.Close()

	instanceName := fmt.Sprintf("projects/%s/instances/%s", projectID, instanceID)
	fmt.Fprintf(w, "Creating instance %s.", instanceName)

	op, err := instanceAdmin.CreateInstance(ctx, &instancepb.CreateInstanceRequest{
		Parent:     fmt.Sprintf("projects/%s", projectID),
		InstanceId: instanceID,
		Instance: &instancepb.Instance{
			Config:      fmt.Sprintf("projects/%s/instanceConfigs/%s", projectID, "regional-us-central1"),
			DisplayName: "Create instance example",
			AutoscalingConfig: &instancepb.AutoscalingConfig{
				AutoscalingLimits: &instancepb.AutoscalingConfig_AutoscalingLimits{
					MinLimit: &instancepb.AutoscalingConfig_AutoscalingLimits_MinNodes{
						MinNodes: 1,
					},
					MaxLimit: &instancepb.AutoscalingConfig_AutoscalingLimits_MaxNodes{
						MaxNodes: 2,
					},
				},
				AutoscalingTargets: &instancepb.AutoscalingConfig_AutoscalingTargets{
					HighPriorityCpuUtilizationPercent: 65,
					StorageUtilizationPercent:         95,
				},
			},
			Labels: map[string]string{"cloud_spanner_samples": "true"},
		},
	})
	if err != nil {
		return fmt.Errorf("could not create instance %s: %w", instanceName, err)
	}
	fmt.Fprintf(w, "Waiting for operation on %s to complete...", instanceID)
	// Wait for the instance creation to finish.
	i, err := op.Wait(ctx)
	if err != nil {
		return fmt.Errorf("waiting for instance creation to finish failed: %w", err)
	}
	// The instance may not be ready to serve yet.
	if i.State != instancepb.Instance_READY {
		fmt.Fprintf(w, "instance state is not READY yet. Got state %v\n", i.State)
	}
	fmt.Fprintf(w, "Created instance [%s].\n", instanceID)

	instance, err := instanceAdmin.GetInstance(ctx, &instancepb.GetInstanceRequest{
		Name: instanceName,
		// Get the autoscaling_config field from the newly created instance.
		FieldMask: &field_mask.FieldMask{Paths: []string{"autoscaling_config"}},
	})
	if err != nil {
		return fmt.Errorf("failed to get instance [%s]: %w", instanceName, err)
	}
	fmt.Fprintf(w, "Instance %s has autoscaling_config: %s.", instanceID, instance.AutoscalingConfig)
	return nil
}

Java

Para saber como instalar e usar a biblioteca de cliente para o Spanner, consulte Bibliotecas de cliente do Spanner.

Para autenticar no Spanner, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
import com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient;
import com.google.spanner.admin.instance.v1.CreateInstanceRequest;
import com.google.spanner.admin.instance.v1.Instance;
import com.google.spanner.admin.instance.v1.InstanceConfigName;
import com.google.spanner.admin.instance.v1.ProjectName;
import java.util.concurrent.ExecutionException;

class CreateInstanceExample {

  static void createInstance() {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project";
    String instanceId = "my-instance";
    createInstance(projectId, instanceId);
  }

  static void createInstance(String projectId, String instanceId) {
    // Set Instance configuration.
    int nodeCount = 2;
    String displayName = "Descriptive name";

    // Create an Instance object that will be used to create the instance.
    Instance instance =
        Instance.newBuilder()
            .setDisplayName(displayName)
            .setNodeCount(nodeCount)
            .setConfig(
                InstanceConfigName.of(projectId, "regional-us-central1").toString())
            .build();

    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(projectId)
            .build()
            .getService();
        InstanceAdminClient instanceAdminClient = spanner.createInstanceAdminClient()) {

      // Wait for the createInstance operation to finish.
      Instance createdInstance = instanceAdminClient.createInstanceAsync(
          CreateInstanceRequest.newBuilder()
              .setParent(ProjectName.of(projectId).toString())
              .setInstanceId(instanceId)
              .setInstance(instance)
              .build()).get();
      System.out.printf("Instance %s was successfully created%n", createdInstance.getName());
    } catch (ExecutionException e) {
      System.out.printf(
          "Error: Creating instance %s failed with error message %s%n",
          instance.getName(), e.getMessage());
    } catch (InterruptedException e) {
      System.out.println("Error: Waiting for createInstance operation to finish was interrupted");
    }
  }
}

Observação:os exemplos de código da interface da biblioteca de cliente antigos para Java estão arquivados no GitHub (em inglês).

Criar uma instância com escalonamento automático gerenciado usando Java (prévia)

import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
import com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient;
import com.google.spanner.admin.instance.v1.AutoscalingConfig;
import com.google.spanner.admin.instance.v1.CreateInstanceRequest;
import com.google.spanner.admin.instance.v1.Instance;
import com.google.spanner.admin.instance.v1.InstanceConfigName;
import com.google.spanner.admin.instance.v1.ProjectName;
import java.util.concurrent.ExecutionException;

class CreateInstanceWithAutoscalingConfigExample {

  static void createInstance() {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project";
    String instanceId = "my-instance";
    createInstance(projectId, instanceId);
  }

  static void createInstance(String projectId, String instanceId) {
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(projectId)
            .build()
            .getService();
        InstanceAdminClient instanceAdminClient = spanner.createInstanceAdminClient()) {
      // Set Instance configuration.
      String configId = "regional-us-central1";
      String displayName = "Descriptive name";

      // Create an autoscaling config.
      // When autoscaling_config is enabled, node_count and processing_units fields
      // need not be specified.
      AutoscalingConfig autoscalingConfig =
          AutoscalingConfig.newBuilder()
              .setAutoscalingLimits(
                  AutoscalingConfig.AutoscalingLimits.newBuilder().setMinNodes(1).setMaxNodes(2))
              .setAutoscalingTargets(
                  AutoscalingConfig.AutoscalingTargets.newBuilder()
                      .setHighPriorityCpuUtilizationPercent(65)
                      .setStorageUtilizationPercent(95))
              .build();
      Instance instance =
          Instance.newBuilder()
              .setAutoscalingConfig(autoscalingConfig)
              .setDisplayName(displayName)
              .setConfig(
                  InstanceConfigName.of(projectId, configId).toString())
              .build();

      // Creates a new instance
      System.out.printf("Creating instance %s.%n", instanceId);
      try {
        // Wait for the createInstance operation to finish.
        Instance instanceResult = instanceAdminClient.createInstanceAsync(
            CreateInstanceRequest.newBuilder()
                .setParent(ProjectName.of(projectId).toString())
                .setInstanceId(instanceId)
                .setInstance(instance)
                .build()).get();
        System.out.printf("Autoscaler instance %s was successfully created%n",
            instanceResult.getName());
      } catch (ExecutionException e) {
        System.out.printf(
            "Error: Creating instance %s failed with error message %s%n",
            instance.getName(), e.getMessage());
      } catch (InterruptedException e) {
        System.out.println("Error: Waiting for createInstance operation to finish was interrupted");
      }
    }
  }
}

Node.js

Para saber como instalar e usar a biblioteca de cliente para o Spanner, consulte Bibliotecas de cliente do Spanner.

Para autenticar no Spanner, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

// Imports the Google Cloud client library
const {Spanner} = require('@google-cloud/spanner');

// Creates a client
const spanner = new Spanner({
  projectId: projectId,
});

const instanceAdminClient = await spanner.getInstanceAdminClient();
/**
 * TODO(developer): Uncomment the following lines before running the sample.
 **/
// const projectId = 'my-project-id';
// const instanceId = 'my-instance';

// Creates a new instance
try {
  console.log(
    `Creating instance ${instanceAdminClient.instancePath(
      projectId,
      instanceId
    )}.`
  );
  const [operation] = await instanceAdminClient.createInstance({
    instanceId: instanceId,
    parent: instanceAdminClient.projectPath(projectId),
    instance: {
      config: instanceAdminClient.instanceConfigPath(
        projectId,
        'regional-us-central1'
      ),
      nodeCount: 1,
      displayName: 'Display name for the instance.',
      labels: {
        cloud_spanner_samples: 'true',
        created: Math.round(Date.now() / 1000).toString(), // current time
      },
    },
  });

  console.log(`Waiting for operation on ${instanceId} to complete...`);
  await operation.promise();

  console.log(`Created instance ${instanceId}.`);
} catch (err) {
  console.error('ERROR:', err);
}

Observação:os exemplos de código da interface da biblioteca de cliente antigos para Node.js estão arquivados no GitHub (em inglês).

PHP

Para saber como instalar e usar a biblioteca de cliente para o Spanner, consulte Bibliotecas de cliente do Spanner.

Para autenticar no Spanner, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

use Google\Cloud\Spanner\Admin\Instance\V1\Client\InstanceAdminClient;
use Google\Cloud\Spanner\Admin\Instance\V1\CreateInstanceRequest;
use Google\Cloud\Spanner\Admin\Instance\V1\Instance;

/**
 * Creates an instance.
 * Example:
 * ```
 * create_instance($projectId, $instanceId);
 * ```
 *
 * @param string $projectId  The Spanner project ID.
 * @param string $instanceId The Spanner instance ID.
 */
function create_instance(string $projectId, string $instanceId): void
{
    $instanceAdminClient = new InstanceAdminClient();
    $parent = InstanceAdminClient::projectName($projectId);
    $instanceName = InstanceAdminClient::instanceName($projectId, $instanceId);
    $configName = $instanceAdminClient->instanceConfigName($projectId, 'regional-us-central1');
    $instance = (new Instance())
        ->setName($instanceName)
        ->setConfig($configName)
        ->setDisplayName('dispName')
        ->setNodeCount(1);

    $operation = $instanceAdminClient->createInstance(
        (new CreateInstanceRequest())
        ->setParent($parent)
        ->setInstanceId($instanceId)
        ->setInstance($instance)
    );

    print('Waiting for operation to complete...' . PHP_EOL);
    $operation->pollUntilComplete();

    printf('Created instance %s' . PHP_EOL, $instanceId);
}

Observação:os exemplos de código da interface da biblioteca de cliente para PHP antigos estão arquivados no GitHub.

Python

Para saber como instalar e usar a biblioteca de cliente para o Spanner, consulte Bibliotecas de cliente do Spanner.

Para autenticar no Spanner, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

def create_instance(instance_id):
    """Creates an instance."""
    from google.cloud.spanner_admin_instance_v1.types import \
        spanner_instance_admin

    spanner_client = spanner.Client()

    config_name = "{}/instanceConfigs/regional-us-central1".format(
        spanner_client.project_name
    )

    operation = spanner_client.instance_admin_api.create_instance(
        parent=spanner_client.project_name,
        instance_id=instance_id,
        instance=spanner_instance_admin.Instance(
            config=config_name,
            display_name="This is a display name.",
            node_count=1,
            labels={
                "cloud_spanner_samples": "true",
                "sample_name": "snippets-create_instance-explicit",
                "created": str(int(time.time())),
            },
        ),
    )

    print("Waiting for operation to complete...")
    operation.result(OPERATION_TIMEOUT_SECONDS)

    print("Created instance {}".format(instance_id))

Observação:os antigos exemplos de código da interface da biblioteca de cliente para Python estão arquivados no GitHub (em inglês).

Ruby

Para saber como instalar e usar a biblioteca de cliente para o Spanner, consulte Bibliotecas de cliente do Spanner.

Para autenticar no Spanner, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

# project_id  = "Your Google Cloud project ID"
# instance_id = "Your Spanner instance ID"

require "google/cloud/spanner"
require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.instance_admin

project_path = instance_admin_client.project_path project: project_id
instance_path = instance_admin_client.instance_path project: project_id, instance: instance_id
instance_config_path = instance_admin_client.instance_config_path project: project_id, instance_config: "regional-us-central1"

job = instance_admin_client.create_instance parent: project_path,
                                            instance_id: instance_id,
                                            instance: { name: instance_path,
                                                        config: instance_config_path,
                                                        display_name: instance_id,
                                                        node_count: 2,
                                                        labels: { cloud_spanner_samples: "true" } }

puts "Waiting for create instance operation to complete"

job.wait_until_done!

if job.error?
  puts job.error
else
  puts "Created instance #{instance_id}"
end

Listar instâncias

É possível mostrar uma lista das suas instâncias do Spanner.

Console

Acesse a página Instâncias do Spanner no Console do Google Cloud.

Acessar a página "Instâncias"

O console do Google Cloud mostra uma lista das instâncias do Spanner, além do ID, nome de exibição, configuração e capacidade de computação de cada instância expresso em unidades de processamento e em nós.

gcloud

Use o comando gcloud spanner instances list:

gcloud spanner instances list

A CLI gcloud imprime uma lista de instâncias do Spanner, além do ID, nome de exibição, configuração e capacidade de computação de cada instância.

Editar uma instância

As seções a seguir explicam como alterar o nome de exibição e a capacidade de computação de uma instância. Não é possível alterar o código ou a configuração da instância.

Mudar o nome de exibição

Console

1. Acesse a página Instâncias do Spanner no Console do Google Cloud.

   Acessar a página "Instâncias"

2. Para renomear, clique no nome da instância.

3. Clique em Editar instância.

4. Insira um novo nome de instância. Esse nome precisa ser exclusivo no projeto do Google Cloud.

5. Clique em Salvar.

gcloud

Use o comando gcloud spanner instances update:

gcloud spanner instances update INSTANCE-ID --description=INSTANCE-NAME

Substitua:

• INSTANCE-ID: o identificador permanente da instância.
• INSTANCE-NAME: o nome a ser exibido para a instância no console do Google Cloud. O nome da instância precisa ser exclusivo no projeto do Google Cloud.

Mudar a capacidade de computação

É preciso provisionar capacidade de computação suficiente para manter a utilização da CPU e a utilização do armazenamento abaixo dos valores máximos recomendados. Para mais informações, consulte as cotas e limites do Spanner.

Existem alguns casos em que não é possível reduzir a capacidade de computação de uma instância atual:

• A remoção da capacidade de computação exigiria que sua instância armazenasse mais de 4 TB de dados por 1.000 unidades de processamento (1 nó).
• Com base nos padrões de uso históricos, o Spanner criou um grande número de divisões para os dados da instância e, em alguns casos raros, o Spanner não poderia gerenciar as divisões após a remoção da capacidade de computação.

No último caso, tente reduzir a capacidade de computação em quantidades cada vez menores até encontrar a capacidade mínima necessária para o Spanner gerenciar todas as divisões da instância. Se a instância não exigir mais tantas divisões devido a uma alteração nos padrões de uso, o Spanner poderá mesclar algumas divisões e permitir que você tente reduzir a capacidade de computação da instância ainda mais depois de uma ou duas semanas.

Ao remover a capacidade de computação, monitore o uso da CPU e solicite latências no Cloud Monitoring para garantir que a utilização permaneça abaixo de 65% para instâncias regionais e de 45% para cada região em instâncias multirregionais. Pode haver um aumento temporário nas latências de solicitação ao remover a capacidade de computação.

Se você quiser aumentar a capacidade de computação de uma instância, seu projeto do Google Cloud precisará ter cota suficiente para adicionar essa capacidade.

Console

1. Acesse a página Instâncias do Spanner no Console do Google Cloud.

   Acessar a página "Instâncias"

2. Clique no nome da instância a ser modificada.

3. Clique em Editar instância.

4. Para alterar a capacidade de computação, escolha as unidades de medida (unidades de processamento ou nós) e insira uma quantidade. Ao usar unidades de processamento, insira quantidades de até 1.000 em múltiplos de 100 (100, 200, 300 e assim por diante) e insira quantidades maiores em múltiplos de 1.000 (1.000, 2.000, 3.000 e assim por diante). Cada nó é igual a 1.000 unidades de processamento.

5. Clique em Salvar.

Se for exibida uma caixa de diálogo informando que sua cota é insuficiente para adicionar nós neste local, siga as instruções para solicitar uma cota maior.

gcloud

Use o comando gcloud spanner instances update. Ao usar esse comando, especifique a capacidade de computação como um número de nós ou unidades de processamento.

gcloud spanner instances update INSTANCE-ID --nodes=NODE-COUNT

ou

gcloud spanner instances update INSTANCE-ID
--processing-units=PROCESSING-UNIT-COUNT

Substitua:

• INSTANCE-ID: o identificador permanente da instância.
• NODE-COUNT: a capacidade de computação da instância, expressa como um número de nós. Cada nó é igual a 1.000 unidades de processamento.
• PROCESSING-UNIT-COUNT: a capacidade de computação da instância, expressa como um número de unidades de processamento. Insira quantidades de até 1.000 em múltiplos de 100 (100, 200, 300 e assim por diante) e insira quantidades maiores em múltiplos de 1.000 (1.000, 2000, 3000 e assim por diante).

Ativar ou modificar o escalonador automático gerenciado em uma instância

Visualização — Managed autoscaler

Esse recurso está sujeito aos "Termos de ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos de serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

As limitações a seguir se aplicam quando você adiciona ou altera o recurso de escalonamento automático gerenciado em uma instância atual:

• Não é possível ativar o escalonador automático gerenciado em uma instância que você está movendo.

• Não é possível mover uma instância enquanto o escalonador automático gerenciado está ativado.

Console

1. Acesse a página Instâncias do Spanner no Console do Google Cloud.

   Acessar a página "Instâncias"

2. Clique no nome da instância em que você quer ativar o escalonador automático gerenciado.

3. Clique em Editar instância.

4. Em Configurar capacidade de computação, clique em Escalonamento automático.

5. Em Mínimo, selecione o limite mínimo a ser usado ao reduzir a escala. Para mais informações, consulte Determinar o limite mínimo.

6. Em Máximo, selecione o limite máximo a ser usado ao escalonar verticalmente. Para mais informações, consulte Determinar o limite máximo.

7. Para Meta de utilização de CPU de alta prioridade, selecione a porcentagem de CPU de alta prioridade que será usada. Para mais informações, consulte Determinar a meta de utilização da CPU.

8. Em Meta de utilização do armazenamento, selecione a porcentagem de armazenamento que será usada. Para mais informações, consulte Determinar a meta de utilização do armazenamento.

9. Clique em Salvar.

gcloud

Use o comando gcloud beta spanner instances update para adicionar o escalonador automático gerenciado a uma instância. Para mais informações e limitações, consulte Flags e limitações do Google Cloud CLI.

Para adicionar o escalonador automático gerenciado, use o seguinte comando:

  gcloud beta spanner instances update \
    --autoscaling-min-processing-units=MINIMUM_PROCESSING_UNITS \
    --autoscaling-max-processing-units=MAXIMUM_PROCESSING_UNITS \
    --autoscaling-high-priority-cpu-target=CPU_PERCENTAGE \
    --autoscaling-storage-target=STORAGE_PERCENTAGE

ou

  gcloud beta spanner instances update \
    --autoscaling-min-processing-units=MINIMUM_NODES \
    --autoscaling-max-processing-units=MAXIMUM_NODES \
    --autoscaling-high-priority-cpu-target=CPU_PERCENTAGE \
    --autoscaling-storage-target=STORAGE_PERCENTAGE

Substitua:

• MINIMUM_PROCESSING_UNITS, MINIMUM_NODES: o número mínimo de unidades de processamento ou nós a serem usados durante a redução. Para mais informações, consulte Determinar o limite mínimo.
• MAXIMUM_PROCESSING_UNITS, MAXIMUM_NODES: o número máximo de unidades de processamento ou nós a serem usados no escalonamento vertical. Para mais informações, consulte Determinar o limite máximo.
• CPU_PERCENTAGE: a porcentagem desejada da CPU de alta prioridade a ser usada, de 10% a 90%. Se você estiver otimizando o custo e não precisar de baixa latência em todas as solicitações, use uma porcentagem maior. Para mais informações, consulte Determinar a meta de utilização da CPU.
• STORAGE_PERCENTAGE: a porcentagem desejada de armazenamento a ser usada, de 10% a 99%. Para mais informações, consulte Determinar o destino de utilização do armazenamento.

Depois de adicionar o escalonador automático gerenciado a uma instância, também é possível modificar as configurações dele. Por exemplo, se você quiser aumentar o número máximo de unidades de processamento para 10.000, execute o seguinte comando:

gcloud beta spanner instances update \
     --autoscaling-max-processing-units=10000

Alterar uma instância de escalonamento automático gerenciado para escalonamento manual

Visualização — Managed autoscaling

Esse recurso está sujeito aos "Termos de ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos de serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

Console

1. Acesse a página Instâncias do Spanner no Console do Google Cloud.

   Acessar a página "Instâncias"

2. Clique no nome da instância em que você quer desativar o escalonador automático gerenciado.

3. Em Escolher um modo de escalonamento, clique em Alocação manual.

4. Clique em Salvar.

gcloud

Use o comando gcloud beta spanner instances update para atualizar a instância.

Use o comando a seguir para alterar uma instância do escalonamento automático gerenciado para o escalonamento manual:

  gcloud beta spanner instances update \
  --processing-units=PROCESSING-UNITS-COUNT

ou

  gcloud beta spanner instances update \
  --nodes=NODE-COUNT

Substitua PROCESSING-UNIT-COUNT ou NODE-COUNT pelo número de unidades de processamento ou nós que você quer usar na instância.

Rotular uma instância

Os rótulos ajudam a organizar os recursos.

Console

1. Acesse a página Instâncias do Spanner no Console do Google Cloud.

   Acessar a página "Instâncias"

2. Marque a caixa de seleção da instância. O Painel de informações aparece no lado direito da página.

3. Clique na guia Permissões no painel de informações. Em seguida, adicione, exclua ou atualize os rótulos da instância do Spanner.

Mover uma instância

Observação :não é possível mover uma instância com o escalonador automático gerenciado ativado.

Para instruções sobre como mover sua instância de qualquer configuração de instância para qualquer outra configuração, inclusive entre configurações regionais e multirregionais, consulte Mover uma instância.

Excluir uma instância

Aviso: com a exclusão de uma instância, todos os respectivos bancos de dados também são removidos permanentemente. Não é possível desfazer essa ação. Além disso, não é possível criar outra instância de teste gratuito depois de excluir sua primeira instância de teste gratuito. É possível criar uma instância de teste sem custo financeiro por ciclo de vida do projeto.

É possível excluir uma instância com o console do Google Cloud ou a Google Cloud CLI.

Para excluir uma instância que tem um ou mais bancos de dados com a proteção contra exclusão ativada, desative a proteção contra exclusão em todos os bancos de dados da instância antes de excluí-la.

Console

1. Acesse a página Instâncias do Spanner no Console do Google Cloud.

   Acessar a página "Instâncias"

2. Clique no nome da instância a ser excluída.

3. Clique em Excluir instância.

4. Siga as instruções para confirmar a exclusão da instância.

5. Clique em Excluir.

gcloud

Use o comando gcloud spanner instances delete, substituindo INSTANCE-ID pelo ID da instância:

gcloud spanner instances delete INSTANCE-ID

Interromper ou reiniciar uma instância

O Spanner é um serviço de banco de dados totalmente gerenciado que supervisiona as próprias tarefas e recursos subjacentes, incluindo o monitoramento e a reinicialização de processos quando necessário, sem inatividade. Como não é necessário interromper ou reiniciar manualmente uma determinada instância, o Spanner não oferece uma maneira de fazer isso.

A seguir

• Saiba como inserir, atualizar e excluir dados com a linguagem de manipulação de dados (DML) ou a CLI gcloud.
• Conceda papéis de gerenciamento de identidade e acesso à instância e aos bancos de dados dela.
• Entenda como projetar um esquema do Spanner.