Importar e exportar dados em formato CSV

Nesta página, você verá como exportar dados do Cloud Spanner para arquivos CSV ou importar dados de arquivos CSV para um banco de dados do Spanner.

O processo usa o Dataflow. É possível exportar dados do Spanner para um bucket do Cloud Storage ou importar dados para o Spanner de um bucket do Cloud Storage que contenha um arquivo de manifesto JSON e um conjunto de arquivos CSV.

Antes de começar

Para importar ou exportar um banco de dados do Spanner, primeiro você precisa ativar as APIs do Spanner, Cloud Storage, Compute Engine e Dataflow:

Ative as APIs

É preciso também ter cota suficiente e as permissões obrigatórias do IAM.

Requisitos de cota

Os requisitos de cota para jobs de importação ou exportação são os seguintes:

  • Spanner: é preciso ter capacidade de computação suficiente para aceitar a quantidade de dados importados. Nenhuma capacidade de computação extra é necessária para importar ou exportar um banco de dados, mas talvez você precise adicionar mais capacidade de computação para que seu job seja concluído em um tempo razoável. Consulte Otimizar jobs para mais detalhes.
  • Cloud Storage: para importar, é preciso ter um bucket contendo os arquivos exportados anteriormente. Para exportar, crie um bucket para os arquivos exportados, se ainda não tiver um. Isso pode ser feito no console pela página do Cloud Storage ou durante a criação da exportação pela página do Spanner. Não é necessário definir um tamanho para o bucket.
  • Dataflow: os jobs de exportação ou importação estão sujeitos ao mesmo uso de CPU, disco e cotas do Compute Engine do endereço IP aplicados a outros jobs do Dataflow.
  • Compute Engine: antes de executar o job de importação ou exportação, é preciso configurar as cotas iniciais para o Compute Engine, usadas pelo Dataflow. Essas cotas representam o número máximo de recursos que você permite que o Dataflow use para seu job. Os valores iniciais recomendados são:

    • CPUs: 200
    • Endereços IP em uso: 200
    • Disco permanente padrão: 50 TB

    Geralmente não é necessário fazer nenhum outro ajuste. O Dataflow oferece escalonamento automático para que você pague somente pelos recursos reais usados durante a importação ou exportação. Se o job puder usar mais recursos, a IU do Dataflow exibirá um ícone de aviso. O job será concluído, mesmo que um ícone de aviso seja exibido.

Requisitos do IAM

Para importar ou exportar um banco de dados, é preciso também ter papéis de IAM com permissões suficientes para usar todos os serviços envolvidos em um job de importação ou exportação. Para informações sobre como conceder papéis e permissões, consulte Aplicar papéis do IAM.

Para importar ou exportar um banco de dados, é preciso ter os seguintes papéis:

  • Para envolvidos no projeto do Google Cloud:
    • Leitor do Spanner
    • Administrador do Dataflow
    • Administrador de armazenamento
  • No nível do banco de dados ou da instância do Spanner, ou no nível do projeto do Google Cloud:
    • Leitor do Spanner
    • Administrador de banco de dados do Spanner (obrigatório apenas para jobs de importação)

Exportar dados do Spanner para arquivos CSV

Para exportar dados do Spanner para arquivos CSV no Cloud Storage, siga as instruções de uso da CLI do Google Cloud para executar um job com o modelo de texto do Spanner para o Cloud Storage.

Também é possível consultar as informações neste documento sobre como visualizar ou solucionar problemas de jobs, como otimizar jobs lentos e fatores que afetam o desempenho dos jobs.

Importar dados de arquivos CSV para o Spanner

O processo para importar dados de arquivos CSV inclui as seguintes etapas:

  1. Exporte seus dados para arquivos CSV e armazene-os no Cloud Storage. Não inclua uma linha de cabeçalho.
  2. Crie um arquivo de manifesto JSON e armazene o arquivo junto aos arquivos CSV.
  3. Crie tabelas de destino vazias no banco de dados do Spanner ou verifique se os tipos de dados das colunas nos arquivos CSV correspondem a qualquer coluna correspondente nas tabelas atuais.
  4. Execute o job de importação.

Etapa 1: exportar dados de um banco de dados não Spanner para arquivos CSV

O processo de importação traz dados de arquivos CSV localizados em um bucket do Cloud Storage. É possível exportar dados em formato CSV de qualquer origem.

Tenha isto em mente ao exportar seus dados:

  • Os arquivos de texto a serem importados precisam estar no formato CSV.
  • Os dados precisam corresponder a um dos tipos a seguir:

SQL padrão do Google

BOOL
INT64
FLOAT64
NUMERIC
STRING
DATE
TIMESTAMP
BYTES
JSON

PostgreSQL

boolean
bigint
double precision
numeric
character varying, text
date
timestamp with time zone
bytea
  • Não é preciso incluir nem gerar metadados ao exportar os arquivos CSV.

  • Não é necessário seguir nenhuma convenção de nomenclatura específica para seus arquivos.

Se você não exportar seus arquivos diretamente para o Cloud Storage, é necessário fazer o upload dos arquivos CSV para um bucket do Cloud Storage.

Etapa 2: criar um arquivo de manifesto JSON

Também é necessário criar um arquivo de manifesto com uma descrição em JSON dos arquivos a serem importados e colocá-lo no mesmo bucket do Cloud Storage em que você armazenou seus arquivos CSV. Neste arquivo de manifesto, há uma matriz tables que lista o nome e os locais do arquivo de dados para cada tabela. O arquivo também especifica o dialeto do banco de dados de recebimento. Se o dialeto for omitido, o padrão será o SQL padrão do Google.

O formato do arquivo de manifesto corresponde ao seguinte tipo de mensagem, mostrado aqui no formato buffer de protocolo:

message ImportManifest {
  // The per-table import manifest.
  message TableManifest {
    // Required. The name of the destination table.
    string table_name = 1;
    // Required. The CSV files to import. This value can be either a filepath or a glob pattern.
    repeated string file_patterns = 2;
    // The schema for a table column.
    message Column {
      // Required for each Column that you specify. The name of the column in the
      // destination table.
      string column_name = 1;
      // Required for each Column that you specify. The type of the column.
      string type_name = 2;
    }
    // Optional. The schema for the table columns.
    repeated Column columns = 3;
  }
  // Required. The TableManifest of the tables to be imported.
  repeated TableManifest tables = 1;

  enum ProtoDialect {
    GOOGLE_STANDARD_SQL = 0;
    POSTGRESQL = 1;
  }
  // Optional. The dialect of the receiving database. Defaults to GOOGLE_STANDARD_SQL.
  ProtoDialect dialect = 2;
}

O exemplo a seguir mostra um arquivo de manifesto para importar tabelas chamadas Albums e Singers para um banco de dados do dialeto Google Standard SQL. A tabela Albums usa o esquema de colunas que o job recupera do banco de dados. A tabela Singers usa o esquema especificado pelo arquivo de manifesto:

{
  "tables": [
    {
      "table_name": "Albums",
      "file_patterns": [
        "gs://bucket1/Albums_1.csv",
        "gs://bucket1/Albums_2.csv"
      ]
    },
    {
      "table_name": "Singers",
      "file_patterns": [
        "gs://bucket1/Singers*.csv"
      ],
      "columns": [
        {"column_name": "SingerId", "type_name": "INT64"},
        {"column_name": "FirstName", "type_name": "STRING"},
        {"column_name": "LastName", "type_name": "STRING"}
      ]
    }
  ]
}

Etapa 3: criar a tabela do banco de dados do Spanner

Antes de executar a importação, crie as tabelas de destino no banco de dados do Spanner. Se a tabela de destino do Spanner já tiver um esquema, todas as colunas especificadas no arquivo de manifesto precisam ter os mesmos tipos de dados que as colunas correspondentes no esquema da tabela de destino.

Recomendamos que você crie índices secundários, chaves externas e streams de alteração depois de importar seus dados para o Spanner, não quando criar a tabela inicialmente. Se a tabela já contiver essas estruturas, recomendamos descartá-las e recriá-las depois da importação dos dados.

Etapa 4: executar um job de importação do Dataflow usando a gcloud

Para iniciar o job de importação, siga as instruções de uso da CLI do Google Cloud para executar um job com o modelo CSV para o Spanner.

Depois de iniciar um job de importação, é possível ver detalhes sobre ele no console.

Depois que o job de importação for concluído, adicione os índices secundários, as chaves estrangeiras e os fluxos de alteração necessários.

Escolha uma região para seu job de importação

É possível escolher uma região diferente com base no local do seu bucket do Cloud Storage. Para evitar cobranças de saída de rede, escolha uma região que corresponda ao local do seu bucket do Cloud Storage.

  • Se o local do bucket do Cloud Storage for uma região, será possível aproveitar o uso gratuito da rede escolhendo a mesma região para o job de importação, supondo que essa região esteja disponível.

  • Se o local do bucket do Cloud Storage for uma região dupla, será possível aproveitar o uso gratuito da rede escolhendo uma das duas regiões que compõem a região dupla do job de importação, supondo que uma das regiões esteja disponível.

  • Se uma região colocalizada não estiver disponível para seu job de importação ou se o local do bucket do Cloud Storage for uma multirregião, serão aplicadas cobranças de saída. Consulte os preços de saída de rede do Cloud Storage para escolher uma região que gere os custos mais baixos de saída de rede.

Ver ou solucionar problemas de jobs na IU do Dataflow

Depois de iniciar um job de importação ou exportação, é possível visualizar detalhes do job, incluindo registros, na seção do Dataflow do console.

Ver detalhes do job do Dataflow

Para ver os detalhes de qualquer job de importação/exportação executado na última semana, incluindo os jobs em execução no momento:

  1. Navegue até a página Detalhes do banco de dados.
  2. Clique no item de menu do painel esquerdo Importar/Exportar. A página Importar/Exportar do banco de dados exibe uma lista de jobs recentes.
  3. Na página Importar/Exportar do banco de dados, clique no nome do job na coluna Nome do job do Dataflow:

    Mensagem de status do job em andamento

    O console exibe detalhes do job do Dataflow.

Para visualizar um job executado há mais de uma semana, siga estas etapas:

  1. Acesse a página de jobs do Dataflow no console.

    Ir para a página de jobs

  2. Encontre seu job na lista e clique no nome dele.

    O console exibe detalhes do job do Dataflow.

Ver registros do Dataflow do seu job

Para visualizar os registros de um job do Dataflow, navegue até a página de detalhes do job, conforme descrito acima. Em seguida, clique em Registros, à direita do nome do job.

Se um job falhar, procure erros nos registros. Se houver erros, a contagem de erros será exibida ao lado de Registros:

Exemplo de contagem de erros ao lado do botão Registros

Para ver os erros do job, siga estas etapas:

  1. Clique na contagem de erros, ao lado de Registros.

    O console exibe os registros do job. Pode ser necessário rolar para visualizar os erros.

  2. Localize entradas com o ícone de erro Ícone de erro.

  3. Clique em uma entrada de registro individual para expandir seu conteúdo.

Para mais informações sobre como solucionar problemas de jobs do Dataflow, consulte Resolver problemas do pipeline.

Resolver problemas de falha na importação ou exportação de jobs

Se você vir os seguintes erros nos registros do job:

com.google.cloud.spanner.SpannerException: NOT_FOUND: Session not found

--or--

com.google.cloud.spanner.SpannerException: DEADLINE_EXCEEDED: Deadline expired before operation could complete.

Verifique a 99% de latência de leitura/gravação na guia Monitoramento do banco de dados do Cloud Spanner no console. Se ele estiver mostrando valores altos (vários segundos), isso indica que a instância está sobrecarregada, fazendo com que as leituras/gravações expirem e falhem.

Uma causa da alta latência é que o job do Dataflow está sendo executado usando muitos workers, colocando muita carga na instância do Cloud Spanner.

Para especificar um limite para o número de workers do Dataflow, faça o seguinte:
  • Se você estiver usando o console do Dataflow, o parâmetro Workers máximos estará localizado na seção Parâmetros opcionais da página Criar job a partir do modelo.

  • Se você estiver usando o gcloud, especifique o argumento max-workers. Exemplo:

    gcloud dataflow jobs run my-import-job \
    --gcs-location='gs://dataflow-templates/latest/GCS_Text_to_Cloud_Spanner' \
    --region=us-central1 \
    --parameters='instanceId=test-instance,databaseId=example-db,inputDir=gs://my-gcs-bucket' \
    --max-workers=10
    

Otimizar jobs de importação ou exportação em execução lenta

Se as sugestões das configurações iniciais forem seguidas, geralmente não será necessário fazer nenhum outro ajuste. Se o job estiver sendo executado lentamente, é possível tentar outras otimizações:

  • Otimize o local do job e dos dados: execute o job do Dataflow na mesma região em que estão localizados o bucket do Cloud Storage e a instância do Spanner.

  • Garanta recursos suficientes do Dataflow: se as cotas relevantes do Compute Engine limitarem os recursos do job do Dataflow, a página do Dataflow no Console do Google Cloud exibirá um ícone de aviso Ícone de aviso e mensagens de registro:

    Captura de tela do aviso de limite de cota

    Nessa situação, é possível reduzir o ambiente de execução do job aumentando as cotas (em inglês) para CPUs, endereços IP em uso e disco permanente padrão. Porém, isso pode resultar em mais cobranças do Compute Engine.

  • Verifique a utilização da CPU do Spanner: se você perceber que a utilização da CPU para a instância é superior a 65%, é possível aumentar a capacidade de computação dessa instância. A capacidade adiciona mais recursos do Spanner e o job deve acelerar, mas haverá mais cobranças do Spanner.

Fatores que afetam o desempenho do job de importação ou exportação

Vários fatores influenciam o tempo necessário para concluir um job de importação ou exportação.

  • Tamanho do banco de dados do Spanner: o processamento de mais dados leva mais tempo e recursos.

  • Esquema do banco de dados do Spanner, incluindo:

    • O número de tabelas
    • O tamanho das linhas.
    • Número de índices secundários
    • O número de chaves externas
    • O número de streams de alteração

  • Local dos dados: os dados são transferidos entre o Spanner e o Cloud Storage pelo Dataflow. O ideal é que os três componentes estejam localizados na mesma região. Se não estiverem, a movimentação dos dados pelas regiões prejudica a velocidade de execução do job.

  • Número de workers do Dataflow: o número ideal de workers do Dataflow é necessário para um bom desempenho. Ao usar o escalonamento automático, o Dataflow escolhe o número de workers para o job, dependendo da quantidade de trabalho que precisa ser feita. O número de workers, no entanto, será limitado pelas cotas para CPUs, endereços IP em uso e disco permanente padrão. A IU do Dataflow exibirá um ícone de aviso caso encontre limites de cotas. Nessa situação, o progresso será mais lento, mas ainda assim o job será concluído. O escalonamento automático pode sobrecarregar o Spanner, levando a erros quando há uma grande quantidade de dados para importar.

  • Carga existente no Spanner: um job de importação adiciona carga significativa da CPU em uma instância do Spanner. Um job de exportação normalmente adiciona uma carga leve a uma instância do Spanner. Se a instância já tiver uma carga atual substancial, a execução do job será mais lenta.

  • Quantidade de capacidade de computação do Spanner: se a utilização da CPU para a instância for superior a 65%, o job será executado mais lentamente.

Ajustar os workers para melhorar o desempenho da importação

Ao iniciar um job de importação do Spanner, os workers do Dataflow precisam ser definidos como um valor ideal para um bom desempenho. O excesso de workers sobrecarrega o Spanner, e poucos workers acabam gerando um desempenho de importação insuficiente.

O número máximo de workers depende muito do tamanho dos dados, mas o ideal é que a utilização total da CPU do Spanner esteja entre 70% e 90%. Isso fornece um bom equilíbrio entre a eficiência do Spanner e a conclusão de jobs sem erros.

Para atingir essa meta de utilização na maioria dos esquemas/cenários, recomendamos um número máximo de vCPUs de trabalho entre 4 e 6 vezes o número de nós do Spanner.

Por exemplo, para uma instância do Spanner de 10 nós, usando workers n1-standard-2, defina o máximo de workers como 25, fornecendo 50 vCPUs.