CLI do Catálogo do Unity (herdada)

Importante

Esta documentação foi desativada e pode não estar atualizada.

Essas informações se aplicam às versões herdadas da CLI do Databricks 0.18 e anteriores. O Databricks recomenda que você use a versão 0.205 da CLI do Databricks mais recente ou superior. Consulte a CLI do Databricks. Para localizar sua versão da CLI do Databricks, execute databricks -v.

Para migrar da CLI do Databricks versão 0.18 ou inferior para a CLI do Databricks versão 0.205 ou superior, consulte Migração da CLI do Databricks.

Observação

A CLI do Catálogo do Unity é Experimental.

Para a CLI do Catálogo Unity, é necessário utilizar o Legacy Databricks CLI 0.17.0 ou superior, configurado com autenticação. Para atualizar a CLI do Databricks ou listar a versão instalada, confira Atualizar a CLI.

Os valores de exemplo de opção e campo nos exemplos a seguir são somente para fins ilustrativos.

Use a CLI do Catálogo do Unity para trabalhar com o seguinte:

  • Recursos do Catálogo do Unity, como metastores, credenciais de armazenamento, locais externos, catálogos, esquemas, tabelas e suas respectivas permissões.
  • Recursos de Compartilhamento Delta, como compartilhamentos, destinatários e provedores.

Você executa os subcomandos da CLI do Catálogo do Unity anexando-os a databricks unity-catalog. Esses subcomandos chamam a API do Catálogo do Unity, que também inclui a API de Compartilhamento Delta.

Para ver a documentação de uso, execute databricks unity-catalog --help.

Saída:

Usage: databricks unity-catalog [OPTIONS] COMMAND [ARGS]...

  Utility to interact with Databricks Unity Catalog.

Options:
  -v, --version  0.17.1
  -h, --help     Show this message and exit.

Commands:
  catalogs
  external-locations
  lineage
  metastores
  permissions
  providers
  recipients
  schemas
  shares
  storage-credentials
  tables

Metastores

Use o subcomando unity-catalog metastores para trabalhar com metastores.

Para ver a documentação de uso, execute databricks unity-catalog metastores --help.

Criar um metastore

Para ver a documentação de uso, execute databricks unity-catalog metastores create --help. Consulte também Criar um metastore do Catálogo do Unity.

Observação

A criação de um metastore não o associa automaticamente a um workspace ou a uma credencial de armazenamento. Para concluir essas tarefas, consulte Vincular um metastore com um workspace, criar uma credencial de armazenamento e atualizar as configurações de um metastore.

Se você executar esse comando em um workspace que já tenha um metastore atribuído, atualizará o metastore atribuído ao workspace.

Para ver a documentação de uso, execute databricks unity-catalog metastores assign --help.

databricks unity-catalog metastores assign --workspace-id 1234567890123456 \
                                           --metastore-id 12a345b6-7890-1cd2-3456-e789f0a12b34 \
                                           --default-catalog-name main

Para obter a ID do workspace, confira Nomes de instância, URLs e IDs do workspace.

Para obter a ID do metastore, execute databricks unity-catalog metastores get-summary. Para ver um exemplo, confira Obter informações resumidas sobre o metastore atual.

Saída:

{}

Consulte também Criar um metastore do Catálogo do Unity.

Atualizar as configurações de um metastore

Para ver a documentação de uso, execute databricks unity-catalog metastores update --help.

databricks unity-catalog metastores update --id 12a345b6-7890-1cd2-3456-e789f0a12b34 \
                                           --json-file update-metastore.json

Para obter a ID do metastore, execute databricks unity-catalog metastores get-summary. Para ver um exemplo, confira Obter informações resumidas sobre o metastore atual.

update-metastore.json:

{
  "storage_root_credential_id": "12a345b6-7890-1cd2-3456-e789f0a12b34"
}

Para obter a ID da credencial raiz de armazenamento, confira Obter informações sobre uma credencial de armazenamento.

Listar os metastores disponíveis

Para ver a documentação de uso, execute databricks unity-catalog metastores list --help.

databricks unity-catalog metastores list

Obter informações sobre um metastore

Para ver a documentação de uso, execute databricks unity-catalog metastores get --help.

databricks unity-catalog metastores get --id 12a345b6-7890-1cd2-3456-e789f0a12b34

Para obter a ID do metastore, execute databricks unity-catalog metastores get-summary. Para ver um exemplo, confira Obter informações resumidas sobre o metastore atual.

Obter informações resumidas sobre o metastore atual

Para ver a documentação de uso, execute databricks unity-catalog metastores get-summary --help.

databricks unity-catalog metastores get-summary

Obter a atribuição de metastore atual para um workspace

Para ver a documentação de uso, execute databricks unity-catalog metastores get-assignment --help.

databricks unity-catalog metastores get-assignment

Saída:

{
  "workspace_id": 1234567890123456,
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "default_catalog_name": "main"
}

Para ver a documentação de uso, execute databricks unity-catalog metastores unassign --help.

databricks unity-catalog metastores unassign --workspace-id 1234567890123456 \
                                             --metastore-id 12a345b6-7890-1cd2-3456-e789f0a12b34

Para obter a ID do workspace, confira Nomes de instância, URLs e IDs do workspace.

Para obter a ID do metastore, execute databricks unity-catalog metastores get-summary. Para ver um exemplo, confira Obter informações resumidas sobre o metastore atual.

Saída:

{}

Excluir um metastore

Aviso

Ates de excluir um metastore, você precisa excluir os workspaces que usam o metastore ou remover o link do metastore para esses workspaces. Contate o suporte do Azure Databricks para obter assistência com a remoção de links metastore dos workspaces.

Para ver a documentação de uso, execute databricks unity-catalog metastores delete --help.

Para excluir o metastore à força, use a opção --force.

databricks unity-catalog metastores delete --id 12a345b6-7890-1cd2-3456-e789f0a12b34

Para obter a ID do metastore, execute databricks unity-catalog metastores get-summary. Para ver um exemplo, confira Obter informações resumidas sobre o metastore atual.

Se a operação for bem-sucedida, nenhum resultado será retornado.

Credenciais de armazenamento

Use o subcomando unity-catalog storage-credentials para trabalhar com credenciais de armazenamento. Consulte Criar uma credencial de armazenamento que acesse o ADLS Gen2.

Para ver a documentação de uso, execute databricks unity-catalog storage-credentials --help.

Criar uma credencial de armazenamento

Para ver a documentação de uso, execute databricks unity-catalog storage-credentials create --help.

Consulte também Criar uma credencial de armazenamento que acesse o ADLS Gen2.

Atualizar as configurações de uma credencial de armazenamento

Para ver a documentação de uso, execute databricks unity-catalog storage-credentials update --help.

Listar as credenciais de armazenamento disponíveis

Para ver a documentação de uso, execute databricks unity-catalog storage-credentials list --help.

databricks unity-catalog storage-credentials list

Obter informações sobre uma credencial de armazenamento

Para ver a documentação de uso, execute databricks unity-catalog storage-credentials get --help.

databricks unity-catalog storage-credentials get --name my-storage-root-credential

Excluir uma credencial de armazenamento

Para ver a documentação de uso, execute databricks unity-catalog storage-credentials delete --help.

Para excluir à força a credencial de armazenamento, use a opção --force.

databricks unity-catalog storage-credentials delete --name my-storage-root-credential

Se a operação for bem-sucedida, nenhum resultado será retornado.

Locais externos

Use o subcomando unity-catalog external-locations para trabalhar com locais externos. Confira a visão geral de locais externos.

Para ver a documentação de uso, execute databricks unity-catalog external-locations --help.

Criar um local externo

Para ver a documentação de uso, execute databricks unity-catalog external-locations create --help. Consulte também Visão geral de locais externos.

Validar um local externo e um par de credenciais

Para ver a documentação de uso, execute databricks unity-catalog external-locations validate --help.

Validar um nome de local externo e um par de credenciais depois de criá-los

databricks unity-catalog external-locations validate --name my-external-location \
                                                     --cred-name my-storage-root-credential

Saída:

{
  "isDir": true,
  "results": [
    {
      "operation": "READ",
      "result": "PASS"
    },
    {
      "operation": "LIST",
      "result": "PASS"
    },
    {
      "operation": "WRITE",
      "result": "PASS"
    },
    {
      "operation": "DELETE",
      "result": "PASS"
    }
  ]
}

Atualizar as configurações de um local externo

Para ver a documentação de uso, execute databricks unity-catalog external-locations update --help.

databricks unity-catalog external-locations update --name my-external-location \
                                                   --json-file update-external-location.json

udpate-external-location.json:

{
  "name": "my-external-location-2"
}

Listar os locais externos disponíveis

Para ver a documentação de uso, execute databricks unity-catalog external-locations list --help.

databricks unity-catalog external-locations list

Obter informações sobre um local externo

Para ver a documentação de uso, execute databricks unity-catalog external-locations get --help.

databricks unity-catalog external-locations get --name my-external-location

Excluir um local externo

Para ver a documentação de uso, execute databricks unity-catalog external-locations delete --help.

Para excluir à força o local externo, use a opção --force.

databricks unity-catalog external-locations delete --name my-external-location

Se a operação for bem-sucedida, nenhum resultado será retornado.

Catálogos

Use o subcomando unity-catalog catalogs para trabalhar com catálogos.

Para ver a documentação de uso, execute databricks unity-catalog catalogs --help.

Criar um catálogo

Para ver a documentação de uso, execute databricks unity-catalog catalogs create --help. Veja também Criar catálogos.

databricks unity-catalog catalogs create --name my-catalog

Saída:

{
  "name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "created_at": 1656113178995,
  "created_by": "someone@example.com",
  "updated_at": 1656113178995,
  "updated_by": "someone@example.com",
  "catalog_type": "MANAGED_CATALOG"
}

Atualizar as configurações de um catálogo

Para ver a documentação de uso, execute databricks unity-catalog catalogs update --help.

databricks unity-catalog catalogs update --name my-catalog \
                                         --json-file update-catalog.json

update-catalog.json:

{
  "name": "my-catalog-2",
  "owner": "someone@example.com"
}

Saída:

{
  "name": "my-catalog-2",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "created_at": 1656355967835,
  "created_by": "someone@example.com",
  "updated_at": 1656356095989,
  "updated_by": "someone@example.com",
  "catalog_type": "MANAGED_CATALOG"
}

Listar os catálogos disponíveis

Para ver a documentação de uso, execute databricks unity-catalog catalogs list --help.

databricks unity-catalog catalogs list

Saída:

{
  "catalogs": [
    {
      "name": "main",
      "owner": "someone@example.com",
      "comment": "Main catalog (auto-created)",
      "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656112029355,
      "created_by": "someone@example.com",
      "updated_at": 1656112029355,
      "updated_by": "someone@example.com",
      "catalog_type": "MANAGED_CATALOG"
    },
    {
      "...": "..."
    }
  ]
}

Obter informações sobre um catálogo

Para ver a documentação de uso, execute databricks unity-catalog catalogs get --help.

databricks unity-catalog catalogs get --name my-catalog

Saída:

{
  "name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "created_at": 1656113178995,
  "created_by": "someone@example.com",
  "updated_at": 1656113178995,
  "updated_by": "someone@example.com",
  "catalog_type": "MANAGED_CATALOG"
}

Excluir um catálogo

Para ver a documentação de uso, execute databricks unity-catalog catalogs delete --help. Veja também Excluir um catálogo.

Para excluir um catálogo à força, use a opção --purge.

databricks unity-catalog catalogs delete --name my-catalog

Se a operação for bem-sucedida, nenhum resultado será retornado.

Esquemas

Use o subcomando unity-catalog schemas para trabalhar com esquemas.

Para ver a documentação de uso, execute databricks unity-catalog schemas --help.

Criar um esquema

Para ver a documentação de uso, execute databricks unity-catalog schemas create --help. Veja também Criar esquemas.

databricks unity-catalog schemas create --catalog-name my-catalog \
                                        --name my-schema

Saída:

{
  "name": "my-schema",
  "catalog_name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "full_name": "my-catalog.my-schema",
  "created_at": 1656113607800,
  "created_by": "someone@example.com",
  "updated_at": 1656113607800,
  "updated_by": "someone@example.com"
}

Alterar as configurações de um esquema

Para ver a documentação de uso, execute databricks unity-catalog schemas update --help.

databricks unity-catalog schemas update --full-name my-catalog.my-schema \
                                        --json-file update-schema.json

update-schema.json:

{
  "name": "my-schema-2",
  "owner": "someone@example.com"
}

Saída:

{
  "name": "my-schema-2",
  "catalog_name": "my-catalog",
  "owner": "someone@example.com",
  "comment": "Default schema (auto-created)",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "full_name": "my-catalog.my-schema-2",
  "created_at": 1656355967837,
  "created_by": "someone@example.com",
  "updated_at": 1656356592786,
  "updated_by": "someone@example.com"
}

Listar os esquemas disponíveis

Para ver a documentação de uso, execute databricks unity-catalog schemas list --help.

databricks unity-catalog schemas list --catalog-name my-catalog

Saída:

{
  "schemas": [
    {
      "name": "default",
      "catalog_name": "my-catalog",
      "owner": "someone@example.com",
      "comment": "Default schema (auto-created)",
      "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "full_name": "my-catalog.default",
      "created_at": 1656113178996,
      "created_by": "someone@example.com",
      "updated_at": 1656113178996,
      "updated_by": "someone@example.com"
    },
    {
      "...": "..."
    }
  ]
}

Obter informações sobre um esquema

Para ver a documentação de uso, execute databricks unity-catalog schemas get --help.

databricks unity-catalog schemas get --full-name my-catalog.my-schema

Saída:

{
  "name": "my-schema",
  "catalog_name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "full_name": "my-catalog.my-schema",
  "created_at": 1656113607800,
  "created_by": "someone@example.com",
  "updated_at": 1656113607800,
  "updated_by": "someone@example.com"
}

Excluir um esquema

Para ver a documentação de uso, execute databricks unity-catalog schemas delete --help. Veja também Excluir um esquema.

Para excluir um esquema à força, use a opção --purge.

databricks unity-catalog schemas delete --full-name my-catalog.my-schema

Se a operação for bem-sucedida, nenhum resultado será retornado.

Tabelas

Use o subcomando unity-catalog tables para trabalhar com tabelas.

Observação

Não há suporte para a criação de tabelas com a CLI do Catálogo do Unity. Para criar tabelas, consulte Azure Databricks tabelas e Tutorial: crie sua primeira tabela e conceda privilégios.

Para ver a documentação de uso, execute databricks unity-catalog tables --help.

Listar as tabelas disponíveis

Para ver a documentação de uso, execute databricks unity-catalog tables list --help.

databricks unity-catalog tables list --catalog-name main \
                                     --schema-name default

Listar os resumos de tabelas disponíveis

Para ver a documentação de uso, execute databricks unity-catalog tables list-summaries --help.

databricks unity-catalog tables list-summaries --catalog-name main

Saída:

{
  "tables": [
    {
      "full_name": "main.default.mytable",
      "table_type": "MANAGED"
    },
    {
      "...": "..."
    }
  ]
}

Obter informações sobre uma tabela

Para ver a documentação de uso, execute databricks unity-catalog tables get --help.

databricks unity-catalog tables get --full-name main.default.mytable

Excluir uma tabela

Para ver a documentação de uso, execute databricks unity-catalog tables delete --help.

databricks unity-catalog tables delete --full-name main.default.mytable

Se a operação for bem-sucedida, nenhum resultado será retornado.

Linhagens

Use o subcomando unity-catalog lineage para trabalhar com linhagens de tabela e coluna.

Para ver a documentação de uso, execute databricks unity-catalog lineage --help.

Listar a linhagem de uma tabela

Para ver a documentação de uso, execute databricks unity-catalog lineage table --help.

databricks unity-catalog lineage table --table-name main.default.mytable \
                                       --level 1

Listar a linhagem de uma coluna

Para ver a documentação de uso, execute databricks unity-catalog lineage column --help.

databricks unity-catalog lineage column --table-name main.default.mytable \
                                        --column-name id

Permissões

Use o subcomando unity-catalog permissions para trabalhar com permissões para objetos protegíveis. Veja também Gerenciar privilégios no Catálogo do Unity.

Para ver a documentação de uso, execute databricks unity-catalog permissions --help.

Obter as informações sobre permissões para um objeto protegível

Para ver a documentação de uso, execute databricks unity-catalog permissions get --help. Consulte também a referência de privilégios do Unity Catalog.

Catálogo

databricks unity-catalog permissions get --catalog main

Saída:

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": ["USE CATALOG"]
    }
  ]
}

Esquema

databricks unity-catalog permissions get --schema main.default

Saída:

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": ["USE SCHEMA"]
    }
  ]
}

Tabela

databricks unity-catalog permissions get --table main.default.mytable

Saída:

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": ["SELECT"]
    }
  ]
}

Credencial de armazenamento

databricks unity-catalog permissions get --storage-credential my-storage-root-credential

Saída:

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": ["READ_FILES"]
    }
  ]
}

Local externo

databricks unity-catalog permissions get --external-location my-external-location

Saída:

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": ["READ_FILES"]
    }
  ]
}

Atualizar as permissões de um objeto protegível

Para ver a documentação de uso, execute databricks unity-catalog permissions update --help. Consulte também a referência de privilégios do Unity Catalog.

Catálogo

databricks unity-catalog permissions update --catalog \
                                            --json-file update-catalog-permissions.json

update-catalog-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "add": ["USE CATALOG"],
      "remove": ["CREATE SCHEMA"]
    }
  ]
}

Esquema

databricks unity-catalog permissions update --schema \
                                            --json-file update-schema-permissions.json

update-schema-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "add": ["USE SCHEMA"],
      "remove": ["CREATE TABLE"]
    },
    {
      "principal": "admin team",
      "add": ["CREATE TABLE"]
    }
  ]
}

Tabela

databricks unity-catalog permissions update --table \
                                            --json-file update-table-permissions.json

update-table-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "add": ["SELECT"],
      "remove": ["MODIFY"]
    },
    {
      "principal": "admin team",
      "add": ["ALL"]
    }
  ]
}

Credencial de armazenamento

databricks unity-catalog permissions update --storage-credential \
                                            --json-file update-storage-credential-permissions.json

update-storage-credential-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "remove": ["READ FILES"]
    },
    {
      "principal": "storage team",
      "add": ["READ FILES", "WRITE FILES", "CREATE EXTERNAL TABLE"]
    },
    {
      "principal": "admin team",
      "add": ["ALL"]
    }
  ]
}

Local externo

databricks unity-catalog permissions update --external-location \
                                            --json-file update-external-location-permissions.json

update-external-location-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "remove": ["READ FILES"]
    },
    {
      "principal": "storage team",
      "add": ["READ FILES", "WRITE FILES", "CREATE EXTERNAL TABLE"]
    },
    {
      "principal": "admin team",
      "add": ["ALL"]
    }
  ]
}

Compartilhamentos

Use o subcomando unity-catalog shares para trabalhar com compartilhamentos, que são objetos que contêm coleções de tabelas em um metastore do Catálogo do Unity habilitado para o Compartilhamento Delta que você deseja compartilhar como um grupo com destinatários do Compartilhamento Delta. Um compartilhamento pode conter tabelas de apenas um metastore. Consulte Criar compartilhamentos para Delta Sharing.

Para ver a documentação de uso, execute databricks unity-catalog shares --help.

Criar um compartilhamento

Para ver a documentação de uso, execute databricks unity-catalog shares create --help. Consulte também Criar compartilhamentos para Delta Sharing.

databricks unity-catalog shares create --name my-share

Saída:

{
  "name": "my-share",
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

Atualizar as configurações de um compartilhamento

Para ver a documentação de uso, execute databricks unity-catalog shares update --help. Confira também Atualizar compartilhamentos.

Adicionar uma tabela a um compartilhamento

databricks unity-catalog shares update --name my-share \
                                       --add-table main.default.mytable

Saída:

{
  "name": "my-share",
  "objects": [
    {
      "name": "main.default.mytable",
      "data_object_type": "TABLE",
      "added_at": 1656434168847,
      "added_by": "someone@example.com",
      "shared_as": "default.mytable",
      "cdf_enabled": false
    }
  ],
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

Confira também Adicionar tabelas a um compartilhamento.

Remover uma tabela de um compartilhamento

databricks unity-catalog shares update --name my-share \
                                       --remove-table main.default.mytable

Saída:

{
  "name": "my-share",
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

Confira também Adicionar tabelas a um compartilhamento.

Atualizar as permissões de um compartilhamento

Para ver a documentação de uso, execute databricks unity-catalog shares update-permissions --help. Veja também Gerenciar o acesso aos compartilhamentos de dados do Delta Sharing (para provedores).

databricks unity-catalog shares update-permissions --name my-share \
                                                   --json-file update-share-permissions.json

update-share-permissions.json:

{
  "privilege_assignments": [
    {
      "principal": "my-recipient",
      "privileges": ["SELECT"]
    }
  ]
}

Listar os compartilhamentos disponíveis

Para ver a documentação de uso, execute databricks unity-catalog shares list --help. Confira também Exibir compartilhamentos e detalhes de compartilhamento.

databricks unity-catalog shares list

Saída:

{
  "shares": [
    {
      "name": "my-share",
      "created_at": 1656433327533,
      "created_by": "someone@example.com",
      "owner": "someone@example.com"
    },
    {
      "...": "..."
    }
  ]
}

Obter informações sobre um compartilhamento

Para ver a documentação de uso, execute databricks unity-catalog shares get --help. Confira também Exibir compartilhamentos e detalhes de compartilhamento.

databricks unity-catalog shares get --name my-share

Saída:

{
  "name": "my-share",
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

Listar as permissões de um compartilhamento

Para ver a documentação de uso, execute databricks unity-catalog shares list-permissions --help. Confira também Exibir os destinatários que têm permissões em um compartilhamento.

databricks unity-catalog shares list-permissions --name my-share

Saída:

{
  "privilege_assignments": [
    {
      "principal": "my-recipient",
      "privileges": ["SELECT"]
    }
  ]
}

Excluir um compartilhamento

Para ver a documentação de uso, execute databricks unity-catalog shares delete --help. Veja também Excluir compartilhamentos.

databricks unity-catalog shares delete --name my-share

Se a operação for bem-sucedida, nenhum resultado será retornado.

Destinatários

Use o subcomando unity-catalog recipients para trabalhar com destinatários de dados de metastores do Catálogo do Unity habilitados para o Compartilhamento Delta. Os destinatários de dados são pessoas ou grupos com os quais um usuário Azure Databricks compartilha dados fora da organização do Azure Databricks usuário. Consulte Criar destinatários de dados para o compartilhamento Delta (compartilhamento de Databricks para Databricks).

Para ver a documentação de uso, execute databricks unity-catalog recipients --help.

Criar um destinatário

Para ver a documentação de uso, execute databricks unity-catalog recipients create --help. Consulte também Criar destinatários de dados para o Compartilhamento Delta (Compartilhamento de Databricks para Databricks).

Para gerar uma URL de ativação para um destinatário, execute databricks unity-catalog recipients rotate-token. Para um exemplo, veja Rotacionar o token de um destinatário.

databricks unity-catalog recipients create --name my-recipient

Saída:

{
  "name": "my-recipient",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656521688006,
      "updated_at": 1656435288006,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656435288003,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

Alterar as configurações de um destinatário

Para ver a documentação de uso, execute databricks unity-catalog recipients update --help.

databricks unity-catalog recipients update --name my-recipient \
                                           --json-file update-recipient-settings.json

update-recipient-settings.json:

{
  "name": "my-recipient-2"
}

Saída:

{
  "name": "my-recipient-2",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "expiration_time": 1656436808507,
      "updated_at": 1656435908507,
      "updated_by": "someone@example.com"
    },
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435908509,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656522308510,
      "updated_at": 1656435908510,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656436740986,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

Girar o token de um destinatário

Para ver a documentação de uso, execute databricks unity-catalog recipients rotate-token --help. Consulte também Gerenciar tokens de destinatário.

databricks unity-catalog recipients rotate-token --name my-recipient \
                                                 --existing-token-expire-in-seconds 900

Saída:

{
  "name": "my-recipient",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "expiration_time": 1656436808507,
      "updated_at": 1656435908507,
      "updated_by": "someone@example.com"
    },
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435908509,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656522308510,
      "updated_at": 1656435908510,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656435288003,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

Listar os destinatários disponíveis

Para ver a documentação de uso, execute databricks unity-catalog recipients list --help. Confira também Exibir destinatários.

databricks unity-catalog recipients list

Saída:

{
  "recipients": [
    {
      "name": "my-recipient",
      "created_at": 1656435288003,
      "created_by": "someone@example.com",
      "tokens": [
        {
          "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
          "created_at": 1656435288005,
          "created_by": "someone@example.com",
          "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
          "expiration_time": 1656521688006,
          "updated_at": 1656435288006,
          "updated_by": "someone@example.com"
        }
      ],
      "authentication_type": "TOKEN",
      "updated_at": 1656435288003,
      "updated_by": "someone@example.com",
      "owner": "someone@example.com"
    }
  ]
}

Listar as permissões de compartilhamento de um destinatário

Para ver a documentação de uso, execute databricks unity-catalog recipients list-permissions --help. Veja também as permissões de compartilhamento de um destinatário.

databricks unity-catalog recipients list-permissions --name my-recipient

Saída:

{
  "permissions_out": [
    {
      "share_name": "my-share",
      "privilege_assignments": [
        {
          "privileges": ["SELECT"]
        }
      ]
    }
  ]
}

Obter informações sobre um destinatário

Para ver a documentação de uso, execute databricks unity-catalog recipients get --help. Confira também Exibir os detalhes do destinatário.

databricks unity-catalog recipients get --name my-recipient

Saída:

{
  "name": "my-recipient",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656521688006,
      "updated_at": 1656435288006,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656435288003,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

Excluir um destinatário

Para ver a documentação de uso, execute databricks unity-catalog recipients delete --help. Veja também Excluir um destinatário.

databricks unity-catalog recipients delete --name my-recipient

Se a operação for bem-sucedida, nenhum resultado será retornado.

Provedores

Se você for um destinatário de dados compartilhados do Compartilhamento Delta, use o subcomando unity-catalog providers para trabalhar com provedores de dados do Compartilhamento Delta. Consulte Gerenciar provedores de compartilhamento Delta para destinatários de dados.

Para ver a documentação de uso, execute databricks unity-catalog providers --help.

Criar um provedor

Se você for um destinatário de dados compartilhados que usa o protocolo de compartilhamento aberto e estiver usando um workspace do Databricks anexado a um metastore do Catálogo do Unity, será possível criar um objeto de provedor no metastore do Catálogo do Unity. Em seguida, será possível gerenciar o acesso aos dados compartilhados usando o Catálogo do Unity.

Importante

Este cenário é raro. Se você estiver usando um workspace do Databricks habilitado para o Unity Catalog e outro cliente do Databricks estiver compartilhando dados com você, ele deverá usar o Compartilhamento do Databricks para Databricks. Com o compartilhamento do Databricks para Databricks, os objetos do provedor são criados para você no Unity Catalog.

Para criar um provedor, você deve:

Execute o comando a seguir, substituindo my-provider pelo nome que você deseja dar ao provedor e config.share pelo caminho para o arquivo de credencial baixado, que é chamado de config.share por padrão.

databricks unity-catalog providers create --name my-provider  \
                  --recipient-profile-json-file config.share

Atualizar as configurações de um provedor

Para ver a documentação de uso, execute databricks unity-catalog providers update --help.

databricks unity-catalog providers update --name my-provider \
                                          --new-name my-provider-2

Listar os provedores disponíveis

Para ver a documentação de uso, execute databricks unity-catalog providers list --help.

databricks unity-catalog providers list

Obter informações sobre um provedor

Para ver a documentação de uso, execute databricks unity-catalog providers get --help.

databricks unity-catalog providers get --name my-provider

Listar os compartilhamentos disponíveis de um provedor

Para ver a documentação de uso, execute databricks unity-catalog providers list-shares --help.

databricks unity-catalog providers list-shares --name my-provider

Excluir um provedor

Para ver a documentação de uso, execute databricks unity-catalog providers delete --help.

databricks unity-catalog providers delete --name my-provider

Se a operação for bem-sucedida, nenhum resultado será retornado.

  • Last updated on