Fonctions définies par l’utilisateur dans Cloud

Créez un nouveau fichier main.py localement :

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

Si votre script Python importe des paquets tiers, indiquez-les dans un fichier requirements.txt, et ClickHouse Cloud les installera pour vous. Vous pouvez aussi inclure directement les dépendances dans l’archive ZIP, mais vous devrez alors fournir les paquets mis en cache pour les deux architectures CPU ; requirements.txt reste donc la solution la plus simple. Par exemple :

requests>=2.28.0
numpy>=1.23.0

Pour inclure les paquets de dépendances et tout autre fichier local (par exemple, des fichiers wheel, des fichiers de configuration ou des fichiers de données), placez-les dans le même répertoire que main.py et requirements.txt. Lorsque vous créez l’archive ZIP, incluez tous les fichiers :

zip is_business_hours.zip main.py requirements.txt

Vous pouvez référencer, dans votre code Python, le répertoire de base du chemin local inclus en utilisant os.path.dirname(os.path.abspath(__file__)). Cela renvoie le chemin absolu du répertoire où se trouve votre main.py dans l’archive ZIP, ce qui vous permet d’accéder aux autres fichiers inclus :

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')

Cela est utile lorsque vous devez :

• Accéder aux fichiers de configuration inclus avec votre UDF
• Charger des packages wheel pour des dépendances personnalisées
• Référencer des scripts supplémentaires ou des fichiers de données

Compressez maintenant le fichier en archive ZIP :

zip is_business_hours.zip main.py

1. Depuis la page d’accueil de la console Cloud, cliquez sur le nom de votre organisation dans le menu en bas à gauche.
2. Sélectionnez Fonctions définies par l’utilisateur dans le menu.
3. Sur la page des fonctions définies par l’utilisateur, cliquez sur Configurer une UDF. Un panneau de configuration s’ouvre sur la droite de l’écran.
4. Saisissez un nom de fonction. Pour cet exemple, utilisez isBusinessHours.
5. Sélectionnez un type de fonction, Executable pool ou Executable :
   • Executable pool : un pool de processus persistants est maintenu, et un processus est prélevé dans ce pool pour effectuer les lectures.
   • Executable : le script s’exécute à chaque requête.
6. Pour cet exemple, utilisez les paramètres par défaut. Pour obtenir la liste complète des paramètres de configuration, consultez Executable user-defined functions.
7. Cliquez sur Parcourir le fichier pour téléverser le fichier .zip créé au début de ce tutoriel.
8. Ajoutez un nouvel argument. Pour cet exemple, ajoutez un argument timestamp de type DateTime.
9. Sélectionnez un type de retour. Pour cet exemple, sélectionnez Bool.
10. Cliquez sur Créer une UDF. Une boîte de dialogue affiche l’état actuel du build.
    • En cas de problème, l’état devient error.
    • Sinon, l’état passe de building à provisioning. Votre service doit être actif pour terminer le provisionnement. Si votre service est inactif, cliquez sur Réveiller le service dans le panneau Détails de l’UDF à côté du nom du service.
    • Une fois l’opération terminée, l’état devient deployed.

1. revenez à la page d’accueil de la SQL Console en cliquant sur Settings - return to your service view dans le coin supérieur gauche de la page
2. cliquez sur SQL Console dans le menu de gauche
3. saisissez la requête suivante :

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

Vous devriez obtenir le résultat suivant :

true    false

Pour modifier le code d’une UDF, créez une nouvelle version. Le panneau Edit sert uniquement à gérer les services auxquels une UDF est affectée ; y téléverser un fichier ne remplacera pas le code déployé.

1. Depuis la page d’accueil de la console Cloud, cliquez sur le nom de votre organisation dans le menu en bas à gauche.
2. Sélectionnez User-defined functions dans le menu.
3. Cliquez sur les trois points sous Actions pour la UDF isBusinessHours, puis sur Create new version
4. Téléversez un fichier zip contenant le code modifié, ou modifiez les paramètres, puis cliquez sur Create new version

Vous avez ajouté avec succès votre première fonction définie par l’utilisateur via l’UI, confirmé qu’elle s’exécute et vu comment en créer une nouvelle version si nécessaire.