Grupo de comandos external-metadata

Nota:

Esta información se aplica a las versiones 0.205 y posteriores de la CLI de Databricks. La CLI de Databricks está en versión preliminar pública.

El uso de la CLI de Databricks está sujeto a la licencia de Databricks y al aviso de privacidad de Databricks, incluidas las disposiciones de datos de uso.

El external-metadata grupo de comandos de la CLI de Databricks contiene comandos para registrar y administrar metadatos sobre sistemas externos en el catálogo de Unity.

databricks external-metadata create-external-metadata

Cree un nuevo objeto de metadatos externos en el metastore primario si el autor de la llamada es un administrador de metastore o tiene el privilegio CREATE_EXTERNAL_METADATA . Concede BROWSE a todos los usuarios de la cuenta tras la creación de forma predeterminada.

databricks external-metadata create-external-metadata NAME SYSTEM_TYPE ENTITY_TYPE [flags]

Argumentos

NAME

    Nombre del objeto de metadatos externos.

SYSTEM_TYPE

    Tipo de sistema externo. Valores admitidos: AMAZON_REDSHIFT, AZURE_SYNAPSE, DATABRICKSCONFLUENTMYSQLMONGODBKAFKAGOOGLE_BIGQUERYLOOKERORACLEMICROSOFT_SQL_SERVERMICROSOFT_FABRIC, . OTHERPOSTGRESQLPOWER_BISALESFORCESAPSERVICENOWSNOWFLAKESTREAM_NATIVETABLEAUTERADATAWORKDAY

ENTITY_TYPE

    Tipo de entidad dentro del sistema externo.

Options

--description string

    Descripción de texto en formato libre proporcionada por el usuario.

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud

--owner string

    Propietario del objeto de metadatos externos.

--url string

    Dirección URL asociada al objeto de metadatos externos.

Marcas globales

Examples

En el ejemplo siguiente se crea un objeto de metadatos externo para una tabla snowflake:

databricks external-metadata create-external-metadata my_snowflake_table SNOWFLAKE TABLE --description "Production sales table" --url "https://example.snowflakecomputing.com/table/sales"

En el ejemplo siguiente se crea un objeto de metadatos externo mediante JSON:

databricks external-metadata create-external-metadata tableau_dashboard TABLEAU DASHBOARD --json '{"description": "Sales dashboard", "owner": "user@example.com"}'

En el ejemplo siguiente se crea un objeto de metadatos externo mediante un archivo JSON:

databricks external-metadata create-external-metadata bigquery_dataset GOOGLE_BIGQUERY DATASET --json @external-metadata.json

databricks external-metadata delete-external-metadata

Elimine el objeto de metadatos externos que coincida con el nombre proporcionado. El autor de la llamada debe ser un administrador de metastore, el propietario del objeto de metadatos externos o un usuario que tenga el privilegio MANAGE .

databricks external-metadata delete-external-metadata NAME [flags]

Argumentos

NAME

    Nombre del objeto de metadatos externos que se va a eliminar.

Options

Marcas globales

Examples

En el ejemplo siguiente se elimina un objeto de metadatos externo:

databricks external-metadata delete-external-metadata my_snowflake_table

databricks external-metadata get-external-metadata

Obtiene el objeto de metadatos externos especificado en un metastore. El autor de la llamada debe ser un administrador de metastore, el propietario del objeto de metadatos externos o un usuario que tenga el privilegio BROWSE .

databricks external-metadata get-external-metadata NAME [flags]

Argumentos

NAME

    Nombre del objeto de metadatos externos que se va a obtener.

Options

Marcas globales

Examples

En el ejemplo siguiente se obtiene un objeto de metadatos externo:

databricks external-metadata get-external-metadata my_snowflake_table

databricks external-metadata list-external-metadata

Enumerar objetos de metadatos externos en el metastore. Si el autor de la llamada es el administrador de metastore, se recuperarán todos los objetos de metadatos externos. De lo contrario, solo se recuperarán los objetos de metadatos externos en los que el autor de la llamada tiene BROWSE . No hay ninguna garantía de una ordenación específica de los elementos de la matriz.

databricks external-metadata list-external-metadata [flags]

Options

--page-size int

    Número máximo de objetos de metadatos externos que se van a devolver por página.

--page-token string

    Token para recuperar la página siguiente de resultados.

Marcas globales

Examples

En el ejemplo siguiente se enumeran todos los objetos de metadatos externos:

databricks external-metadata list-external-metadata

En el ejemplo siguiente se enumeran los objetos de metadatos externos con paginación:

databricks external-metadata list-external-metadata --page-size 10

databricks external-metadata update-external-metadata

Actualice el objeto de metadatos externos que coincida con el nombre proporcionado. El autor de la llamada solo puede actualizar el propietario u otros campos de metadatos en una solicitud. El autor de la llamada debe ser un administrador de metastore, el propietario del objeto de metadatos externos o un usuario que tenga el privilegio MODIFY . Si el autor de la llamada actualiza el propietario, también debe tener el privilegio MANAGE .

databricks external-metadata update-external-metadata NAME UPDATE_MASK SYSTEM_TYPE ENTITY_TYPE [flags]

Argumentos

NAME

    Nombre del objeto de metadatos externos.

UPDATE_MASK

    La máscara de campo debe ser una sola cadena, con varios campos separados por comas (sin espacios). La ruta de acceso del campo es relativa al objeto de recurso, mediante un punto (.) para navegar por los subcampos (por ejemplo, author.given_name). No se permite la especificación de elementos en campos de secuencia o mapa, ya que solo se puede especificar todo el campo de colección. Los nombres de campo deben coincidir exactamente con los nombres de campo de recursos.

    Una máscara de campo asterisco (*) indica un reemplazo completo. Se recomienda enumerar siempre explícitamente los campos que se actualizan y evitar el uso de caracteres comodín, ya que puede provocar resultados no deseados si la API cambia en el futuro.

SYSTEM_TYPE

    Tipo de sistema externo. Valores admitidos: AMAZON_REDSHIFT, AZURE_SYNAPSE, DATABRICKSCONFLUENTMYSQLMONGODBKAFKAGOOGLE_BIGQUERYLOOKERORACLEMICROSOFT_SQL_SERVERMICROSOFT_FABRIC, . OTHERPOSTGRESQLPOWER_BISALESFORCESAPSERVICENOWSNOWFLAKESTREAM_NATIVETABLEAUTERADATAWORKDAY

ENTITY_TYPE

    Tipo de entidad dentro del sistema externo.

Options

--description string

    Descripción de texto en formato libre proporcionada por el usuario.

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud

--owner string

    Propietario del objeto de metadatos externos.

--url string

    Dirección URL asociada al objeto de metadatos externos.

Marcas globales

Examples

En el ejemplo siguiente se actualiza la descripción de un objeto de metadatos externo:

databricks external-metadata update-external-metadata my_snowflake_table "description" SNOWFLAKE TABLE --description "Updated production sales table"

En el ejemplo siguiente se actualiza el propietario de un objeto de metadatos externo:

databricks external-metadata update-external-metadata my_snowflake_table "owner" SNOWFLAKE TABLE --owner "newowner@example.com"

En el ejemplo siguiente se actualiza un objeto de metadatos externo mediante JSON:

databricks external-metadata update-external-metadata my_snowflake_table "description,url" SNOWFLAKE TABLE --json '{"description": "Latest sales data", "url": "https://example.snowflakecomputing.com/table/sales_v2"}'

Marcas globales

--debug

  Indica si se va a habilitar el registro de depuración.

-h o --help

    Mostrar ayuda para la CLI de Databricks o el grupo de comandos relacionado o el comando relacionado.

--log-file cadena

    Cadena que representa el archivo en el que se van a escribir registros de salida. Si no se especifica esta marca, el valor predeterminado es escribir registros de salida en stderr.

--log-format formato

    Tipo de formato de registro: text o json. El valor predeterminado es text.

--log-level cadena

    Cadena que representa el nivel de formato de registro. Si no se especifica, el nivel de formato de registro está deshabilitado.

-o, --output tipo

    Tipo de salida del comando, text o json. El valor predeterminado es text.

-p, --profile cadena

    Nombre del perfil en el archivo ~/.databrickscfg que se usará para ejecutar el comando. Si no se especifica esta marca, si existe, se usa el perfil denominado DEFAULT .

--progress-format formato

    Formato para mostrar los registros de progreso: default, append, inplaceo json

-t, --target cadena

    Si procede, el destino del paquete que se va a usar