Modèle Pub/Sub vers fichiers Avro dans Cloud Storage

Le modèle Pub/Sub vers fichiers Avro dans Cloud Storage est un pipeline de streaming qui lit les données d'un sujet Pub/Sub et écrit des fichiers Avro dans le bucket Cloud Storage spécifié.

Conditions requises pour ce pipeline

  • Le sujet Pub/Sub d'entrée doit exister avant l'exécution du pipeline.

Paramètres de modèle

Paramètres obligatoires

  • inputTopic : sujet Pub/Sub auquel s'abonner pour la consultation de messages. Le nom du thème doit être au format projects/<PROJECT_ID>/topics/<TOPIC_NAME>.
  • outputDirectory : répertoire de sortie dans lequel les fichiers Avro de sortie sont archivés. Doit inclure / à la fin. Exemple : gs://example-bucket/example-directory/.
  • avroTempDirectory : répertoire des fichiers Avro temporaires. Doit inclure / à la fin. Exemple : gs://example-bucket/example-directory/.

Paramètres facultatifs

  • outputFilenamePrefix : préfixe du nom de fichier de sortie pour les fichiers Avro. La valeur par défaut est : "output".
  • outputFilenameSuffix : suffixe du nom de fichier de sortie pour les fichiers Avro. La valeur par défaut est vide.
  • outputShardTemplate : Le modèle de segment définit la partie dynamique de chaque fichier ciblé sur une fenêtre. Par défaut, le pipeline utilise un seul segment pour la sortie vers le système de fichiers dans chaque fenêtre. Par conséquent, toutes les données sortent dans un seul fichier par fenêtre. Le outputShardTemplate devient par défaut to W-P-SS-of-NNW correspond à la plage de dates de la fenêtre, P correspond aux informations du volet, S correspond au numéro de segment et N au nombre de segments. Dans le cas d'un fichier unique, la partie SS-of-NN de outputShardTemplate est 00-of-01.
  • yearPattern : modèle de mise en forme de l'année. Doit être une ou plusieurs valeurs : y ou Y. La casse n'a pas d'incidence sur l'année. Vous pouvez également encapsuler le modèle avec des caractères non alphanumériques ou le caractère de répertoire ("/"). La valeur par défaut est YYYY.
  • monthPattern : modèle de mise en forme du mois. Doit être un ou plusieurs caractères M. Vous pouvez également encapsuler le modèle avec des caractères non alphanumériques ou le caractère de répertoire ("/"). La valeur par défaut est MM.
  • dayPattern : modèle de mise en forme du jour. Doit correspondre à une ou plusieurs valeurs d pour le jour du mois ou D pour le jour de l'année. Vous pouvez également encapsuler le modèle avec des caractères non alphanumériques ou le caractère de répertoire ("/"). La valeur par défaut est dd.
  • hourPattern : modèle de mise en forme de l'heure. Doit être un ou plusieurs caractères H. Vous pouvez également encapsuler le modèle avec des caractères non alphanumériques ou le caractère de répertoire ("/"). La valeur par défaut est HH.
  • minutePattern : modèle de mise en forme des minutes. Doit être un ou plusieurs caractères m. Vous pouvez également encapsuler le modèle avec des caractères non alphanumériques ou le caractère de répertoire ("/"). La valeur par défaut est mm.

Exécuter le modèle

Console

  1. Accédez à la page Dataflow Créer un job à partir d'un modèle.
  2. Accéder à la page Créer un job à partir d'un modèle
  3. Dans le champ Nom du job, saisissez un nom de job unique.
  4. Facultatif : pour Point de terminaison régional, sélectionnez une valeur dans le menu déroulant. La région par défaut est us-central1.

    Pour obtenir la liste des régions dans lesquelles vous pouvez exécuter un job Dataflow, consultez la page Emplacements Dataflow.

  5. Dans le menu déroulant Modèle Dataflow, sélectionnez the Pub/Sub to Avro Files on Cloud Storage template.
  6. Dans les champs fournis, saisissez vos valeurs de paramètres.
  7. Cliquez sur Run Job (Exécuter la tâche).

gcloud

Dans le shell ou le terminal, exécutez le modèle :

gcloud dataflow jobs run JOB_NAME \
    --gcs-location gs://dataflow-templates-REGION_NAME/VERSION/Cloud_PubSub_to_Avro \
    --region REGION_NAME \
    --staging-location STAGING_LOCATION \
    --parameters \
inputTopic=projects/PROJECT_ID/topics/TOPIC_NAME,\
outputDirectory=gs://BUCKET_NAME/output/,\
outputFilenamePrefix=FILENAME_PREFIX,\
outputFilenameSuffix=FILENAME_SUFFIX,\
outputShardTemplate=SHARD_TEMPLATE,\
avroTempDirectory=gs://BUCKET_NAME/temp/

Remplacez les éléments suivants :

  • JOB_NAME : nom de job unique de votre choix
  • REGION_NAME : région dans laquelle vous souhaitez déployer votre job Dataflow, par exemple us-central1
  • VERSION : version du modèle que vous souhaitez utiliser

    Vous pouvez utiliser les valeurs suivantes :

  • STAGING_LOCATION : emplacement des fichiers locaux de préproduction (par exemple, gs://your-bucket/staging)
  • TOPIC_NAME : nom du sujet Pub/Sub
  • BUCKET_NAME : nom du bucket Cloud Storage
  • FILENAME_PREFIX : préfixe du nom de fichier de sortie préféré
  • FILENAME_SUFFIX : suffixe du nom de fichier de sortie préféré
  • SHARD_TEMPLATE : modèle de partition de sortie préféré

API

Pour exécuter le modèle à l'aide de l'API REST, envoyez une requête HTTP POST. Pour en savoir plus sur l'API, ses autorisations et leurs champs d'application, consultez la section projects.templates.launch.

POST https://dataflow.googleapis.com/v1b3/projects/PROJECT_ID/locations/LOCATION/templates:launch?gcsPath=gs://dataflow-templates-LOCATION/VERSION/Cloud_PubSub_to_Avro
{
   "jobName": "JOB_NAME",
   "environment": {
       "ipConfiguration": "WORKER_IP_UNSPECIFIED",
       "additionalExperiments": []
    },
   "parameters": {
       "inputTopic": "projects/PROJECT_ID/topics/TOPIC_NAME",
       "outputDirectory": "gs://BUCKET_NAME/output/",
       "avroTempDirectory": "gs://BUCKET_NAME/temp/",
       "outputFilenamePrefix": "FILENAME_PREFIX",
       "outputFilenameSuffix": "FILENAME_SUFFIX",
       "outputShardTemplate": "SHARD_TEMPLATE"
   }
}

Remplacez les éléments suivants :

  • PROJECT_ID : ID du projet Google Cloud dans lequel vous souhaitez exécuter le job Dataflow
  • JOB_NAME : nom de job unique de votre choix
  • LOCATION : région dans laquelle vous souhaitez déployer votre job Dataflow, par exemple us-central1
  • VERSION : version du modèle que vous souhaitez utiliser

    Vous pouvez utiliser les valeurs suivantes :

  • STAGING_LOCATION : emplacement des fichiers locaux de préproduction (par exemple, gs://your-bucket/staging)
  • TOPIC_NAME : nom du sujet Pub/Sub
  • BUCKET_NAME : nom du bucket Cloud Storage
  • FILENAME_PREFIX : préfixe du nom de fichier de sortie préféré
  • FILENAME_SUFFIX : suffixe du nom de fichier de sortie préféré
  • SHARD_TEMPLATE : modèle de partition de sortie préféré

Étapes suivantes