Como importar e exportar dados no formato CSV

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

  • Se você quer importar um banco de dados do Cloud Spanner que foi exportado anteriormente para os arquivos Avro no Cloud Storage, consulte Como importar arquivos Avro do Cloud Spanner.
  • Se você quer importar arquivos Avro de um banco de dados que não seja do Cloud Spanner, consulte este link.

O processo usa o Dataflow. É possível exportar dados do Cloud Spanner para um bucket do Cloud Storage ou importar dados para o Cloud 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 Cloud Spanner, primeiro você precisa ativar as APIs Cloud 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, pelo serviço do Google Cloud, são os seguintes:

  • Cloud Spanner: é necessário ter nós suficientes para ser compatível com o volume de dados que estão sendo importados. Nenhum nó adicional é necessário para importar ou exportar um banco de dados, mas talvez você precise adicionar mais nós para que seu job seja concluído em um tempo razoável. Consulte Como otimizar jobs para mais detalhes.
  • Cloud Storage: para importar, é preciso ter um bucket que contenha os arquivos exportados anteriormente. Para exportar, crie um bucket para os arquivos exportados, se ainda não tiver um. Faça isso no Console do Cloud, por meio da página do Cloud Storage ou ao criar sua exportação por meio da página do Cloud 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 Como aplicar papéis do IAM.

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

  • No nível do projeto do Google Cloud:
    • Visualizador do Cloud Spanner
    • Administrador do Dataflow
    • Administrador do Storage
  • No nível do banco de dados ou da instância do Cloud Spanner, ou no nível do projeto do Google Cloud:
    • Leitor do Cloud Spanner
    • Administrador de banco de dados do Cloud Spanner (necessário apenas para jobs de importação)

Como exportar dados do Cloud Spanner para arquivos CSV

Para exportar dados do Cloud Spanner para arquivos CSV no Cloud Storage, siga as instruções de uso da ferramenta de linha de comando gcloud para executar um job com o Modelo de texto do Cloud 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.

Como importar dados de arquivos CSV para o Cloud Spanner

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

  • Exporte seus dados para arquivos CSV e armazene-os no Cloud Storage.
  • Crie um arquivo de manifesto JSON e armazene o arquivo junto aos arquivos CSV.
  • Crie tabelas de destino vazias no banco de dados do Cloud Spanner ou garanta que os tipos de dados das colunas nos arquivos CSV correspondam às respectivas colunas nas tabelas atuais.
  • Execute o job de importação.

Como exportar dados de um banco de dados que não seja do Cloud 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:

    • BOOL
    • INT64
    • FLOAT64
    • NUMERIC
    • STRING
    • DATE
    • TIMESTAMP
  • 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.

Como 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 formato do arquivo de manifesto corresponde ao tipo de mensagem a seguir, mostrado aqui no formato de 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. Supports the
      // following data types: BOOL, INT64, FLOAT64, NUMERIC, STRING, DATE, and TIMESTAMP.
      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;
}

O exemplo a seguir mostra um arquivo de manifesto para importar tabelas chamadas Albums e Singers. 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"}
      ]
    }
  ]
}

Como criar a tabela para seu banco de dados do Cloud Spanner

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

Como executar um job de importação do Dataflow usando gcloud

Para iniciar o job de importação, siga as instruções de uso da ferramenta de linha de comando gcloud para executar um job com o Modelo CSV para o Cloud Spanner.

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

Após a conclusão do job de importação, adicione os índices secundários e as chaves externas necessários.

Como escolher uma região para o job de importação

Convém escolher uma região diferente dependendo da configuração que o bucket do Cloud Storage usa: regional ou multirregional. Para evitar cobranças de saída de rede, escolha uma região que se sobreponha ao local do seu intervalo do Cloud Storage.

Locais de intervalos regionais

Se o local do bucket do Cloud Storage for regional, escolha a mesma região para o job de importação, caso esteja disponível, para aproveitar o uso gratuito da rede.

Se a mesma região não estiver disponível, haverá cobranças de saída. Consulte os preços de saída de rede do Cloud Storage para escolher uma região que incorra tarifas de saída de rede mais baixas.

Locais de intervalos multirregionais

Se o local do bucket do Cloud Storage for multirregional, escolha uma das regiões que o compõem para aproveitar o uso gratuito da rede.

Se não houver uma região sobreposta disponível, haverá cobranças de saída. Consulte os preços de saída de rede do Cloud Storage para escolher uma região que incorra tarifas de saída de rede mais baixas.

Como visualizar ou solucionar problemas de jobs na IU do Dataflow

Depois de iniciar um job de importação ou exportação, é possível ver os detalhes dele, incluindo registros, na seção do Dataflow do Console do Cloud.

Como visualizar detalhes do job do Dataflow

Para ver detalhes de um job que está sendo executado, siga estas etapas:

  1. Navegue até a página Detalhes do banco de dados.
  2. Clique em Visualizar detalhes do job no Dataflow na mensagem de status do job, que é semelhante a esta:

    Mensagem de status do job em andamento

    O Console do Cloud exibe detalhes do job do Dataflow.

Para visualizar um job executado recentemente, siga estas etapas:

  1. Navegue até a página Detalhes do banco de dados.
  2. Clique na guia Importar/Exportar.
  3. Clique no nome do seu job na lista.

    O Console do Cloud 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 do Cloud.

    Acessar a página de jobs (em inglês)

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

    O Console do Cloud exibe detalhes do job do Dataflow.

Como visualizar registros do Dataflow para 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 do Cloud 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 Solução de problemas do pipeline.

Solução de problemas de jobs de importação ou exportação com falha

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 latência de 99% de leitura/gravação na guia Monitoramento do banco de dados do Cloud Spanner no Console do Cloud. 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 no número de workers do Dataflow:
  • 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_Avro_to_Cloud_Spanner' \
    --region=us-central1 \
    --parameters='instanceId=test-instance,databaseId=example-db,inputDir=gs://my-gcs-bucket' \
    --max-workers=10
    

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.

Como otimizar a execução lenta de jobs de importação ou exportação

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 Cloud Dataflow na mesma região em que estão localizados o bucket do Cloud Storage e a instância do Cloud 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 Cloud Spanner: é possível aumentar o número de nós de uma instância caso a utilização da CPU para ela seja superior a 65%. Os nós extras adicionam mais recursos do Cloud Spanner e isso pode acelerar o job, mas resultará em cobranças adicionais do Cloud 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 Cloud Spanner: o processamento de mais dados leva mais tempo e exige mais recursos.

  • Esquema do banco de dados do Cloud Spanner: o número de tabelas, o tamanho das linhas, o número de índices secundários e o número de chaves externas influenciam o tempo necessário para executar um job de importação ou exportação.

  • Local dos dados: os dados são transferidos entre o Cloud Spanner e o Cloud Storage usando o 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: usando 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.

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

  • Número de nós do Cloud Spanner: se a utilização da CPU para a instância for superior a 65%, o job será executado mais lentamente.