Criação de UDFs de Java¶

Mapeamentos de tipos de dados SQL-Java para tipos de parâmetros e retorno¶

Para obter mais informações sobre como o Snowflake converte entre os tipos de dados Java e SQL, consulte Mapeamentos de tipos de dados entre linguagens do manipulador e SQL.

Valores TIMESTAMP_LTZ e fusos horários¶

Uma UDF de Java fica bastante isolada do ambiente no qual é chamada. Entretanto, o fuso horário é herdado do ambiente de chamada. Se a sessão do chamador definir um fuso horário padrão antes de chamar a UDF de Java, a UDF de Java tem o mesmo fuso horário padrão. A UDF de Java utiliza os mesmos dados da base de dados de fuso horário IANA usados pelo TIMEZONE SQL do Snowflake nativo (isso é, dados do lançamento 2021a do banco de dados de fuso horário).

Valores NULL¶

O Snowflake oferece suporte para dois valores NULL distintos: SQL NULL e JSON de VARIANT null. (Para obter mais informações sobre o VARIANT NULL do Snowflake, consulte Valores NULL).

O Java oferece suporte para um valor null, que é apenas para tipos de dados não-primitivos.

Um argumento SQL NULL para uma UDF de Java é convertido para o valor de Java null, mas somente para tipos de dados de Java que oferecem suporte para null.

Um valor de Java null retornado é convertido de volta para um NULL de SQL.

Matrizes e número variável de argumentos¶

UDFs de Java podem receber arrays de qualquer um dos seguintes tipos de dados de Java:

• Cadeia de caracteres

• booleano

• double

• float

• int

• long

• short

O tipo de dados dos valores de SQL passados deve ser compatível com o tipo de dados de Java correspondente. Para obter mais detalhes sobre compatibilidade de tipos de dados, consulte Mapeamentos de tipos de dados SQL-Java.

As seguintes regras adicionais se aplicam para cada um dos tipos de dados de Java especificados:

• boolean: a ARRAY do Snowflake deve conter somente elementos BOOLEAN, e não deve conter nenhum valor NULL.

• int/short/long: a ARRAY do Snowflake deve conter somente elementos de ponto fixo com uma escala de 0, e não deve conter nenhum valor NULL.

• float/double: a ARRAY do Snowflake deve conter um dos seguintes:

  • Elementos FLOAT.

  • Elementos de ponto fixo (com qualquer escala).

  A ARRAY não deve conter nenhum valor NULL.

Os métodos de Java podem receber essas arrays de uma das duas maneiras a seguir:

• Usando o recurso de array do Java.

• Usando o recurso varargs (número variável de argumentos) do Java.

Em ambos os casos, seu código de SQL deve passar uma ARRAY.

Compartilhamento de estado por chamadas¶

O Snowflake espera que o UDFs escalares seja processadas de forma independente. Confiar no estado compartilhado entre invocações pode resultar em um comportamento inesperado. Isso acontece pois o sistema pode processar linhas em qualquer ordem e distribuir essas invocações por vários JVMs (para manipuladores escritos em Java ou Scala) ou instâncias (para manipuladores escritos em Python).

UDFs devem evitar confiar em um estado compartilhado entre diferentes chamadas para o método do manipulador. Entretanto, há duas situações em que você pode querer que uma UDF armazene um estado compartilhado:

• Código que contém uma lógica de inicialização cara que você não quer repetir para cada linha.

• Código que use um estado compartilhado em linhas diferentes, como um cache.

Se você precisar compartilhar o estado em várias linhas, e se esse estado não mudar com o tempo, use um construtor para criar um estado compartilhado definindo variáveis em nível de instância. O construtor é executado apenas uma vez por instância, enquanto o manipulador é chamado uma vez por linha. Portanto, inicializar no construtor é mais barato quando um manipulador processa várias linhas. E como o construtor é chamado apenas uma vez, o construtor não precisa ser escrito de forma a ser thread-safe.

Se sua UDF armazena um estado compartilhado que muda, seu código deve estar preparado para lidar com o acesso simultâneo a esse estado. As duas próximas seções fornecem mais informações sobre paralelismo e estados compartilhados.

Paralelização de UDF Java¶

Para melhorar o desempenho, o Snowflake paraleliza tanto entre JVMs diferente quanto dentro de JVMs.

• Entre JVMs diferentes:

  O Snowflake paralela entre os trabalhadores em um warehouse. Cada trabalhador executa uma (ou mais) JVMs. Isso significa que não existe um estado global compartilhado. No máximo, o estado só pode ser compartilhado dentro de uma única JVM.

• Dentro de JVMs:

  • Cada JVM pode executar vários threads que podem chamar o mesmo método do manipulador da mesma instância em paralelo. Isso significa que cada método do manipulador precisa ser thread-safe.

  • Se uma UDF é IMMUTABLE e uma instrução SQL chama a UDF mais de uma vez com os mesmos argumentos para a mesma linha, a UDF retorna o mesmo valor para cada chamada para aquela linha. Por exemplo, o código a seguir retorna o mesmo valor duas vezes para cada linha se a UDF for IMMUTABLE:

    select
           my_java_udf(42),
           my_java_udf(42)
        from table1;
    

    Copy

    Se você quiser que múltiplas chamadas retornem valores independentes mesmo quando passarem os mesmos argumentos não quiser declarar a função como VOLATILE, ligue diferentes chamadas a UDFs separadas ao mesmo método do manipulador. Por exemplo:

    1. Crie um arquivo JAR chamado @java_udf_stage/rand.jar com o código:

       class MyClass {
       
           private double x;
       
           // Constructor
           public MyClass()  {
               x = Math.random();
           }
       
           // Handler
           public double myHandler() {
               return x;
           }
       }
       

       Copy

    2. Crie UDFs de Java da forma mostrada abaixo. Essas UDFs têm nomes diferentes, mas usam o mesmo arquivo JAR e o mesmo manipulador dentro desse arquivo JAR.

       create function my_java_udf_1()
           returns double
           language java
           imports = ('@java_udf_stage/rand.jar')
           handler = 'MyClass.myHandler';
       
       create function my_java_udf_2()
           returns double
           language java
           imports = ('@java_udf_stage/rand.jar')
           handler = 'MyClass.myHandler';
       

       Copy

    3. O código a seguir chama ambas as UDFs. As UDFs apontam para o mesmo arquivo e manipulador JAR. Essas chamadas criam duas instâncias da mesma classe. Cada instância retorna um valor independente, portanto o exemplo abaixo retorna dois valores independentes em vez de retornar o mesmo valor duas vezes:

       select
               my_java_udf_1(),
               my_java_udf_2()
           from table1;
       

       Copy

Como armazenar informações de estado de uma JVM¶

Uma razão para evitar confiar no estado dinâmico compartilhado é que as linhas não são necessariamente processadas em uma ordem previsível. Cada vez que uma instrução SQL é executada, o Snowflake pode variar o número de lotes, a ordem em que os lotes são processados e a ordem das linhas dentro de um lote. Se uma UDF escalar for projetada para que uma linha afete o valor de retorno para uma linha posterior, a UDF pode retornar resultados diferentes cada vez que a UDF for executada.