Share via

Filtrar dados confidenciais da tabela usando filtros de linha e máscaras de coluna

  • Artigo

Importante

Esse recurso está em uma versão prévia.

Este artigo fornece diretrizes e exemplos para usar filtros de linha, máscaras de coluna e tabelas de mapeamento para filtrar dados confidenciais em suas tabelas.

O que são filtros de linha?

Os filtros de linha permitem aplicar um filtro a uma tabela para que as consultas seguintes retornem apenas linhas para as quais o predicado de filtro é avaliado como true. Um filtro de linha é implementado como uma UDF (função definida pelo usuário) do SQL.

Para criar um filtro de linha, primeiro escreva um UDF do SQL para definir a política de filtro e, em seguida, aplique-a a uma tabela com uma instrução ALTER TABLE. Como alternativa, você pode especificar um filtro de linha para uma tabela na instrução inicial CREATE TABLE. Cada tabela pode ter apenas um filtro de linha. Um filtro de linha aceita zero ou mais parâmetros de entrada em que cada parâmetro de entrada se associa a uma coluna da tabela correspondente.

Qual é a diferença entre esses filtros e exibições dinâmicas?

A exibição dinâmica é uma exibição abstrata e somente leitura de uma ou mais tabelas de origem. O usuário pode acessar a exibição dinâmica sem ter acesso diretamente às tabelas de origem. A criação de uma exibição dinâmica define um novo nome de tabela que não deve corresponder ao nome de nenhuma tabela de origem ou de outras tabelas e exibições presentes no mesmo esquema.

Por outro lado, associar um filtro de linha ou máscara de coluna a uma tabela de destino aplica a lógica correspondente diretamente à própria tabela sem introduzir novos nomes de tabela. As consultas subsequentes podem continuar se referindo diretamente à tabela de destino usando seu nome original.

Tanto exibições dinâmicas quanto filtros de linha e máscaras de coluna permitem aplicar lógica complexa às tabelas e processar suas decisões de filtragem no runtime de consulta.

Use exibições dinâmicas se precisar aplicar a lógica de transformação, como filtros e máscaras, a tabelas somente leitura e se for aceitável que os usuários se refiram aos modos de exibição dinâmicos usando nomes diferentes. Use filtros de linha e máscaras de coluna se quiser filtrar ou calcular expressões em dados específicos, mas ainda fornecer aos usuários acesso às tabelas usando seus nomes originais.

Sintaxe de filtro de linha

Para criar um filtro de linha e adicioná-lo a uma tabela existente, use a seguinte sintaxe:

Crie o filtro de linha:

CREATE FUNCTION <function_name> (<parameter_name> <parameter_type>, ...)
RETURN {filter clause whose output must be a boolean};

Aplique o filtro de linha a uma tabela:

ALTER TABLE <table_name> SET ROW FILTER <function_name> ON (<column_name>, ...);

Remova um filtro de linha de uma tabela:

ALTER TABLE <table_name> DROP ROW FILTER;

Modifique um filtro de linha:

Run a DROP FUNCTION statement to drop the existing function, or use CREATE OR REPLACE FUNCTION to replace it.

Exclua um filtro de linha:

ALTER TABLE <table_name> DROP ROW FILTER;
DROP FUNCTION <function_name>;

Observação

Você deve executar o comando ALTER TABLE ... DROP ROW FILTER antes de remover a função ou a tabela estará em um estado inacessível.

Se a tabela se tornar inacessível dessa forma, altere a tabela e solte a referência de filtro de linha órfã usando ALTER TABLE <table_name> DROP ROW FILTER;.

Exemplos de filtros de linha

Crie uma função definida pelo usuário do SQL aplicada aos membros do grupo admin na região US.

Com essa função, os membros do grupo admin podem acessar todos os registros na tabela. Se a função for chamada por um não administrador, a condição RETURN_IF falhará e a expressão region='US' será avaliada, filtrando a tabela para mostrar apenas registros na região US.

CREATE FUNCTION us_filter(region STRING)
RETURN IF(IS_ACCOUNT_GROUP_MEMBER('admin'), true, region='US');

Aplique a função a uma tabela como um filtro de linha. As consultas subsequentes da tabela sales retornam um subconjunto de linhas.

CREATE TABLE sales (region STRING, id INT);
ALTER TABLE sales SET ROW FILTER us_filter ON (region);

Desabilite o filtro de linha. As consultas futuras do usuário da tabela sales retornam todas as linhas da tabela.

ALTER TABLE sales DROP ROW FILTER;

Crie uma tabela com a função aplicada como um filtro de linha como parte da instrução CREATE TABLE. Consultas futuras da tabela sales, em seguida, cada uma retorna um subconjunto de linhas.

CREATE TABLE sales (region STRING, id INT)
WITH ROW FILTER us_filter ON (region);

O que são máscaras de coluna?

As máscaras de coluna permitem aplicar uma função de mascaramento a uma coluna de tabela. A função de mascaramento é avaliada no runtime de consulta, substituindo cada referência da coluna de destino pelos resultados da função de mascaramento. Para a maioria dos casos de uso, as máscaras de coluna determinam se o valor da coluna original deve ser retornado ou redigido com base na identidade do usuário invocado. Máscaras de coluna são expressões escritas como UDFs do SQL.

Cada coluna de tabela pode, opcionalmente, ter uma função de mascaramento aplicada a ela. A função de mascaramento usa o valor desmascarado da coluna como entrada e retorna o valor mascarado como resultado. O valor retornado da função de mascaramento deve ser do mesmo tipo que a coluna que está sendo mascarada. A função de mascaramento também pode usar colunas adicionais como parâmetros de entrada e usá-las em sua lógica de mascaramento.

Para aplicar máscaras de coluna, crie uma função e aplique-a a uma coluna de tabela usando uma instrução ALTER TABLE. Como alternativa, você pode aplicar a função de mascaramento ao criar a tabela.

Sintaxe da máscara de coluna

Dentro da cláusula MASK, você pode usar qualquer uma das funções de runtime internas do Azure Databricks ou chamar outras funções definidas pelo usuário. Casos de uso comuns incluem inspecionar a identidade do usuário invocando a função usando current_user( ) ou quais grupos eles são membros do uso is_account_group_member( ).

Crie uma máscara de coluna:

CREATE FUNCTION <function_name> (<parameter_name> <parameter_type>, ...)
RETURN {expression with the same type as the first parameter};

Aplique a máscara de coluna a uma coluna em uma tabela existente:

ALTER TABLE <table_name> ALTER COLUMN <col_name> SET MASK <mask_func_name> [USING COLUMNS <additional_columns>];

Remova uma máscara de coluna de uma coluna em uma tabela:

ALTER TABLE <table_name> ALTER COLUMN <column where mask is applied> DROP MASK;

Modifique uma máscara de coluna:

A função existente DROP ou use CREATE OR REPLACE TABLE.

Exclua uma máscara de coluna:

ALTER TABLE <table_name> ALTER COLUMN <column where mask is applied> DROP MASK;
DROP FUNCTION <function_name>;

Observação

Você deve executar o comando ALTER TABLE antes de remover a função ou a tabela estará em um estado inacessível.

Se a tabela se tornar inacessível dessa forma, altere a tabela e solte a referência de máscara órfã usando ALTER TABLE <table_name> ALTER COLUMN <column where mask is applied> DROP MASK;.

Exemplos de máscara de coluna

Nesse exemplo, você cria uma função definida pelo usuário que mascara a coluna ssn para que somente os usuários que são membros do grupo HumanResourceDept possam exibir valores nessa coluna.

CREATE FUNCTION ssn_mask(ssn STRING)
  RETURN CASE WHEN is_member('HumanResourceDept') THEN ssn ELSE '***-**-****' END;

Aplique a nova função a uma tabela como uma máscara de coluna. Você pode adicionar a máscara de coluna ao criar a tabela ou depois.

--Create the `users` table and apply the column mask in a single step:

CREATE TABLE users (
  name STRING,
  ssn STRING MASK ssn_mask);

--Create the `users` table and apply the column mask after:

CREATE TABLE users
  (name STRING, ssn STRING);

ALTER TABLE users ALTER COLUMN ssn SET MASK ssn_mask;

As consultas nessa tabela agora retornam valores de coluna ssn mascarados quando o usuário que consulta não é membro do grupo HumanResourceDept:

SELECT * FROM users;
  James  ***-**-****

Para desabilitar a máscara de coluna para que as consultas retornem os valores originais na coluna ssn:

ALTER TABLE users ALTER COLUMN ssn DROP MASK;

Usar tabelas de mapeamento para criar uma lista de controle de acesso

Para obter segurança em nível de linha, considere definir uma tabela de mapeamento (ou lista de controle de acesso). Cada tabela de mapeamento é abrangente e codifica quais linhas de dados na tabela original são acessíveis a determinados usuários ou grupos. Tabelas de mapeamento são úteis porque oferecem integração simples com suas tabelas de fatos por meio de junções diretas.

Essa metodologia é benéfica para lidar com muitos casos de uso com requisitos personalizados. Os exemplos incluem:

  • Impondo restrições com base no usuário conectado ao acomodar regras diferentes para grupos de usuários específicos.
  • Criando hierarquias complexas, como estruturas organizacionais, exigindo conjuntos diversos de regras.
  • Replicando modelos de segurança complexos de sistemas de origem externos.

Ao adotar tabelas de mapeamento dessa forma, você pode lidar efetivamente com esses cenários desafiadores e garantir implementações robustas de segurança em nível de linha e de coluna.

Exemplos de tabela de mapeamento

Use uma tabela de mapeamento para verificar se o usuário atual está em uma lista:

USE CATALOG main;

Crie uma nova tabela de mapeamento:

DROP TABLE IF EXISTS valid_users;

CREATE TABLE valid_users(username string);
INSERT INTO valid_users
VALUES
  ('fred@databricks.com'),
  ('barney@databricks.com');

Crie um novo filtro:

Observação

Todos os filtros são executados com os direitos do definidor, exceto para funções que verificam o contexto do usuário (por exemplo, as funções CURRENT_USER e as funções IS_MEMBER) que são executadas como o invocador.

Neste exemplo, a função verifica se o usuário atual está na tabela valid_users. Se o usuário for encontrado, a função retornará true.

DROP FUNCTION IF EXISTS row_filter;

CREATE FUNCTION row_filter()
  RETURN EXISTS(
    SELECT 1 FROM valid_users v
    WHERE v.username = CURRENT_USER()
);

O exemplo a seguir aplica o filtro de linha durante a criação da tabela. Você também pode adicionar o filtro mais tarde usando uma instrução ALTER TABLE. Ao aplicar a uma tabela inteira, use a sintaxe ON (). Para um uso de linha específico use ON (row);.

DROP TABLE IF EXISTS data_table;

CREATE TABLE data_table
  (x INT, y INT, z INT)
  WITH ROW FILTER row_filter ON ();

INSERT INTO data_table VALUES
  (1, 2, 3),
  (4, 5, 6),
  (7, 8, 9);

Selecione dados da tabela. Isso só deverá retornar dados se o usuário estiver na tabela valid_users.

SELECT * FROM data_table;

Crie uma tabela de mapeamento composta por contas que sempre devem ter acesso para exibir todas as linhas na tabela, independentemente dos valores da coluna:

CREATE TABLE valid_accounts(account string);
INSERT INTO valid_accounts
VALUES
  ('admin'),
  ('cstaff');

Agora, crie uma UDF do SQL que retorna true se os valores de todas as colunas na linha forem menores que cinco ou se o usuário invocado for um membro da tabela de mapeamento acima.

CREATE FUNCTION row_filter_small_values (x INT, y INT, z INT)
  RETURN (x < 5 AND y < 5 AND z < 5)
  OR EXISTS(
    SELECT 1 FROM valid_accounts v
    WHERE IS_ACCOUNT_GROUP_MEMBER(v.account));

Por fim, aplique o UDF do SQL à tabela como um filtro de linha:

ALTER TABLE data_table SET ROW FILTER row_filter_small_values ON (x, y, z);

Capacidade de suporte

  • Há suporte para notebooks Databricks SQL e Databricks para cargas de trabalho SQL.
  • Os comandos em DML executados por usuários com privilégios MODIFY têm suporte. Filtros e máscaras são aplicados aos dados lidos por comandos UPDATE e DELETE (atualizar e excluir) e não são aplicados a dados que estão gravados (incluindo dados que foram inseridos pelo comando INSERT).
  • Formatos com suporte: Delta e Parquet. O Parquet tem suporte apenas para tabelas gerenciadas ou externas.
  • As exibições em tabelas com máscaras de coluna ou filtros de linha têm suporte.
  • Os feeds de dados de alteração do Delta Lake têm suporte desde que o esquema seja compatível com os filtros de linha e máscaras de coluna que podem se aplicar à tabela de destino.
  • Há suporte para tabelas estrangeiras.

Limitações

  • As versões do Databricks Runtime abaixo da 12.2 LTS não dão suporte a filtros de linha ou máscaras de coluna. Esses runtimes falham com segurança, ou seja, se você tentar acessar tabelas de versões sem suporte desses runtimes, nenhum dado será retornado.
  • As tabelas dinâmicas delta materializadas e as tabelas de streaming não dão suporte a filtros de linha ou máscaras de coluna.
  • Não há suporte para UDFs do Python e Scala como funções de filtro de linha ou máscara de coluna diretamente. No entanto, é possível fazer referência a elas em UDFs do SQL, desde que suas definições sejam armazenadas permanentemente no catálogo (em outras palavras, não temporárias para a sessão).
  • O Compartilhamento Delta não funciona com máscaras de coluna ou segurança em nível de linha.
  • A viagem no tempo não funciona com máscaras de coluna ou segurança em nível de linha.
  • A amostragem de tabela não funciona com máscaras de coluna ou segurança em nível de linha.
  • No momento, não há suporte para o acesso baseado em caminho a arquivos em tabelas com políticas.
  • Não há suporte para políticas de filtro de linha ou máscara de coluna com dependências circulares de volta às políticas originais.
  • Não há suporte para MERGE e clones superficiais.

Limitação de clusters de usuário único

Não adicione filtros de linha ou máscaras de coluna a qualquer tabela que você esteja acessando de clusters de usuário único. Isso geralmente é feito no contexto dos Trabalhos do Azure Databricks. Durante a visualização pública, você não poderá acessar a tabela de um único cluster de usuário depois que um filtro ou máscara for aplicado.