CLI de Unity Catalog (heredada)

Importante

Esta documentación se ha retirado y es posible que no se actualice.

Esta información se aplica a las versiones heredadas de la CLI de Databricks 0.18 y versiones posteriores. En su lugar, Databricks recomienda usar la versión más reciente 0.205 o posterior de la CLI de Databricks. Consulte ¿Qué es la CLI de Databricks?. Para encontrar su versión de la CLI de Databricks, ejecute databricks -v.

Para migrar de Databricks CLI versión 0.18 o inferior a Databricks CLI versión 0.205 o superior, consulte Migración de Databricks CLI.

Nota

La CLI de Unity Catalog es experimental.

La CLI de Unity Catalog requiere la CLI de Databricks 0.17.0 o posterior, configurada con autenticación. Para actualizar la CLI de Databricks o mostrar la versión instalada, consulte Actualización de la CLI.

Los valores de opción y campo de los ejemplos siguientes se usan solo con fines ilustrativos.

Use la CLI de Unity Catalog para trabajar con:

• recursos Unity Catalog, tales como metastores, credenciales de almacenamiento, ubicaciones externas, catálogos, esquemas, tablas y sus permisos.
• recursos de Delta Sharing tales como recursos compartidos, destinatarios y proveedores.

Para ejecutar subcomandos de la CLI de Unity Catalog, anéxelos a databricks unity-catalog. Estos subcomandos llaman a la API de Unity Catalog, que también incluye la API de Delta Sharing.

Para mostrar la documentación de uso, ejecute databricks unity-catalog --help.

Salida:

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 el subcomando unity-catalog metastores para trabajar con metastores.

Para mostrar la documentación de uso, ejecute databricks unity-catalog metastores --help.

• Creación de un metastore
• Vinculación de un metastore con un área de trabajo
• Actualización de la configuración de una tienda de metadatos
• Listado de metastores disponibles
• Obtener información sobre un metastore
• Obtener información resumida sobre el metastore actual
• Obtener la asignación actual de metastore para un área de trabajo
• Desvincular un metastore de un área de trabajo
• Eliminar un metastore

Creación de un metastore

Para mostrar la documentación de uso, ejecute databricks unity-catalog metastores create --help. Consulte también Creación de un metastore de Unity Catalog.

Nota

La creación de un metastore no asocia automáticamente el metastore con un área de trabajo o una credencial de almacenamiento. Para completar estas tareas, consulte Vinculación de una tienda de metadatos con un área de trabajo, Creación de una credencial de almacenamiento y Actualización de la configuración de un metastore.

Vinculación de un metastore con un área de trabajo

Si ejecuta este comando en un área de trabajo que ya tiene un metastore asignado, actualizará la metastore asignada de esa área de trabajo.

Para mostrar la documentación de uso, ejecute 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 obtener el identificador del área de trabajo, consulte Nombres, direcciones URL e identificadores de instancias de áreas de trabajo.

Para obtener el identificador de metastore, ejecute databricks unity-catalog metastores get-summary. Para ver un ejemplo, consulte Obtención de información resumida sobre el metastore actual.

Salida:

{}

Consulte también Creación de un metastore de Unity Catalog.

Actualizar la configuración de un metastore

Para mostrar la documentación de uso, ejecute databricks unity-catalog metastores update --help.

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

Para obtener el identificador de metastore, ejecute databricks unity-catalog metastores get-summary. Para ver un ejemplo, consulte Obtención de información resumida sobre el metastore actual.

update-metastore.json:

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

Para obtener el identificador de la credencial raíz del almacenamiento, consulte Obtención de información sobre una credencial de almacenamiento.

Enumeración de metastores disponibles

Para mostrar la documentación de uso, ejecute databricks unity-catalog metastores list --help.

databricks unity-catalog metastores list

Obtención de información sobre un metastore

Para mostrar la documentación de uso, ejecute databricks unity-catalog metastores get --help.

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

Para obtener el identificador de metastore, ejecute databricks unity-catalog metastores get-summary. Para ver un ejemplo, consulte Obtención de información resumida sobre el metastore actual.

Obtener información resumida sobre el metastore actual

Para mostrar la documentación de uso, ejecute databricks unity-catalog metastores get-summary --help.

databricks unity-catalog metastores get-summary

Obtención de la asignación actual de metastore para un área de trabajo

Para mostrar la documentación de uso, ejecute databricks unity-catalog metastores get-assignment --help.

databricks unity-catalog metastores get-assignment

Salida:

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

Desvinculación de un metastore de un área de trabajo

Para mostrar la documentación de uso, ejecute databricks unity-catalog metastores unassign --help.

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

Para obtener el identificador del área de trabajo, consulte Nombres, direcciones URL e identificadores de instancias de áreas de trabajo.

Para obtener el identificador de metastore, ejecute databricks unity-catalog metastores get-summary. Para ver un ejemplo, consulte Obtención de información resumida sobre el metastore actual.

Salida:

{}

Eliminación de un metastore

Advertencia

Antes de eliminar un metastore, deberá eliminar las áreas de trabajo que lo usen o quitar el vínculo que exista entre este y las áreas de trabajo. Póngase en contacto con el soporte técnico de Azure Databricks para obtener ayuda con la eliminación de vínculos de metastore en las áreas de trabajo.

Para mostrar la documentación de uso, ejecute databricks unity-catalog metastores delete --help.

Para forzar la eliminación del metastore, use la opción --force.

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

Para obtener el identificador de metastore, ejecute databricks unity-catalog metastores get-summary. Para ver un ejemplo, consulte Obtención de información resumida sobre el metastore actual.

Si la operación se realiza correctamente, no se devuelve ningún resultado.

Credenciales de almacenamiento

Use el subcomando unity-catalog storage-credentials para trabajar con las credenciales de almacenamiento. Consulte Creación de una credencial de almacenamiento para conectarse a Azure Data Lake Storage.

Para mostrar la documentación de uso, ejecute databricks unity-catalog storage-credentials --help.

• Crear una credencial de almacenamiento
• Actualización de la configuración de una credencial de almacenamiento
• Listar las credenciales de almacenamiento disponibles
• Obtener información sobre una credencial de almacenamiento
• Eliminar una credencial de almacenamiento

Creación de una credencial de almacenamiento

Para mostrar la documentación de uso, ejecute databricks unity-catalog storage-credentials create --help.

Consulte también Creación de una credencial de almacenamiento para conectarse a Azure Data Lake Storage.

Actualización de la configuración de una credencial de almacenamiento

Para mostrar la documentación de uso, ejecute databricks unity-catalog storage-credentials update --help.

Enumeración de las credenciales de almacenamiento disponibles

Para mostrar la documentación de uso, ejecute databricks unity-catalog storage-credentials list --help.

databricks unity-catalog storage-credentials list

Obtención de información sobre una credencial de almacenamiento

Para mostrar la documentación de uso, ejecute databricks unity-catalog storage-credentials get --help.

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

Eliminación de una credencial de almacenamiento

Para mostrar la documentación de uso, ejecute databricks unity-catalog storage-credentials delete --help.

Para forzar la eliminación de la credencial de almacenamiento, use la opción --force.

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

Si la operación se realiza correctamente, no se devuelve ningún resultado.

Ubicaciones externas

Use el subcomando unity-catalog external-locations para trabajar con ubicaciones externas. Consulte Introducción a las ubicaciones externas.

Para mostrar la documentación de uso, ejecute databricks unity-catalog external-locations --help.

• Crear una ubicación externa
• Validar una pareja ubicación externa - credencial
  • Validar una pareja credencial - nombre de ubicación externa después de crearlas
• Actualizar la configuración de una ubicación externa
• Listar las ubicaciones externas disponibles
• Obtener información sobre una ubicación externa
• Eliminar una ubicación externa

Creación de una ubicación externa

Para mostrar la documentación de uso, ejecute databricks unity-catalog external-locations create --help. Consulte también Introducción a las ubicaciones externas.

Validación de un par de ubicación externa y credencial

Para mostrar la documentación de uso, ejecute databricks unity-catalog external-locations validate --help.

Validación de un par de credencial y nombre de ubicación externo después de crearlo

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

Salida:

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

Actualizar la configuración de una ubicación externa

Para mostrar la documentación de uso, ejecute 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"
}

Enumeración de las ubicaciones externas disponibles

Para mostrar la documentación de uso, ejecute databricks unity-catalog external-locations list --help.

databricks unity-catalog external-locations list

Obtención de información sobre una ubicación externa

Para mostrar la documentación de uso, ejecute databricks unity-catalog external-locations get --help.

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

Eliminación de una ubicación externa

Para mostrar la documentación de uso, ejecute databricks unity-catalog external-locations delete --help.

Para forzar la eliminación de la ubicación externa, use la opción --force.

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

Si la operación se realiza correctamente, no se devuelve ningún resultado.

Catálogos

Use el subcomando unity-catalog catalogs para trabajar con catálogos.

Para mostrar la documentación de uso, ejecute databricks unity-catalog catalogs --help.

• Crear un catálogo.
• Actualizar la configuración de un catálogo
• Listar catálogos disponibles
• Obtener información sobre un catálogo
• Eliminar un catálogo

Crear un catálogo

Para mostrar la documentación de uso, ejecute databricks unity-catalog catalogs create --help. Consulte también Crear catálogos.

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

Salida:

{
  "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"
}

Actualizar la configuración de un catálogo

Para mostrar la documentación de uso, ejecute 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"
}

Salida:

{
  "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"
}

Enumeración de catálogos disponibles

Para mostrar la documentación de uso, ejecute databricks unity-catalog catalogs list --help.

databricks unity-catalog catalogs list

Salida:

{
  "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"
    },
    {
      "...": "..."
    }
  ]
}

Obtención de información sobre un catálogo

Para mostrar la documentación de uso, ejecute databricks unity-catalog catalogs get --help.

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

Salida:

{
  "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"
}

Eliminación de un catálogo

Para mostrar la documentación de uso, ejecute databricks unity-catalog catalogs delete --help. Consulte también Eliminación de un catálogo.

Para forzar la eliminación de un catálogo, use la opción --purge.

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

Si la operación se realiza correctamente, no se devuelve ningún resultado.

Esquemas

Use el subcomando unity-catalog schemas para trabajar con esquemas.

Para mostrar la documentación de uso, ejecute databricks unity-catalog schemas --help.

• Crear un esquema.
• Cambiar la configuración de un esquema
• Listar los esquemas disponibles
• Obtener información sobre un esquema
• Eliminar un esquema

Creación de un esquema

Para mostrar la documentación de uso, ejecute databricks unity-catalog schemas create --help. Consulte también Crear esquemas.

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

Salida:

{
  "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"
}

Cambiar la configuración de un esquema

Para mostrar la documentación de uso, ejecute 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"
}

Salida:

{
  "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"
}

Enumeración de los esquemas disponibles

Para mostrar la documentación de uso, ejecute databricks unity-catalog schemas list --help.

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

Salida:

{
  "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"
    },
    {
      "...": "..."
    }
  ]
}

Obtención de información sobre un esquema

Para mostrar la documentación de uso, ejecute databricks unity-catalog schemas get --help.

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

Salida:

{
  "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"
}

Eliminación de un esquema

Para mostrar la documentación de uso, ejecute databricks unity-catalog schemas delete --help. Consulte también Eliminación de un esquema.

Para forzar la eliminación de un esquema, use la opción --purge.

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

Si la operación se realiza correctamente, no se devuelve ningún resultado.

Tablas

Use el subcomando unity-catalog tables para trabajar con tablas.

Nota

No se admite la creación de tablas con la CLI de Unity Catalog. Para crear tablas, consulte Tablas de Azure Databricks y Tutorial: Creación de la primera tabla y concesión de privilegios.

Para mostrar la documentación de uso, ejecute databricks unity-catalog tables --help.

• Listar tablas disponibles
• Listar resúmenes de las tablas disponibles
• Obtener información sobre una tabla
• Eliminar una tabla

Enumeración de las tablas disponibles

Para mostrar la documentación de uso, ejecute databricks unity-catalog tables list --help.

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

Enumeración de resúmenes de las tablas disponibles

Para mostrar la documentación de uso, ejecute databricks unity-catalog tables list-summaries --help.

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

Salida:

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

Obtención de información sobre una tabla

Para mostrar la documentación de uso, ejecute databricks unity-catalog tables get --help.

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

Eliminar una tabla

Para mostrar la documentación de uso, ejecute databricks unity-catalog tables delete --help.

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

Si la operación se realiza correctamente, no se devuelve ningún resultado.

Linajes

Use el subcomando unity-catalog lineage para trabajar con linajes de tabla y columna.

Para mostrar la documentación de uso, ejecute databricks unity-catalog lineage --help.

• Enumerar el linaje de una tabla
• Enumerar el linaje de una columna

Mostrar el linaje de una tabla

Para mostrar la documentación de uso, ejecute databricks unity-catalog lineage table --help.

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

Enumerar el linaje de una columna

Para mostrar la documentación de uso, ejecute databricks unity-catalog lineage column --help.

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

Permisos

Use el subcomando unity-catalog permissions para trabajar con permisos de objetos protegibles. Consulte también Administrar privilegios en Unity Catalog.

Para mostrar la documentación de uso, ejecute databricks unity-catalog permissions --help.

• Obtener información sobre los permisos de un objeto protegible
  • Catálogo
  • Esquema
  • Tabla
  • Credencial de almacenamiento
  • Ubicación externa
• Actualizar los permisos de un objeto protegible
  • Catálogo
  • Esquema
  • Tabla
  • Credencial de almacenamiento
  • Ubicación externa

Obtención de información sobre los permisos de un objeto protegible

Para mostrar la documentación de uso, ejecute databricks unity-catalog permissions get --help. Consulte también Privilegios de Unity Catalog y objetos protegibles.

Catálogo

databricks unity-catalog permissions get --catalog main

Salida:

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

Esquema

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

Salida:

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

Tabla

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

Salida:

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

Credencial de almacenamiento

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

Salida:

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

Ubicación externa

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

Salida:

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

Actualizar los permisos de un objeto protegible

Para mostrar la documentación de uso, ejecute databricks unity-catalog permissions update --help. Consulte también Privilegios de Unity Catalog y objetos protegibles.

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"]
    }
  ]
}

Tabla

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 almacenamiento

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"]
    }
  ]
}

Ubicación externa

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"]
    }
  ]
}

Recursos compartidos

Use el subcomando unity-catalog shares para trabajar con recursos compartidos, que son objetos que contienen colecciones de tablas en un metastore de Unity Catalog habilitado para Delta Sharing que desea compartir como grupo con destinatarios de esa solución. Un recurso compartido puede contener tablas de un solo metastore. Consulte Creación y administración de recursos compartidos de Delta Sharing.

Para mostrar la documentación de uso, ejecute databricks unity-catalog shares --help.

• Crear un recurso compartido
• Actualizar la configuración de un recurso compartido
  • Añadir una tabla a un recurso compartido
  • Eliminar una tabla de un recurso compartido
• Actualizar los permisos de un recurso compartido
• Listar los recursos compartidos disponibles
• Obtener información sobre un recurso compartido
• Enumerar los permisos de un recurso compartido
• Eliminar un recurso compartido

Creación de un recurso compartido

Para mostrar la documentación de uso, ejecute databricks unity-catalog shares create --help. Consulte también Crear y administrar recursos compartidos para Delta Sharing.

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

Salida:

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

Actualizar la configuración de un recurso compartido

Para mostrar la documentación de uso, ejecute databricks unity-catalog shares update --help. Consulte también Actualizar recursos compartidos.

Añadir una tabla a un recurso compartido

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

Salida:

{
  "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"
}

Consulte también Agregar tablas a un recurso compartido.

Eliminación de una tabla de un recurso compartido

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

Salida:

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

Consulte también Agregar tablas a un recurso compartido.

Actualizar los permisos de un recurso compartido

Para mostrar la documentación de uso, ejecute databricks unity-catalog shares update-permissions --help. También consulte Administrar el acceso a los recursos compartidos de datos de Delta Sharing (para proveedores).

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"]
    }
  ]
}

Enumeración de los recursos compartidos disponibles

Para mostrar la documentación de uso, ejecute databricks unity-catalog shares list --help. Consulte también Visualizar recursos compartidos y compartir detalles.

databricks unity-catalog shares list

Salida:

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

Obtención de información sobre un recurso compartido

Para mostrar la documentación de uso, ejecute databricks unity-catalog shares get --help. Consulte también Visualizar recursos compartidos y compartir detalles.

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

Salida:

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

Enumerar los permisos de un recurso compartido

Para mostrar la documentación de uso, ejecute databricks unity-catalog shares list-permissions --help. Consulte también Visualizar los destinatarios que tienen permisos en un recurso compartido.

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

Salida:

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

Eliminación de un recurso compartido

Para mostrar la documentación de uso, ejecute databricks unity-catalog shares delete --help. Consulte también Eliminación de recursos compartidos.

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

Si la operación se realiza correctamente, no se devuelve ningún resultado.

Recipientes

Use el subcomando unity-catalog recipients para trabajar con destinatarios de datos para metastores de Unity Catalog habilitados para Delta Sharing. Los destinatarios de datos son personas o grupos con los que un usuario de Azure Databricks comparte datos fuera de la organización del usuario de Azure Databricks. Consulte Creación y administración de destinatarios de datos para el uso compartido delta (Uso compartido de Databricks a Databricks).

Para mostrar la documentación de uso, ejecute databricks unity-catalog recipients --help.

• Crear un destinatario
• Cambiar la configuración de un destinatario
• Rotación del token de un destinatario
• Listar los destinatarios disponibles
• Listar los permisos de compartición de un destinatario
• Obtener información sobre un destinatario
• Eliminar un destinatario

Creación de un destinatario

Para mostrar la documentación de uso, ejecute databricks unity-catalog recipients create --help. Consulte también Creación y administración de destinatarios de datos para el uso compartido de Delta (Uso compartido de Databricks a Databricks).

Para generar una nueva dirección URL de activación para un destinatario, ejecute databricks unity-catalog recipients rotate-token. Para obtener un ejemplo, consulte Rotación del token de un destinatario.

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

Salida:

{
  "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"
}

Cambiar la configuración de un destinatario

Para mostrar la documentación de uso, ejecute 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"
}

Salida:

{
  "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"
}

Rotación del token de un destinatario

Para mostrar la documentación de uso, ejecute databricks unity-catalog recipients rotate-token --help. Consulte también Administración de tokens de destinatarios.

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

Salida:

{
  "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"
}

Enumeración de destinatarios disponibles

Para mostrar la documentación de uso, ejecute databricks unity-catalog recipients list --help. Consulte también Ver destinatarios.

databricks unity-catalog recipients list

Salida:

{
  "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 los permisos de recurso compartido de un destinatario

Para mostrar la documentación de uso, ejecute databricks unity-catalog recipients list-permissions --help. Consulte también Permisos para compartir de un destinatario.

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

Salida:

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

Obtención de información sobre un destinatario

Para mostrar la documentación de uso, ejecute databricks unity-catalog recipients get --help. Consulte también Ver los detalles del destinatario.

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

Salida:

{
  "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"
}

Eliminación de un destinatario

Para mostrar la documentación de uso, ejecute databricks unity-catalog recipients delete --help. Consulte también Eliminación de un destinatario.

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

Si la operación se realiza correctamente, no se devuelve ningún resultado.

Proveedores

Si es un destinatario de datos compartidos de Delta Sharing, use el subcomando unity-catalog providers para trabajar con proveedores de datos de Delta Sharing. Consulte Administrar proveedores de Delta Sharing (para destinatarios de datos).

Para mostrar la documentación de uso, ejecute databricks unity-catalog providers --help.

• Crear un proveedor
• Actualización de la configuración de un proveedor
• Listar los proveedores disponibles
• Obtener información sobre un proveedor
• Listar las acciones disponibles de un proveedor
• Eliminar un proveedor

Creación de un proveedor

Si es un destinatario de datos compartidos mediante el protocolo de uso compartido abierto y usa un área de trabajo de Databricks que está adjunta a un metastore de Unity Catalog, puede crear un objeto de proveedor en el metastore de Unity Catalog. Después, puede administrar el acceso a los datos compartidos mediante Unity Catalog.

Importante

Este escenario es poco frecuente. Si usa un área de trabajo de Databricks habilitada para Unity Catalog y otro cliente de Databricks comparte datos con usted, deben usar uso compartido de Databricks a Databricks. Con el uso compartido de Databricks a Databricks, los objetos de proveedor se crean automáticamente en Unity Catalog.

Para crear un proveedor, debe:

• Ser administrador o usuario de metastore con el privilegio CREATE PROVIDER para el metastore.
• Tener acceso al archivo de credenciales descargado. Consulte Obtener acceso en el modelo de uso compartido abierto.

Ejecute el siguiente comando reemplazando my-provider por el nombre que quiere dar al proveedor y config.share por la ruta de acceso al archivo de credenciales descargado, que de manera predeterminada se llama config.share.

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

Actualización de la configuración de un proveedor

Para mostrar la documentación de uso, ejecute databricks unity-catalog providers update --help.

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

Enumeración de los proveedores disponibles

Para mostrar la documentación de uso, ejecute databricks unity-catalog providers list --help.

databricks unity-catalog providers list

Obtención de información sobre un proveedor

Para mostrar la documentación de uso, ejecute databricks unity-catalog providers get --help.

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

Listar los recursos compartidos disponibles de un proveedor

Para mostrar la documentación de uso, ejecute databricks unity-catalog providers list-shares --help.

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

Eliminar un proveedor

Para mostrar la documentación de uso, ejecute databricks unity-catalog providers delete --help.

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

Si la operación se realiza correctamente, no se devuelve ningún resultado.