Ingérer des données depuis Verkada
Bêta
Cette fonctionnalité est en version Bêta. Les administrateurs du workspace peuvent contrôler l’accès à cette fonctionnalité depuis la page Aperçus . Consultez Gérer les aperçus Databricks.
Cette page explique comment créer un pipeline d’ingestion Verkada géré à l’aide de Lakeflow Connect.
Exigences
-
Pour créer un pipeline d’ingestion, remplissez d’abord les conditions suivantes :
-
Votre workspace doit être activé pour Unity Catalog.
-
Le compute Serverless doit être activé pour votre workspace. Voir les exigences du compute Serverless.
-
Pour créer une nouvelle connexion, vous devez disposer des privilèges
CREATE CONNECTIONsur le métastore. Voir Gérer les privilèges dans Unity Catalog.Si le connecteur prend en charge la création de pipeline via l’interface utilisateur, un administrateur peut créer la connexion et le pipeline en même temps en suivant les étapes indiquées sur cette page. Cependant, si les utilisateurs qui créent des pipelines utilisent la création de pipeline via API ou ne sont pas des administrateurs, un administrateur doit d’abord créer la connexion dans Catalog Explorer. Voir Connecter à des sources d’ingestion gérées.
-
Pour utiliser une connexion existante, vous devez disposer des privilèges
USE CONNECTIONouALL PRIVILEGESsur l’objet de connexion. -
Vous devez disposer des privilèges
USE CATALOGsur le catalogue cible. -
Vous devez disposer des privilèges
USE SCHEMAetCREATE TABLEsur un schéma existant ou des privilègesCREATE SCHEMAsur le catalogue cible.
-
-
Pour ingérer des données depuis Verkada, configurez d’abord l’authentification depuis Databricks et créez une connexion. Consultez Configurer l’authentification vers Verkada et Créer une connexion Verkada.
Options du connecteur
Définissez des options au niveau de la table sur l’objet individuel. Voir les Exemples pour l’utilisation.
Option | Périmètre | Obligatoire | S’applique à | Description |
|---|---|---|---|---|
| Table | Non |
| Événement d’audit le plus ancien à ingérer lors de la première synchronisation, sous forme de timestamp UTC ISO 8601 (par exemple, |
Créer un pipeline d’ingestion
Pour obtenir la liste des tables sources prises en charge, consultez Tables sources prises en charge.
- Databricks UI
- Declarative Automation Bundles
- Databricks notebook
- Dans la barre latérale du workspace Databricks, cliquez sur Data Ingestion .
- Sur la page Add data , sous Connecteurs Databricks , cliquez sur Verkada .
- Sur la page Connection de l’assistant d’ingestion, sélectionnez la connexion qui stocke vos identifiants Verkada. Si vous disposez du privilège
CREATE CONNECTIONsur le métastore, cliquez surCreate connection pour créer une connexion avec les identifiants provenant de Configure authentication to Verkada.
- Cliquez sur Suivant .
- Sur la page Ingestion setup , saisissez un nom pour le pipeline.
- Sélectionnez un catalogue et un schéma dans lesquels écrire les logs d’événements. Si vous disposez des privilèges
USE CATALOGetCREATE SCHEMAsur le catalogue, cliquez surCréer un schéma dans le menu déroulant pour créer un schéma.
- Cliquez sur Créer un pipeline et continuer .
- Sur la page Source , sélectionnez les tables à ingérer.
- Cliquez sur Enregistrer et continuer .
- Sur la page Destination , sélectionnez un catalogue et un schéma dans lesquels charger les données. Si vous disposez des privilèges
USE CATALOGetCREATE SCHEMAsur le catalogue, cliquez surCréer un schéma dans le menu déroulant pour créer un schéma.
- Cliquez sur Enregistrer et continuer .
- (Facultatif) Sur la page Calendriers et notifications , cliquez sur
Créer un calendrier . Définissez la fréquence pour refresh les tables de destination.
- (Facultatif) Cliquez sur
Ajouter une notification pour définir des notifications par e-mail en cas de succès ou d’échec de l’opération du pipeline, puis cliquez sur Enregistrer et exécuter le pipeline .
Utilisez les Declarative Automation Bundles pour gérer les pipelines Verkada en tant que code. Les bundles peuvent contenir des définitions YAML de Jobs et de tâches, sont gérés à l'aide de la CLI Databricks et peuvent être partagés et exécutés dans différents Workspace cibles (tels que le développement, la pré-production et la production). Pour plus d'informations, consultez Que sont les Declarative Automation Bundles ?.
-
Créez un bundle à l'aide de la CLI Databricks :
Bashdatabricks bundle init -
Ajoutez deux nouveaux fichiers de ressources au bundle :
- Un fichier de définition de pipeline (par exemple,
resources/verkada_pipeline.yml). Voir pipeline.ingestion_definition et Exemples. - Un fichier de définition de job qui contrôle la fréquence d’ingestion des données (par exemple,
resources/verkada_job.yml).
- Un fichier de définition de pipeline (par exemple,
-
Déployez le pipeline à l'aide de la CLI Databricks :
Bashdatabricks bundle deploy
- Importez le notebook suivant dans votre workspace Databricks :
-
Laissez les cellules un et deux telles quelles. Ne pas modifier.
-
Modifiez la cellule trois avec les détails de configuration de votre pipeline. Voir pipeline.ingestion_definition et les Exemples.
-
Configurez éventuellement les paramètres avancés du pipeline. Voir Modèles courants pour les pipelines d’ingestion gérés.
-
Cliquez sur Tout exécuter .
Exemples
Le connecteur Verkada met à disposition 2 tables sources dans le schéma source default. Ingérer des tables individuelles ou le schéma entier.
Ingérer des tables spécifiques
Utilisez cette option pour ingérer un sous-ensemble spécifique de tables ou pour personnaliser le nom de destination par table.
- Declarative Automation Bundles
- Databricks notebook
Le fichier de définition de pipeline suivant ingère des tables Verkada individuelles :
resources:
pipelines:
verkada_pipeline:
name: verkada_pipeline
catalog: 'main'
target: 'verkada_data'
ingestion_definition:
connection_name: verkada_connection
objects:
- table:
source_schema: 'default'
source_table: 'audit_log'
destination_catalog: 'main'
destination_schema: 'verkada_data'
destination_table: 'audit_log'
connector_options:
api_source_connector_options:
options:
start_datetime: '<start-datetime>'
- table:
source_schema: 'default'
source_table: 'users'
destination_catalog: 'main'
destination_schema: 'verkada_data'
destination_table: 'users'
La spécification de pipeline suivante ingère des tables Verkada individuelles :
pipeline_name = "verkada_pipeline"
connection_name = "<verkada-connection>"
pipeline_spec = {
"name": pipeline_name,
"ingestion_definition": {
"connection_name": connection_name,
"objects": [
{
"table": {
"source_schema": "default",
"source_table": "audit_log",
"destination_catalog": "main",
"destination_schema": "verkada_data",
"destination_table": "audit_log",
"connector_options": {
"api_source_connector_options": {
"options": {
"start_datetime": "<start-datetime>"
}
}
}
}
},
{
"table": {
"source_schema": "default",
"source_table": "users",
"destination_catalog": "main",
"destination_schema": "verkada_data",
"destination_table": "users"
}
}
]
}
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)
Ingérer le schéma entier
Utilisez cette option pour ingérer toutes les tables source Verkada dans un schéma de destination unique avec une seule déclaration.
- Declarative Automation Bundles
- Databricks notebook
Le fichier de définition de pipeline suivant ingère toutes les tables Verkada prises en charge dans un schéma de destination :
resources:
pipelines:
verkada_pipeline:
name: verkada_pipeline
catalog: 'main'
target: 'verkada_data'
ingestion_definition:
connection_name: verkada_connection
objects:
- schema:
source_schema: 'default'
destination_catalog: 'main'
destination_schema: 'verkada_data'
La spécification de pipeline suivante ingère toutes les tables Verkada prises en charge dans un schéma de destination :
pipeline_name = "verkada_pipeline"
connection_name = "<verkada-connection>"
pipeline_spec = {
"name": pipeline_name,
"ingestion_definition": {
"connection_name": connection_name,
"objects": [
{
"schema": {
"source_schema": "default",
"destination_catalog": "main",
"destination_schema": "verkada_data"
}
}
]
}
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)
Fichier de définition de job Declarative Automation Bundles
Voici un exemple de fichier de définition de Job à utiliser avec les Declarative Automation Bundles. Le Job s'exécute quotidiennement.
- Declarative Automation Bundles
resources:
jobs:
verkada_job:
name: verkada_job
schedule:
quartz_cron_expression: '0 0 0 * * ?'
timezone_id: 'UTC'
tasks:
- task_key: verkada_ingestion
pipeline_task:
pipeline_id: ${resources.pipelines.verkada_pipeline.id}
Modèles courants
Pour des configurations de pipeline avancées, consultez Modèles courants pour les pipelines d’ingestion gérés.
Étapes suivantes
Start, planifiez et définissez des alertes sur votre pipeline. Voir les tâches de maintenance courantes du pipeline.