Funções definidas pelo usuário no Cloud

Crie localmente um novo arquivo main.py:

cat > main.py << 'EOF'
import sys
from datetime import datetime

for line in sys.stdin:
    ts = datetime.fromisoformat(line.strip())
    result = 1 if (0 <= ts.weekday() <= 4 and 9 <= ts.hour <= 17) else 0
    print(result)
    sys.stdout.flush()
EOF

Se o seu script em Python importar pacotes de terceiros, liste-os em um arquivo requirements.txt, e o ClickHouse Cloud os instalará para você. Como alternativa, você pode empacotar as dependências diretamente no ZIP, mas, nesse caso, deverá incluir os pacotes em cache para ambas as arquiteturas de CPU, portanto o requirements.txt é mais simples. Por exemplo:

requests>=2.28.0
numpy>=1.23.0

Para incluir pacotes de dependência e quaisquer arquivos locais adicionais (como arquivos wheel, arquivos de configuração ou arquivos de dados), coloque-os no mesmo diretório que main.py e requirements.txt. Ao criar o arquivo ZIP, inclua todos os arquivos:

zip is_business_hours.zip main.py requirements.txt

Você pode fazer referência ao diretório base do caminho local incluído no pacote no seu código Python usando os.path.dirname(os.path.abspath(__file__)). Isso retorna o caminho absoluto para o diretório em que o main.py está localizado dentro do arquivo ZIP, permitindo acessar outros arquivos incluídos no pacote:

import os

# Get the base directory of the bundled files
base_dir = os.path.dirname(os.path.abspath(__file__))
config_path = os.path.join(base_dir, 'config.json')

Isso é útil quando você precisa:

• Acessar arquivos de configuração incluídos na sua UDF
• Carregar pacotes wheel para dependências personalizadas
• Referenciar scripts adicionais ou arquivos de dados

Agora compacte o arquivo em um arquivo ZIP:

zip is_business_hours.zip main.py

1. Na página inicial do Cloud Console, clique no nome da sua organização no menu no canto inferior esquerdo.
2. Selecione Funções Definidas pelo Usuário no menu.
3. Na página de funções definidas pelo usuário, clique em Set up a UDF. Um painel de configuração é aberto no lado direito da tela.
4. Digite um nome para a função. Para este exemplo, use isBusinessHours.
5. Selecione um tipo de função: Executable pool ou Executable:
   • Executable pool: Um pool de processos persistentes é mantido, e um processo é obtido desse pool para leituras.
   • Executable: O script é executado em cada consulta.
6. Para este exemplo, use as configurações padrão. Para ver a lista completa dos parâmetros de configuração, consulte Funções definidas pelo usuário executáveis.
7. Clique em Browse File para fazer upload do arquivo .zip criado no início deste tutorial.
8. Adicione um novo argumento. Para este exemplo, adicione o argumento timestamp com o tipo DateTime.
9. Selecione um tipo de retorno. Para este exemplo, selecione Bool.
10. Clique em Create UDF. Uma caixa de diálogo exibe o status atual da compilação.
    • Se houver algum problema, o status muda para error.
    • Caso contrário, o status avança de building para provisioning. Seu serviço precisa estar ativo para concluir o provisioning. Se o serviço estiver ocioso, clique em Wake Up Service no painel UDF details, ao lado do nome do serviço.
    • Quando a implantação for concluída, o status muda para deployed.

1. volte à página inicial do SQL Console clicando em Settings - voltar para a visão do seu serviço no canto superior esquerdo da página
2. clique em SQL Console no menu à esquerda
3. escreva a seguinte consulta:

SELECT isBusinessHours('2026-03-20 10:00:00'::DateTime), isBusinessHours('2026-03-20 23:00:00'::DateTime);

Você deverá ver o seguinte resultado:

true    false

Para alterar o código de uma UDF, crie uma nova versão. O painel Edit gerencia apenas a quais serviços uma UDF está atribuída; fazer upload de um arquivo ali não substituirá o código implantado.

1. Na página inicial do Cloud Console, clique no nome da sua organização no menu no canto inferior esquerdo.
2. Selecione Funções Definidas pelo Usuário no menu.
3. Clique nos três pontos em Ações da UDF isBusinessHours e, em seguida, em Criar nova versão
4. Faça upload de um arquivo zip com o código modificado ou altere as configurações e clique em Criar nova versão

Você adicionou com sucesso sua primeira função definida pelo usuário pela UI, confirmou que ela é executada e viu como criar uma nova versão, se necessário.