Interface de administrador do Dataproc Metastore

Nesta página, explicamos como usar a interface de administrador do metastore do Dataproc.

A interface do administrador fornece uma ferramenta centralizada para inspecionar e gerenciar os metadados armazenados no seu serviço Metastore do Dataproc, tudo sem precisar se conectar a um cluster do Dataproc ou a uma instância do Hive. Em vez disso, é possível gerenciar seus metadados com a CLI gcloud ou as APIs do Dataproc Metastore.

Por exemplo, usando a interface do administrador, é possível executar uma consulta SQL diretamente nos metadados de back-end para buscar um nome de tabela específico. Esse processo envolve seguir menos etapas do que o fluxo de trabalho típico, como criar um cluster do Dataproc, conectar-se ao cluster usando SSH, iniciar uma instância do Hive e, por fim, executar uma consulta (por exemplo, SELECT * FROM table_name).

Como resultado, a interface do administrador pode ajudar você a economizar tempo e diminuir a quantidade de recursos do Google Cloud necessários para recuperar seus dados.

Antes de começar

• Ative o metastore do Dataproc no seu projeto.
• Crie um serviço metastore do Dataproc.
• Importar metadados para o metastore do Dataproc.

Funções exigidas

Para ter as permissões necessárias para usar a interface de administrador do metastore do Dataproc, peça ao administrador para conceder a você os seguintes papéis do IAM no seu projeto, com base no princípio de privilégio mínimo:

• Para consultar metadados do metastore do Dataproc: Administrador de consultas de metadados (roles/metastore.metadataQueryAdmin) na conta de usuário ou de serviço
• Para mudar o local dos recursos dos seus metadados, incluindo bancos de dados, tabelas e partições, ou mover uma tabela para outro banco de dados:
  • Administrador de mutação de metadados (roles/metastore.metadataMutateAdmin) na conta de usuário ou de serviço
  • Editor do metastore do Dataproc (roles/metastore.editor) na conta de usuário ou de serviço

Para mais informações sobre como conceder papéis, consulte Gerenciar acesso.

Esses papéis predefinidos contêm as permissões necessárias para usar a interface de administrador do metastore do Dataproc. Para conferir as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As seguintes permissões são necessárias para usar a interface de administrador do Metastore do Dataproc:

• Para consultar metadados do metastore do Dataproc: metastore.services.queryMetadata
• Para alterar ou mover tabelas do metastore do Dataproc: metastore.services.mutateMetadata

Talvez você também consiga receber essas permissões com papéis personalizados ou outros papéis predefinidos.

Para mais informações sobre permissões e papéis específicos do metastore do Dataproc, consulte Visão geral do IAM do metastore do Dataproc.

Operações de administrador compatíveis

Só é possível executar operações de interface de administrador usando a CLI gcloud ou as APIs metastore do Dataproc. As operações da interface do administrador não são compatíveis com o console do Google Cloud.

A interface do administrador é compatível com as operações a seguir.

• Operações somente leitura.

  • Metadados de consulta.
  Aviso :execute apenas consultas somente leitura de maneira interativa. Não automatize nem execute consultas somente leitura não interativas em processos essenciais para produção. A execução de consultas não interativas poderá causar problemas se o esquema do banco de dados mudar sem aviso prévio.

• Operações de leitura e gravação.

  • Altere o local dos recursos dos seus metadados, incluindo bancos de dados, tabelas e partições.
  • alterar as propriedades da tabela, como pares de chave-valor personalizados;
  • Mover uma tabela para outro banco de dados.

Metadados de consulta

Essa operação permite procurar informações de metadados no seu banco de dados usando consultas SQL. Depois de executar uma consulta, os resultados são despejados no bucket de artefatos do Google Cloud.

Antes de executar essa operação, considere as seguintes considerações:

• As operações aceitas incluem apenas consultas read-only do MySQL ou do Spanner. Se a consulta tentar modificar os dados, a operação falhará.
• O arquivo de saída contém no máximo 1.000 linhas. Não é possível alterar essa configuração.

• Os arquivos de saída não são excluídos automaticamente. Em vez disso, é preciso excluí-las manualmente do bucket do Google Cloud. Se você não excluí-los, poderá ter custos extras de armazenamento.

CLI da gcloud

1. Para consultar metadados, execute o seguinte comando gcloud metastore services query-metadata:

   gcloud metastore services query-metadata SERVICE \
     --location=LOCATION \
     --query=QUERY

   Substitua:

   • SERVICE: o nome do serviço Metastore do Dataproc.
   • LOCATION: a região do Google Cloud em que o serviço Metastore do Dataproc reside.
   • QUERY: a consulta SQL para segmentar seus metadados.
     • Se estiver usando um banco de dados MySQL, use uma consulta normal do MySQL.
     • Se você estiver usando um banco de dados do Spanner, use uma consulta SQL padrão do Google.

2. Confira o arquivo de saída no seu bucket de artefatos do Google Cloud.

REST

Observação: o comando a seguir pressupõe que você tenha feito login na CLI gcloud com sua conta de usuário. Para fazer login, execute gcloud init ou gcloud auth login ou use o Cloud Shell, que registra você automaticamente na CLI gcloud. Execute gcloud auth list para verificar a conta ativa.

curl -X POST -s -i \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -X POST -d '{"query": "QUERY"}' \
  -H "Content-Type:application/json" \
  https://metastore.googleapis.com/projects/PROJECT_ID/locations/LOCATION/services/SERVICE:queryMetadata

Substitua:

• QUERY: a consulta SQL que você está usando para segmentar seus metadados.
  • Se estiver usando um banco de dados MySQL, use uma consulta normal do MySQL.
  • Se você estiver usando um banco de dados do Spanner, use uma consulta SQL padrão do Google.
• PROJECT_ID: o ID do projeto do Google Cloud em que o serviço do Metastore do Dataproc está localizado.
• SERVICE: o nome do serviço do Dataproc Metastore.
• LOCATION: a região em que o metastore do Dataproc reside.

O exemplo a seguir mostra um comando de amostra que executa uma consulta select * de um banco de dados chamado DBS.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" -X POST -d  '{"query": "select * from DBS;"}' \
  https://metastore.googleapis.com/projects/dpms/locations/us-central1/services/dpms1:queryMetadata

Interpretar a saída de uma operação de metadados de consulta

Quando você executa pela primeira vez um comando de metadados de consulta, o metastore do Dataproc cria automaticamente uma pasta do Google Cloud nos seus artefatos do bucket do Google Cloud. O nome desta pasta é query-results. Após cada execução de consulta bem-sucedida (chamada de API), uma nova pasta é criada dentro da pasta query-results, que é nomeada com um UUID gerado aleatoriamente.

Cada nova pasta contém um arquivo result manifest com os resultados da consulta. O local dessa pasta é retornado na resposta da chamada de API.

Por exemplo, na resposta, o campo resultManifestUri contém a localização do arquivo.

"response": {
    "@type": "type.googleapis.com/google.cloud.metastore.QueryMetadataResponse",
    "resultManifestUri": "gs://gcs-bucket-6a3638b8-e319-46363-ad33-e632a5e/query-results/800156f5-2d13-4b80-bec3-2345a9e880f6/result-manifest"
  }

A saída do arquivo result manifest será semelhante a esta:

{
  "status": {
    "code": 0,
    "message": "Query results are successfully uploaded to cloud storage",
    "details": []
  },
  "filenames": ["result-001"]
}

Detalhes do arquivo de manifesto do resultado:

• O campo status mostra se a consulta foi bem-sucedida ou não.
• Se a execução da consulta for bem-sucedida, o campo filenames listará todos os arquivos criados. Esses arquivos estão na mesma pasta que o arquivo result manifest.
• Se a consulta resultar em falha, o campo details mostrará a mensagem de erro.

Observação: por padrão, os arquivos de saída não têm um time to live (TTL). É necessário excluí-las manualmente do bucket do Google Cloud ou criar uma regra de TTL personalizada na pasta query-results. Se você não excluí-los, poderá haver custos extras de armazenamento.

Alterar o local dos recursos dos seus metadados

Essa operação permite alterar o local do recurso de um banco de dados, tabela ou partição.

Quando você executa esse comando, ele só atualiza o diretório pai ou o respectivo recurso de metadados. Esse comando não transfere nenhum dado atual para o novo local.

CLI da gcloud

1. Para alterar o local dos metadados dos recursos, execute o seguinte comando gcloud metastore services alter-metadata-resource-location:

   gcloud metastore services alter-metadata-resource-location SERVICE \
     --location=LOCATION \
     --resource_name=RESOURCE_NAME \
     --location_uri=LOCATION_URI

   Substitua:

   • SERVICE: o nome do serviço do Dataproc Metastore.
   • LOCATION: a região do Google Cloud em que o serviço Metastore do Dataproc reside.
   • RESOURCE_NAME: o nome do banco de dados, da tabela ou da partição que você está alterando.
   • LOCATION_URI: o novo caminho do Cloud Storage para o conteúdo de RESOURCE_NAME. Esse valor é o caminho para onde você está movendo o local do recurso de metadados. Esse caminho precisa começar com gs://. Por exemplo, gs://bucket/object.

2. Verifique se a alteração do local do recurso foi bem-sucedida.

REST

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário. Para fazer login, execute gcloud init ou gcloud auth login ou use o Cloud Shell, que conta com a execução de gcloud auth list.

curl -X POST -s -i \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  POST -d '{"resource_name": "RESOURCE_NAME", "location_uri":"LOCATION_URI"}' \
  -H "Content-Type:application/json" \
  https://metastore.googleapis.com/projects/PROJECT_ID/locations/LOCATION/services/SERVICE:alterLocation

Substitua:

• PROJECT_ID: o ID do projeto do Google Cloud em que o serviço do Metastore do Dataproc está localizado.
• SERVICE: o nome do serviço do metastore do Dataproc.
• LOCATION: a região em que o metastore do Dataproc reside.
• RESOURCE_NAME: o nome do banco de dados, da tabela ou da partição que você está alterando.
• LOCATION_URI: o novo caminho do Cloud Storage para o conteúdo de RESOURCE_NAME. Esse valor é o caminho para onde você está movendo o local do recurso de metadados. Esse caminho precisa começar com gs://. Por exemplo, gs://bucket/object.

Veja a seguir um comando que move uma tabela chamada test-table2 para um novo bucket do Cloud Storage.

 curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   -X POST -d  '{"resource_name": "databases/testdb1/tables/test-table2",
   "location_uri":"gs://gcs-bucket-dpms1-9425bd83-b794-4f1c-9e79-2d833f758cc1/empty"}'
   https://metastore.googleapis.com/projects/dpms/locations/us-central1/services/dpms1:alterLocation

Alterar propriedades da tabela

Essa operação permite alterar as propriedades de uma tabela, como um par de chave-valor personalizado usado para armazenar dados. Por exemplo, é possível alterar um par de chave-valor de properties.customerID_1 para properties.customerID_2.

CLI da gcloud

1. Para alterar as propriedades de uma tabela, execute o seguinte comando gcloud metastore services alter-table-properties:

   gcloud metastore services alter-table-properties SERVICE \
     --location=LOCATION \
     --table-name=TABLE_NAME \
     --update-mask=UPDATE_MASK \
     --properties=PROPERTIES

   Substitua:

   • SERVICE: o nome do serviço Metastore do Dataproc.
   • LOCATION: a região do Google Cloud em que o serviço Metastore do Dataproc reside.
   • TABLE_NAME: o nome da tabela que contém as propriedades que você está alterando no seguinte formato: databases/{database_id}/tables/{table_id}.
   • UPDATE_MASK: os valores de propriedade existentes que você está atualizando. Use uma lista separada por vírgulas para descrever os pares de chave-valor, por exemplo, properties.1,properties.2,properties.3,....
   • PROPERTIES: as novas propriedades da tabela. Use uma lista separada por vírgulas para descrever os pares de chave-valor. Por exemplo, a=1,b=2,c=3,.... Os valores listados aqui substituem os valores em UPDATE_MASK.

REST

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário. Para fazer login, execute gcloud init ou gcloud auth login ou use o Cloud Shell, que faz login automaticamente na CLI gcloud. Execute gcloud auth list para verificar a conta ativa.

curl -X POST -s -i \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  POST -d '{"table_name": "TABLE_NAME", "update_mask":"UPDATE_MASK", "properties":PROPERTIES}'\
  -H "Content-Type:application/json" \
  https://metastore.googleapis.com/projects/PROJECT_ID/locations/LOCATION/services/SERVICE:alterTableProperties

Substitua:

• SERVICE: o nome do serviço Metastore do Dataproc.
• LOCATION: a região do Google Cloud em que o serviço Metastore do Dataproc reside.
• TABLE_NAME: o nome da tabela que contém as propriedades que você está alterando no seguinte formato: databases/{database_id}/tables/{table_id}.
• UPDATE_MASK: os valores da propriedade existente que você está atualizando. Use uma lista separada por vírgulas para descrever os pares de chave-valor, por exemplo, properties.1,properties.2,properties.3,....
• PROPERTIES: as novas propriedades da tabela. Use uma lista separada por vírgulas para descrever os pares de chave-valor, por exemplo, a=1,b=2,c=3,.... Os valores listados aqui substituem os valores em UPDATE_MASK.

Veja no exemplo a seguir um comando que altera as propriedades de uma tabela chamada test-table. Neste exemplo, o par de chave-valor atual, properties.customerID_1, é atualizado para o novo valor properties.customerID_2.

  curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json"
   -X POST -d  '{"table_name": "databases/default/tables/test-table", "update_mask":{"paths":"properties.customerID_1"}, "properties":{"customerID_1":"customerID_2"}}' https://metastore.googleapis.com/projects/dpms-p

Mover uma tabela para outro banco de dados

Essa operação permite mover uma tabela interna (tabela gerenciada) para outro banco de dados. Nesse caso, o diretório pai do banco de dados e os dados dele são movidos.

Não é possível mover dados armazenados em tabelas externas.

CLI da gcloud

1. Para mover uma tabela para outro banco de dados, execute o seguinte comando gcloud metastore services move-table-to-database:

   gcloud metastore services move-table-to-database SERVICE \
     --location=LOCATION \
     --db_name=DB_NAME \
     --table_name=TABLE_NAME \
     --destination_db_name=DESTINATION_DB_NAME

   Substitua:

   • SERVICE: o nome do serviço do metastore do Dataproc.
   • LOCATION: a região do Google Cloud em que o serviço Metastore do Dataproc reside.
   • DB_NAME: o nome do banco de dados de origem que contém a tabela que você quer mover.
   • TABLE_NAME: o nome da tabela que você quer mover.
   • DESTINATION_DB_NAME: o nome do novo banco de dados para o qual você quer mover a tabela.

2. Verifique se a alteração da tabela foi bem-sucedida.

REST

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário. Para fazer login, execute gcloud init ou gcloud auth login ou use o Cloud Shell, que faz login automaticamente na CLI gcloud. Execute gcloud auth list para verificar a conta ativa.

curl -X POST -s -i \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  POST -d '{"table_name": "TABLE_NAME", "db_name": "DB_NAME", "destination_db_name": "DESTINATION_DB_NAME"}'\
  -H "Content-Type:application/json" \
  https://metastore.googleapis.com/projects/PROJECT_ID/locations/LOCATION/services/SERVICE:moveTableToDatabase

Substitua:

• PROJECT_ID: o ID do projeto do Google Cloud em que o serviço Metastore do Dataproc reside.
• SERVICE: o nome do serviço do Dataproc Metastore.
• LOCATION: a região em que o metastore do Dataproc reside.
• DB_NAME: o nome do banco de dados de origem que contém a tabela que você quer mover.
• TABLE_NAME: o nome da tabela que você quer mover.
• DESTINATION_DB_NAME: o nome do novo banco de dados para o qual você quer mover a tabela.

O exemplo a seguir mostra um comando que move um banco de dados chamado testdb1 para um banco de dados diferente chamado testdb2.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
 -H "Content-Type: application/json"
 -X POST -d  '{"table_name": "testtb1", "db_name": "testdb1",
 "destination_db_name": "testdb2"}' https://metastore.googleapis.com/projects/dpms/locations/asia-northeast2/services/dpms1:moveTableToDatabase

A seguir

• Exportar metadados
• Atualizar uma metastore
• Fazer backup de um metastore