Referência de tabelas do sistema de linhagem

Visualização

Este recurso está em visualização pública.

Este artigo fornece uma visão geral das duas tabelas do sistema de linhagem. Essas tabelas de sistema se baseiam no recurso de linhagem de dados do Unity Catalog, permitindo que você query dados de linhagem de forma programática para alimentar a tomada de decisões e os relatórios.

Existem duas tabelas de sistema de linhagem:

  • system.access.table_lineage

  • system.access.column_lineage

Observação

Ambas as tabelas de linhagem representam um subconjunto de todos os eventos de leitura/gravação, pois nem sempre é possível capturar a linhagem. Os registros são emitidos apenas quando a linhagem pode ser inferida.

Tabela tabela de linhagem

A tabela do sistema de linhagem de tabela inclui um registro para cada evento de leitura ou gravação em uma tabela ou caminho Unity Catalog . Isso inclui, mas não está limitado a execução Job , execução Notebook e painéis atualizados com o evento de leitura ou gravação.

Tabela de linhagem de colunas

A tabela de linhagem da coluna não inclui eventos que não possuem uma origem. Por exemplo, se você inserir em uma coluna usando valores explícitos, ela não será capturada. Se você ler uma coluna, ela será capturada independentemente de você gravar ou não a saída. A linhagem de coluna não é compatível com Delta Live Tables.

Esquema da tabela do sistema de linhagem

As tabelas do sistema de linhagem usam o esquema a seguir. O esquema de linhagem da tabela não inclui source_column_name e target_column_name.

Nome da coluna

Tipo de dados

Descrição

Exemplo

account_id

String

A ID da account do Databricks.

7af234db-66d7-4db3-bbf0-956098224879

metastore_id

String

O ID do metastore do Unity Catalog .

5a31ba44-bbf4-4174-bf33-e1fa078e6765

workspace_id

String

O ID do workspace

123456789012345

entity_type

String

O tipo de entidade da qual a transação de linhagem foi capturada. O valor é NOTEBOOK, JOB, PIPELINE, DBSQL_DASHBOARD, DBSQL_QUERY, OU NULL.

NOTEBOOK

entity_id

String

O ID da entidade da qual a transação de linhagem foi capturada. Se entity_type for NULL, entity_id será NULL.

  • Notebook: 23098402394234

  • Job: 23098402394234

  • query Databricks SQL: e9cd8a31-de2f-4206-adfa-4f6605d68d88

  • Painel do Databricks SQL: e9cd8a31-de2f-4206-adfa-4f6605d68d88

  • pipeline: e9cd8a31-de2f-4206-adfa-4f6605d68d88

entity_run_id

String

ID para descrever a execução exclusiva da entidade ou NULL. Isso difere para cada tipo de entidade:

  • Notebook: comando

  • Job: Job

  • Consulta Databricks SQL : query_run_id

  • Painel do Databricks SQL: query_run_id

  • Pipeline: pipeline_update_id

Se entity_type for NULL, entity_run_id será NULL.

  • Notebook: 23098402394234

  • Job: 23098402394234

  • query Databricks SQL: e9cd8a31-de2f-4206-adfa-4f6605d68d88

  • Painel do Databricks SQL: e9cd8a31-de2f-4206-adfa-4f6605d68d88

  • pipeline: e9cd8a31-de2f-4206-adfa-4f6605d68d88

source_table_full_name

String

Nome de três partes para identificar a tabela de origem.

catalog.schema.table

source_table_catalog

String

O catálogo da tabela de origem.

catalog

source_table_schema

String

O esquema da tabela de origem.

catalog.schema

source_table_name

String

O nome da tabela de origem.

table

source_path

String

Localização no armazenamento em cloud da tabela de origem ou o caminho, se estiver lendo diretamente do armazenamento cloud .

gs://mybucket/table1

source_type

String

O tipo da fonte. O valor é TABLE, PATH, VIEW ou STREAMING_TABLE.

TABLE

source_column_name

String

O nome da coluna de origem.

date

target_table_full_name

String

Nome de três partes para identificar a tabela de destino.

catalog.schema.table

target_table_catalog

String

O catálogo da tabela de destino.

catalog

target_table_schema

String

O esquema da tabela de destino.

catalog.schema

target_table_name

String

O nome da tabela de destino.

table

target_path

String

Localização no armazenamento em clouds da tabela de destino.

gs://mybucket/table1

target_type

String

O tipo do alvo. O valor é TABLE, PATH, VIEW ou STREAMING TABLE.

TABLE

target_column_name

String

O nome da coluna de destino.

date

created_by

String

O usuário que gerou esta linhagem. Pode ser um nome de usuário Databricks, uma ID de entidade de serviço Databricks, “System-User” ou NULL se a informação do usuário não puder ser capturada.

crampton.rods@email.com

event_time

Timestamp

O timestamp quando a linhagem foi gerada.

2023-06-20T19:47:21.194+0000

event_date

data

A data em que a linhagem foi gerada. Esta é uma coluna particionada.

2023-06-20

Lendo tabelas do sistema de linhagem

Observe as seguintes considerações ao analisar as tabelas do sistema de linhagem:

  • Para o entity_type, o Databricks dá suporte a Delta Live Tables, Notebook, Job, Databricks SQL query e painéis. Eventos de outras entidades não são suportados.

  • Se você vir o entity_type como null, significa que nenhuma entidade Databricks está envolvida no evento. Por exemplo, pode ser o resultado de uma query JDBC ou de um clique do usuário na guia Dados de exemplo na interface do usuário do Databricks.

  • Para determinar se o evento foi uma leitura ou uma gravação, você pode view o tipo de origem e o tipo de destino.

    • Somente leitura: o tipo de origem não é nulo, mas o tipo de destino é nulo.

    • Somente gravação: o tipo de destino não é nulo, mas o tipo de origem é nulo.

    • Leitura e gravação: o tipo de origem e o tipo de destino não são nulos.

Exemplo de tabela do sistema de linhagem

Como exemplo de como a linhagem é registrada nas tabelas do sistema, aqui está um exemplo query seguida pelos registros de linhagem que a query cria:

CREATE OR REPLACE TABLE car_features
AS SELECT *,  in1+in2 as premium_feature_set
FROM car_features_exterior
JOIN car_features_interior
USING(id, model);

O registro em system.access.table_lineage ficaria assim:

entity_type

entity_id

source_table_name

target_table_name

created_by

event_time

NOTEBOOK

27080565267

car_features_exterior

car_features

crampton@email.com

2023-01-25T16:19:58.908+0000

NOTEBOOK

27080565267

car_features_interior

car_features

crampton@email.com

2023-01-25T16:19:58.908+0000

O registro em system.access.column_lineage ficaria assim:

entity_type

entity_id

source_table_name

target_table_name

source_column_name

target_column_name

event_time

NOTEBOOK

27080565267

car_features_interior

car_features

in1

premium_feature_set

2023-01-25T16:19:58.908+0000

NOTEBOOK

27080565267

car_features_interior

car_features

in2

premium_feature_set

2023-01-25T16:19:58.908+0000

Observação

Nem todas as colunas de linhagem são mostradas no exemplo acima. Para o esquema completo, consulte o esquema de linhagem acima.

Solução de queryde consulta de tabela externa

Quando você faz referência a uma tabela externa usando seu caminho de armazenamento clouds , o registro de linhagem associado inclui apenas o nome do caminho e não o nome da tabela. Por exemplo, o registro de linhagem para esta query incluiria o nome do caminho e não o nome da tabela:

SELECT * FROM delta.`gcp://mybucket/table1`;

Se estiver tentando query registros de linhagem para uma tabela externa referenciada por caminho, você precisará filtrar a query usando source_path ou target_path em vez de source_table_full_name ou target_table_full_name. Por exemplo, a query a seguir extrai todos os registros de linhagem de uma tabela externa:

SELECT *
FROM system.access.table_lineage
WHERE
  source_path = "gs://mybucket/table1" OR
  target_path = "gs://mybucket/table1";

Exemplo: recuperar registros de linhagem com base no nome da tabela externa

Se não quiser recuperar manualmente o caminho de armazenamento clouds para encontrar a linhagem, você pode usar a seguinte função para obter a linhagem uso de dados do nome da tabela. Você também pode substituir system.access.table_lineage por system.access.column_lineage na função se quiser query a linhagem da coluna.

def getLineageForTable(table_name):
  table_path = spark.sql(f"describe detail {table_name}").select("location").head()[0]

  df = spark.read.table("system.access.table_lineage")
  return df.where(
    (df.source_table_full_name == table_name)
    | (df.target_table_full_name == table_name)
    | (df.source_path == table_path)
    | (df.target_path == table_path)
  )

Em seguida, use o seguinte comando para chamar a função e exibir os registros de linhagem da tabela externa:

display(getLineageForTable("table_name"))