Esta página foi traduzida pela API Cloud Translation.

Introdução ao Spanner em Python
Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Objetivos

Este tutorial orienta você nas seguintes etapas usando a biblioteca de cliente Spanner para Python:

Crie uma instância e um banco de dados do Spanner.
Escreva, leia e execute consultas SQL em dados no banco de dados.
Atualize o esquema do banco de dados.
Atualizar dados usando uma transação de leitura e gravação.
Adicione um índice secundário ao banco de dados.
Use o índice para ler e executar consultas SQL em dados.
Recupere dados usando uma transação somente leitura.

Custos

Este tutorial usa o Spanner, que é um componente faturável doGoogle Cloud. Para obter informações sobre o custo de uso do Spanner, consulte Preços .

Antes de começar

Conclua as etapas descritas em Configuração , que abrangem a criação e a configuração de um padrão Google Cloud projeto, habilitando o faturamento, habilitando a API do Cloud Spanner e configurando o OAuth 2.0 para obter credenciais de autenticação para usar a API do Cloud Spanner.

Em particular, certifique-se de executar gcloud auth application-default login para configurar seu ambiente de desenvolvimento local com credenciais de autenticação.

Nota: Se você não planeja manter os recursos criados neste tutorial, considere criar um novo Google Cloud projeto em vez de selecionar um projeto existente. Após concluir o tutorial, você pode excluir o projeto, removendo todos os recursos associados a ele.

Prepare seu ambiente Python local

Siga as instruções em Configurando um ambiente de desenvolvimento Python .
Clone o repositório do aplicativo de exemplo na sua máquina local:
```
git clone https://github.com/googleapis/python-spanner
```
Como alternativa, você pode baixar o exemplo como um arquivo zip e extraí-lo.
Mude para o diretório que contém o código de exemplo do Spanner:
```
cd python-spanner/samples/samples
```

Crie um ambiente Python isolado e instale dependências:

virtualenv env
source env/bin/activate
pip install -r requirements.txt

Criar uma instância

Ao usar o Spanner pela primeira vez, você precisa criar uma instância, que é uma alocação de recursos usados pelos bancos de dados do Spanner. Ao criar uma instância, você escolhe uma configuração de instância , que determina onde seus dados serão armazenados, e também o número de nós a serem usados, que determina a quantidade de recursos de serviço e armazenamento na sua instância.

Execute o seguinte comando para criar uma instância do Spanner na região us-central1 com 1 nó:

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

Observe que isso cria uma instância com as seguintes características:

ID da instância test-instance
Nome de exibição Test Instance
Configuração de instância regional-us-central1 (Configurações regionais armazenam dados em uma região, enquanto configurações multirregionais distribuem dados entre várias regiões. Para obter mais informações, consulte Sobre instâncias .)
Contagem de nós de 1 ( node_count corresponde à quantidade de recursos de serviço e armazenamento disponíveis para bancos de dados na instância. Saiba mais em Nós e unidades de processamento .)

Você deverá ver:

Creating instance...done.

Veja os arquivos de amostra

O repositório de exemplos contém um exemplo que mostra como usar o Spanner com Python.

Dê uma olhada no arquivo snippets.py , que mostra como usar o Spanner. O código mostra como criar e usar um novo banco de dados. Os dados usam o esquema de exemplo mostrado na página Esquema e modelo de dados .

Criar um banco de dados

GoogleSQL

python snippets.py test-instance --database-id example-db create_database

PostgreSQL

python pg_snippets.py test-instance --database-id example-db create_database

Você deverá ver:

Created database example-db on instance test-instance

O código a seguir cria um banco de dados e duas tabelas no banco de dados.

GoogleSQL

def create_database(instance_id, database_id):
    """Creates a database and tables for sample data."""
    from google.cloud.spanner_admin_database_v1.types import spanner_database_admin

    spanner_client = spanner.Client()
    database_admin_api = spanner_client.database_admin_api

    request = spanner_database_admin.CreateDatabaseRequest(
        parent=database_admin_api.instance_path(spanner_client.project, instance_id),
        create_statement=f"CREATE DATABASE `{database_id}`",
        extra_statements=[
            """CREATE TABLE Singers (
            SingerId     INT64 NOT NULL,
            FirstName    STRING(1024),
            LastName     STRING(1024),
            SingerInfo   BYTES(MAX),
            FullName   STRING(2048) AS (
                ARRAY_TO_STRING([FirstName, LastName], " ")
            ) STORED
        ) PRIMARY KEY (SingerId)""",
            """CREATE TABLE Albums (
            SingerId     INT64 NOT NULL,
            AlbumId      INT64 NOT NULL,
            AlbumTitle   STRING(MAX)
        ) PRIMARY KEY (SingerId, AlbumId),
        INTERLEAVE IN PARENT Singers ON DELETE CASCADE""",
        ],
    )

    operation = database_admin_api.create_database(request=request)

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

    print(
        "Created database {} on instance {}".format(
            database.name,
            database_admin_api.instance_path(spanner_client.project, instance_id),
        )
    )

PostgreSQL

def create_database(instance_id, database_id):
    """Creates a PostgreSql database and tables for sample data."""

    from google.cloud.spanner_admin_database_v1.types import \
        spanner_database_admin

    spanner_client = spanner.Client()
    database_admin_api = spanner_client.database_admin_api

    request = spanner_database_admin.CreateDatabaseRequest(
        parent=database_admin_api.instance_path(spanner_client.project, instance_id),
        create_statement=f'CREATE DATABASE "{database_id}"',
        database_dialect=DatabaseDialect.POSTGRESQL,
    )

    operation = database_admin_api.create_database(request=request)

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

    create_table_using_ddl(database.name)
    print("Created database {} on instance {}".format(database_id, instance_id))


def create_table_using_ddl(database_name):
    from google.cloud.spanner_admin_database_v1.types import \
        spanner_database_admin

    spanner_client = spanner.Client()
    request = spanner_database_admin.UpdateDatabaseDdlRequest(
        database=database_name,
        statements=[
            """CREATE TABLE Singers (
  SingerId   bigint NOT NULL,
  FirstName  character varying(1024),
  LastName   character varying(1024),
  SingerInfo bytea,
  FullName   character varying(2048)
    GENERATED ALWAYS AS (FirstName || ' ' || LastName) STORED,
  PRIMARY KEY (SingerId)
  )""",
            """CREATE TABLE Albums (
  SingerId     bigint NOT NULL,
  AlbumId      bigint NOT NULL,
  AlbumTitle   character varying(1024),
  PRIMARY KEY (SingerId, AlbumId)
  ) INTERLEAVE IN PARENT Singers ON DELETE CASCADE""",
        ],
    )
    operation = spanner_client.database_admin_api.update_database_ddl(request)
    operation.result(OPERATION_TIMEOUT_SECONDS)

O próximo passo é gravar dados no seu banco de dados.

Criar um cliente de banco de dados

Antes de poder realizar leituras ou gravações, você precisa criar um Client . Pense em um Client como uma conexão de banco de dados: todas as suas interações com o Spanner devem passar por um Client . Normalmente, você cria um Client quando seu aplicativo é inicializado e, em seguida, reutiliza esse Client para ler, gravar e executar transações. O código a seguir mostra como criar um cliente.

# Imports the Google Cloud Client Library.
from google.cloud import spanner

# Your Cloud Spanner instance ID.
# instance_id = "my-instance-id"
#
# Your Cloud Spanner database ID.
# database_id = "my-database-id"
# Instantiate a client.
spanner_client = spanner.Client()

# Get a Cloud Spanner instance by ID.
instance = spanner_client.instance(instance_id)

# Get a Cloud Spanner database by ID.
database = instance.database(database_id)

# Execute a simple SQL statement.
with database.snapshot() as snapshot:
    results = snapshot.execute_sql("SELECT 1")

    for row in results:
        print(row)

Escrever dados com DML

Você pode inserir dados usando Linguagem de Manipulação de Dados (DML) em uma transação de leitura e gravação.

Use o método execute_update() para executar uma instrução DML.

# instance_id = "your-spanner-instance"
# database_id = "your-spanner-db-id"
spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
database = instance.database(database_id)

def insert_singers(transaction):
    row_ct = transaction.execute_update(
        "INSERT INTO Singers (SingerId, FirstName, LastName) VALUES "
        "(12, 'Melissa', 'Garcia'), "
        "(13, 'Russell', 'Morales'), "
        "(14, 'Jacqueline', 'Long'), "
        "(15, 'Dylan', 'Shaw')"
    )
    print("{} record(s) inserted.".format(row_ct))

database.run_in_transaction(insert_singers)

Execute o exemplo usando o argumento insert_with_dml .

python snippets.py test-instance --database-id example-db insert_with_dml

Você deverá ver:

4 record(s) inserted.

Escrever dados com mutações

Você também pode inserir dados usando mutações .

Você grava dados usando um objeto Batch . Um objeto Batch é um contêiner para operações de mutação. Uma mutação representa uma sequência de inserções, atualizações e exclusões que o Spanner aplica atomicamente a diferentes linhas e tabelas em um banco de dados Spanner.

O método insert() na classe Batch adiciona uma ou mais mutações de inserção ao lote. Todas as mutações em um único lote são aplicadas atomicamente.

Este código mostra como escrever os dados usando mutações:

def insert_data(instance_id, database_id):
    """Inserts sample data into the given database.

    The database and table must already exist and can be created using
    `create_database`.
    """
    spanner_client = spanner.Client()
    instance = spanner_client.instance(instance_id)
    database = instance.database(database_id)

    with database.batch() as batch:
        batch.insert(
            table="Singers",
            columns=("SingerId", "FirstName", "LastName"),
            values=[
                (1, "Marc", "Richards"),
                (2, "Catalina", "Smith"),
                (3, "Alice", "Trentor"),
                (4, "Lea", "Martin"),
                (5, "David", "Lomond"),
            ],
        )

        batch.insert(
            table="Albums",
            columns=("SingerId", "AlbumId", "AlbumTitle"),
            values=[
                (1, 1, "Total Junk"),
                (1, 2, "Go, Go, Go"),
                (2, 1, "Green"),
                (2, 2, "Forever Hold Your Peace"),
                (2, 3, "Terrified"),
            ],
        )

    print("Inserted data.")

Execute o exemplo usando o argumento insert_data .

python snippets.py test-instance --database-id example-db insert_data

Você deverá ver:

Inserted data.

Consultar dados usando SQL

O Spanner oferece suporte a uma interface SQL para leitura de dados, que você pode acessar na linha de comando usando o Google Cloud CLI ou programaticamente usando a biblioteca de cliente do Spanner para Python.

Na linha de comando

Execute a seguinte instrução SQL para ler os valores de todas as colunas da tabela Albums :

gcloud spanner databases execute-sql example-db --instance=test-instance \
    --sql='SELECT SingerId, AlbumId, AlbumTitle FROM Albums'

O resultado deve ser:

SingerId AlbumId AlbumTitle
1        1       Total Junk
1        2       Go, Go, Go
2        1       Green
2        2       Forever Hold Your Peace
2        3       Terrified

Use a biblioteca cliente Spanner para Python

Além de executar uma instrução SQL na linha de comando, você pode emitir a mesma instrução SQL programaticamente usando a biblioteca de cliente Spanner para Python.

Use o método execute_sql() de um objeto Snapshot para executar a consulta SQL. Para obter um objeto Snapshot , chame o método snapshot() da classe Database em uma instrução with .

Veja como emitir a consulta e acessar os dados:

def query_data(instance_id, database_id):
    """Queries sample data from the database using SQL."""
    spanner_client = spanner.Client()
    instance = spanner_client.instance(instance_id)
    database = instance.database(database_id)

    with database.snapshot() as snapshot:
        results = snapshot.execute_sql(
            "SELECT SingerId, AlbumId, AlbumTitle FROM Albums"
        )

        for row in results:
            print("SingerId: {}, AlbumId: {}, AlbumTitle: {}".format(*row))

Execute o exemplo usando o argumento query_data .

python snippets.py test-instance --database-id example-db query_data

Você deverá ver o seguinte resultado:

SingerId: 2, AlbumId: 2, AlbumTitle: Forever Hold Your Peace
SingerId: 1, AlbumId: 2, AlbumTitle: Go, Go, Go
SingerId: 2, AlbumId: 1, AlbumTitle: Green
SingerId: 2, AlbumId: 3, AlbumTitle: Terrified
SingerId: 1, AlbumId: 1, AlbumTitle: Total Junk

Consulta usando um parâmetro SQL

Se o seu aplicativo tiver uma consulta executada com frequência, você pode melhorar seu desempenho parametrizando-a. A consulta paramétrica resultante pode ser armazenada em cache e reutilizada, o que reduz os custos de compilação. Para obter mais informações, consulte Usar parâmetros de consulta para acelerar consultas executadas com frequência .

Aqui está um exemplo de uso de um parâmetro na cláusula WHERE para consultar registros que contêm um valor específico para LastName .

# instance_id = "your-spanner-instance"
# database_id = "your-spanner-db-id"
spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
database = instance.database(database_id)

with database.snapshot() as snapshot:
    results = snapshot.execute_sql(
        "SELECT SingerId, FirstName, LastName FROM Singers "
        "WHERE LastName = @lastName",
        params={"lastName": "Garcia"},
        param_types={"lastName": spanner.param_types.STRING},
    )

    for row in results:
        print("SingerId: {}, FirstName: {}, LastName: {}".format(*row))

Execute o exemplo usando o argumento query_data_with_parameter.

python snippets.py test-instance --database-id example-db query_data_with_parameter

Você deverá ver o seguinte resultado:

SingerId: 12, FirstName: Melissa, LastName: Garcia

Ler dados usando a API de leitura

Além da interface SQL do Spanner, o Spanner também suporta uma interface de leitura.

Use o método read() de um objeto Snapshot para ler linhas do banco de dados. Para obter um objeto Snapshot , chame o método snapshot() da classe Database em uma instrução with . Use um objeto KeySet para definir uma coleção de chaves e intervalos de chaves para leitura.

Veja como ler os dados:

def read_data(instance_id, database_id):
    """Reads sample data from the database."""
    spanner_client = spanner.Client()
    instance = spanner_client.instance(instance_id)
    database = instance.database(database_id)

    with database.snapshot() as snapshot:
        keyset = spanner.KeySet(all_=True)
        results = snapshot.read(
            table="Albums", columns=("SingerId", "AlbumId", "AlbumTitle"), keyset=keyset
        )

        for row in results:
            print("SingerId: {}, AlbumId: {}, AlbumTitle: {}".format(*row))

Execute o exemplo usando o argumento read_data .

python snippets.py test-instance --database-id example-db read_data

Você deverá ver uma saída semelhante a:

SingerId: 1, AlbumId: 1, AlbumTitle: Total Junk
SingerId: 1, AlbumId: 2, AlbumTitle: Go, Go, Go
SingerId: 2, AlbumId: 1, AlbumTitle: Green
SingerId: 2, AlbumId: 2, AlbumTitle: Forever Hold Your Peace
SingerId: 2, AlbumId: 3, AlbumTitle: Terrified

Atualizar o esquema do banco de dados

Suponha que você precise adicionar uma nova coluna chamada MarketingBudget à tabela Albums . Adicionar uma nova coluna a uma tabela existente requer uma atualização do esquema do seu banco de dados. O Spanner suporta atualizações de esquema em um banco de dados enquanto este continua a servir tráfego. As atualizações de esquema não exigem que o banco de dados fique offline e não bloqueiam tabelas ou colunas inteiras; você pode continuar gravando dados no banco de dados durante a atualização do esquema. Saiba mais sobre as atualizações de esquema suportadas e o desempenho das alterações de esquema em Fazer atualizações de esquema .

Adicionar uma coluna

Você pode adicionar uma coluna na linha de comando usando o Google Cloud CLI ou programaticamente usando a biblioteca de cliente Spanner para Python.

Na linha de comando

Use o seguinte comando ALTER TABLE para adicionar a nova coluna à tabela:

GoogleSQL

gcloud spanner databases ddl update example-db --instance=test-instance \
    --ddl='ALTER TABLE Albums ADD COLUMN MarketingBudget INT64'

PostgreSQL

gcloud spanner databases ddl update example-db --instance=test-instance \
    --ddl='ALTER TABLE Albums ADD COLUMN MarketingBudget BIGINT'

Você deverá ver:

Schema updating...done.

Use a biblioteca cliente Spanner para Python

Use o método update_ddl() da classe Database para modificar o esquema:

def add_column(instance_id, database_id):
    """Adds a new column to the Albums table in the example database."""

    from google.cloud.spanner_admin_database_v1.types import spanner_database_admin

    spanner_client = spanner.Client()
    database_admin_api = spanner_client.database_admin_api

    request = spanner_database_admin.UpdateDatabaseDdlRequest(
        database=database_admin_api.database_path(
            spanner_client.project, instance_id, database_id
        ),
        statements=[
            "ALTER TABLE Albums ADD COLUMN MarketingBudget INT64",
        ],
    )

    operation = database_admin_api.update_database_ddl(request)

    print("Waiting for operation to complete...")
    operation.result(OPERATION_TIMEOUT_SECONDS)
    print("Added the MarketingBudget column.")

Execute o exemplo usando o argumento add_column .

python snippets.py test-instance --database-id example-db add_column

Você deverá ver:

Added the MarketingBudget column.

Grave dados na nova coluna

O código a seguir grava dados na nova coluna. Ele define MarketingBudget como 100000 para a linha indexada por Albums(1, 1) e como 500000 para a linha indexada por Albums(2, 2) .

def update_data(instance_id, database_id):
    """Updates sample data in the database.

    This updates the `MarketingBudget` column which must be created before
    running this sample. You can add the column by running the `add_column`
    sample or by running this DDL statement against your database:

        ALTER TABLE Albums ADD COLUMN MarketingBudget INT64

    """
    spanner_client = spanner.Client()
    instance = spanner_client.instance(instance_id)
    database = instance.database(database_id)

    with database.batch() as batch:
        batch.update(
            table="Albums",
            columns=("SingerId", "AlbumId", "MarketingBudget"),
            values=[(1, 1, 100000), (2, 2, 500000)],
        )

    print("Updated data.")

Execute o exemplo usando o argumento update_data .

python snippets.py test-instance --database-id example-db update_data

Você também pode executar uma consulta SQL ou uma chamada de leitura para buscar os valores que acabou de escrever.

Aqui está o código para executar a consulta:

def query_data_with_new_column(instance_id, database_id):
    """Queries sample data from the database using SQL.

    This sample uses the `MarketingBudget` column. You can add the column
    by running the `add_column` sample or by running this DDL statement against
    your database:

        ALTER TABLE Albums ADD COLUMN MarketingBudget INT64
    """
    spanner_client = spanner.Client()
    instance = spanner_client.instance(instance_id)
    database = instance.database(database_id)

    with database.snapshot() as snapshot:
        results = snapshot.execute_sql(
            "SELECT SingerId, AlbumId, MarketingBudget FROM Albums"
        )

        for row in results:
            print("SingerId: {}, AlbumId: {}, MarketingBudget: {}".format(*row))

Para executar esta consulta, execute o exemplo usando o argumento query_data_with_new_column .

python snippets.py test-instance --database-id example-db query_data_with_new_column

Você deverá ver:

SingerId: 2, AlbumId: 2, MarketingBudget: 500000
SingerId: 1, AlbumId: 2, MarketingBudget: None
SingerId: 2, AlbumId: 1, MarketingBudget: None
SingerId: 2, AlbumId: 3, MarketingBudget: None
SingerId: 1, AlbumId: 1, MarketingBudget: 100000

Atualizar dados

Você pode atualizar dados usando DML em uma transação de leitura e gravação.

Use o método execute_update() para executar uma instrução DML.

# instance_id = "your-spanner-instance"
# database_id = "your-spanner-db-id"

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
database = instance.database(database_id)

def transfer_budget(transaction):
    # Transfer marketing budget from one album to another. Performed in a
    # single transaction to ensure that the transfer is atomic.
    second_album_result = transaction.execute_sql(
        "SELECT MarketingBudget from Albums " "WHERE SingerId = 2 and AlbumId = 2"
    )
    second_album_row = list(second_album_result)[0]
    second_album_budget = second_album_row[0]

    transfer_amount = 200000

    # Transaction will only be committed if this condition still holds at
    # the time of commit. Otherwise it will be aborted and the callable
    # will be rerun by the client library
    if second_album_budget >= transfer_amount:
        first_album_result = transaction.execute_sql(
            "SELECT MarketingBudget from Albums "
            "WHERE SingerId = 1 and AlbumId = 1"
        )
        first_album_row = list(first_album_result)[0]
        first_album_budget = first_album_row[0]

        second_album_budget -= transfer_amount
        first_album_budget += transfer_amount

        # Update first album
        transaction.execute_update(
            "UPDATE Albums "
            "SET MarketingBudget = @AlbumBudget "
            "WHERE SingerId = 1 and AlbumId = 1",
            params={"AlbumBudget": first_album_budget},
            param_types={"AlbumBudget": spanner.param_types.INT64},
        )

        # Update second album
        transaction.execute_update(
            "UPDATE Albums "
            "SET MarketingBudget = @AlbumBudget "
            "WHERE SingerId = 2 and AlbumId = 2",
            params={"AlbumBudget": second_album_budget},
            param_types={"AlbumBudget": spanner.param_types.INT64},
        )

        print(
            "Transferred {} from Album2's budget to Album1's".format(
                transfer_amount
            )
        )

database.run_in_transaction(transfer_budget)

Execute o exemplo usando o argumento write_with_dml_transaction .

python snippets.py test-instance --database-id example-db write_with_dml_transaction

Você deverá ver:

Transferred 200000 from Album2's budget to Album1's

Use um índice secundário

Suponha que você queira buscar todas as linhas de Albums que possuem valores AlbumTitle em um determinado intervalo. Você poderia ler todos os valores da coluna AlbumTitle usando uma instrução SQL ou uma chamada de leitura e, em seguida, descartar as linhas que não atendem aos critérios, mas realizar essa varredura completa da tabela é caro, especialmente para tabelas com muitas linhas. Em vez disso, você pode acelerar a recuperação de linhas ao pesquisar por colunas que não sejam de chave primária criando um índice secundário na tabela.

Adicionar um índice secundário a uma tabela existente requer uma atualização de esquema. Assim como outras atualizações de esquema, o Spanner permite a adição de um índice enquanto o banco de dados continua a servir tráfego. O Spanner preenche automaticamente o índice com os dados existentes. Os preenchimentos podem levar alguns minutos para serem concluídos, mas você não precisa desconectar o banco de dados nem evitar gravar na tabela indexada durante esse processo. Para obter mais detalhes, consulte Adicionar um índice secundário .

Após adicionar um índice secundário, o Spanner o utiliza automaticamente para consultas SQL que provavelmente serão executadas mais rapidamente com o índice. Se você usar a interface de leitura, deverá especificar o índice que deseja usar.

Adicionar um índice secundário

Você pode adicionar um índice na linha de comando usando o gcloud CLI ou programaticamente usando a biblioteca de cliente Spanner para Python.

Na linha de comando

Use o seguinte comando CREATE INDEX para adicionar um índice ao banco de dados:

gcloud spanner databases ddl update example-db --instance=test-instance \
    --ddl='CREATE INDEX AlbumsByAlbumTitle ON Albums(AlbumTitle)'

Você deverá ver:

Schema updating...done.

Usando a biblioteca cliente Spanner para Python

Use o método update_ddl() da classe Database para adicionar um índice:

def add_index(instance_id, database_id):
    """Adds a simple index to the example database."""

    from google.cloud.spanner_admin_database_v1.types import spanner_database_admin

    spanner_client = spanner.Client()
    database_admin_api = spanner_client.database_admin_api

    request = spanner_database_admin.UpdateDatabaseDdlRequest(
        database=database_admin_api.database_path(
            spanner_client.project, instance_id, database_id
        ),
        statements=["CREATE INDEX AlbumsByAlbumTitle ON Albums(AlbumTitle)"],
    )

    operation = database_admin_api.update_database_ddl(request)

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

    print("Added the AlbumsByAlbumTitle index.")

Execute o exemplo usando o argumento add_index .

python snippets.py test-instance --database-id example-db add_index

Adicionar um índice pode levar alguns minutos. Após adicioná-lo, você deverá ver:

Added the AlbumsByAlbumTitle index.

Leia usando o índice

Para consultas SQL, o Spanner usa automaticamente um índice apropriado. Na interface de leitura, você deve especificar o índice na sua solicitação.

Para usar o índice na interface de leitura, forneça um argumento Index ao método read() de um objeto Snapshot . Para obter um objeto Snapshot , chame o método snapshot() da classe Database em uma instrução with .

def read_data_with_index(instance_id, database_id):
    """Reads sample data from the database using an index.

    The index must exist before running this sample. You can add the index
    by running the `add_index` sample or by running this DDL statement against
    your database:

        CREATE INDEX AlbumsByAlbumTitle ON Albums(AlbumTitle)

    """
    spanner_client = spanner.Client()
    instance = spanner_client.instance(instance_id)
    database = instance.database(database_id)

    with database.snapshot() as snapshot:
        keyset = spanner.KeySet(all_=True)
        results = snapshot.read(
            table="Albums",
            columns=("AlbumId", "AlbumTitle"),
            keyset=keyset,
            index="AlbumsByAlbumTitle",
        )

        for row in results:
            print("AlbumId: {}, AlbumTitle: {}".format(*row))

Execute o exemplo usando o argumento read_data_with_index .

python snippets.py test-instance --database-id example-db read_data_with_index

Você deverá ver:

AlbumId: 2, AlbumTitle: Forever Hold Your Peace
AlbumId: 2, AlbumTitle: Go, Go, Go
AlbumId: 1, AlbumTitle: Green
AlbumId: 3, AlbumTitle: Terrified
AlbumId: 1, AlbumTitle: Total Junk

Adicionar um índice para leituras somente de índice

Você deve ter notado que o exemplo de leitura anterior não inclui a leitura da coluna MarketingBudget . Isso ocorre porque a interface de leitura do Spanner não suporta a capacidade de unir um índice a uma tabela de dados para pesquisar valores que não estão armazenados no índice.

Crie uma definição alternativa de AlbumsByAlbumTitle que armazene uma cópia de MarketingBudget no índice.

Na linha de comando

GoogleSQL

gcloud spanner databases ddl update example-db --instance=test-instance \
    --ddl='CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle) STORING (MarketingBudget)

PostgreSQL

gcloud spanner databases ddl update example-db --instance=test-instance \
    --ddl='CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle) INCLUDE (MarketingBudget)

Adicionar um índice pode levar alguns minutos. Após adicioná-lo, você deverá ver:

Schema updating...done.

Usando a biblioteca cliente Spanner para Python

Use o método update_ddl() da classe Database para adicionar um índice com uma cláusula STORING :

def add_storing_index(instance_id, database_id):
    """Adds an storing index to the example database."""

    from google.cloud.spanner_admin_database_v1.types import spanner_database_admin

    spanner_client = spanner.Client()
    database_admin_api = spanner_client.database_admin_api

    request = spanner_database_admin.UpdateDatabaseDdlRequest(
        database=database_admin_api.database_path(
            spanner_client.project, instance_id, database_id
        ),
        statements=[
            "CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle)"
            "STORING (MarketingBudget)"
        ],
    )

    operation = database_admin_api.update_database_ddl(request)

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

    print("Added the AlbumsByAlbumTitle2 index.")

Execute o exemplo usando o argumento add_storing_index .

python snippets.py test-instance --database-id example-db add_storing_index

Você deverá ver:

Added the AlbumsByAlbumTitle2 index.

Agora você pode executar uma leitura que busca todas as colunas AlbumId , AlbumTitle e MarketingBudget do índice AlbumsByAlbumTitle2 :

def read_data_with_storing_index(instance_id, database_id):
    """Reads sample data from the database using an index with a storing
    clause.

    The index must exist before running this sample. You can add the index
    by running the `add_scoring_index` sample or by running this DDL statement
    against your database:

        CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle)
        STORING (MarketingBudget)

    """
    spanner_client = spanner.Client()
    instance = spanner_client.instance(instance_id)
    database = instance.database(database_id)

    with database.snapshot() as snapshot:
        keyset = spanner.KeySet(all_=True)
        results = snapshot.read(
            table="Albums",
            columns=("AlbumId", "AlbumTitle", "MarketingBudget"),
            keyset=keyset,
            index="AlbumsByAlbumTitle2",
        )

        for row in results:
            print("AlbumId: {}, AlbumTitle: {}, " "MarketingBudget: {}".format(*row))

Execute o exemplo usando o argumento read_data_with_storing_index .

python snippets.py test-instance --database-id example-db read_data_with_storing_index

Você deverá ver uma saída semelhante a:

AlbumId: 2, AlbumTitle: Forever Hold Your Peace, MarketingBudget: 300000
AlbumId: 2, AlbumTitle: Go, Go, Go, MarketingBudget: None
AlbumId: 1, AlbumTitle: Green, MarketingBudget: None
AlbumId: 3, AlbumTitle: Terrified, MarketingBudget: None
AlbumId: 1, AlbumTitle: Total Junk, MarketingBudget: 300000

Recuperar dados usando transações somente leitura

Suponha que você queira executar mais de uma leitura no mesmo registro de data e hora. Transações somente leitura observam um prefixo consistente do histórico de confirmações da transação, de modo que seu aplicativo sempre obtém dados consistentes.

Use um objeto Snapshot para executar transações somente leitura. Para obter um objeto Snapshot , chame o método snapshot() da classe Database em uma instrução with .

A seguir, é mostrado como executar uma consulta e realizar uma leitura na mesma transação somente leitura:

def read_only_transaction(instance_id, database_id):
    """Reads data inside of a read-only transaction.

    Within the read-only transaction, or "snapshot", the application sees
    consistent view of the database at a particular timestamp.
    """
    spanner_client = spanner.Client()
    instance = spanner_client.instance(instance_id)
    database = instance.database(database_id)

    with database.snapshot(multi_use=True) as snapshot:
        # Read using SQL.
        results = snapshot.execute_sql(
            "SELECT SingerId, AlbumId, AlbumTitle FROM Albums"
        )

        print("Results from first read:")
        for row in results:
            print("SingerId: {}, AlbumId: {}, AlbumTitle: {}".format(*row))

        # Perform another read using the `read` method. Even if the data
        # is updated in-between the reads, the snapshot ensures that both
        # return the same data.
        keyset = spanner.KeySet(all_=True)
        results = snapshot.read(
            table="Albums", columns=("SingerId", "AlbumId", "AlbumTitle"), keyset=keyset
        )

        print("Results from second read:")
        for row in results:
            print("SingerId: {}, AlbumId: {}, AlbumTitle: {}".format(*row))

Execute o exemplo usando o argumento read_only_transaction .

python snippets.py test-instance --database-id example-db read_only_transaction

Você deverá ver uma saída semelhante a:

Results from first read:
SingerId: 2, AlbumId: 2, AlbumTitle: Forever Hold Your Peace
SingerId: 1, AlbumId: 2, AlbumTitle: Go, Go, Go
SingerId: 2, AlbumId: 1, AlbumTitle: Green
SingerId: 2, AlbumId: 3, AlbumTitle: Terrified
SingerId: 1, AlbumId: 1, AlbumTitle: Total Junk
Results from second read:
SingerId: 1, AlbumId: 1, AlbumTitle: Total Junk
SingerId: 1, AlbumId: 2, AlbumTitle: Go, Go, Go
SingerId: 2, AlbumId: 1, AlbumTitle: Green
SingerId: 2, AlbumId: 2, AlbumTitle: Forever Hold Your Peace
SingerId: 2, AlbumId: 3, AlbumTitle: Terrified

Limpar

Para evitar cobranças adicionais na sua conta do Cloud Billing pelos recursos usados neste tutorial, elimine o banco de dados e exclua a instância que você criou.

Excluir o banco de dados

Se você excluir uma instância, todos os bancos de dados contidos nela serão excluídos automaticamente. Esta etapa mostra como excluir um banco de dados sem excluir uma instância (você ainda incorrerá em cobranças pela instância).

Na linha de comando

gcloud spanner databases delete example-db --instance=test-instance

Usando o Google Cloud console

Vá para a página Instâncias do Spanner no Google Cloud console.
Vá para a página Instâncias
Clique na instância.
Clique no banco de dados que você deseja excluir.
Na página Detalhes do banco de dados , clique em Excluir .
Confirme que deseja excluir o banco de dados e clique em Excluir .

Excluir a instância

A exclusão de uma instância remove automaticamente todos os bancos de dados criados nela.

Na linha de comando

gcloud spanner instances delete test-instance

Usando o Google Cloud console

Vá para a página Instâncias do Spanner no Google Cloud console.
Vá para a página Instâncias
Clique na sua instância.
Clique em Excluir .
Confirme que deseja excluir a instância e clique em Excluir .

O que vem a seguir

Aprenda como acessar o Spanner com uma instância de máquina virtual .
Saiba mais sobre credenciais de autorização e autenticação em Autenticar em serviços de nuvem usando bibliotecas de cliente .
Saiba mais sobre as práticas recomendadas de design do Spanner Schema .

Introdução ao Spanner em Python Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Objetivos

Custos

Antes de começar

Limpar

Excluir o banco de dados

Na linha de comando

Usando o Google Cloud console

Excluir a instância

Na linha de comando

Usando o Google Cloud console

O que vem a seguir

Introdução ao Spanner em Python
Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.