Le modèle SQL Server vers BigQuery est un pipeline de traitement par lot qui copie les données d'une table SQL Server vers une table BigQuery existante. Ce pipeline utilise JDBC pour se connecter à SQL Server. Pour obtenir une couche supplémentaire de protection, vous pouvez également transmettre une clé Cloud KMS avec des paramètres de nom d'utilisateur, de mot de passe et de chaîne de connexion encodés en base64 et chiffrés avec la clé Cloud KMS. Pour en savoir plus sur le chiffrement des paramètres de nom d'utilisateur, de mot de passe et de chaîne de connexion, consultez la page Point de terminaison de chiffrement de l'API Cloud KMS.
Conditions requises pour ce pipeline
- La table BigQuery doit exister avant l'exécution du pipeline.
- La table BigQuery doit avoir un schéma compatible.
- La base de données relationnelle doit être accessible à partir du sous-réseau dans lequel Dataflow est exécuté.
Paramètres de modèle
Paramètres obligatoires
- driverJars : Liste des fichiers JAR du pilote, séparés par une virgule. (Exemple : gs://your-bucket/driver_jar1.jar,gs://your-bucket/driver_jar2.jar).
- driverClassName : Nom de classe du pilote JDBC. (Exemple : com.mysql.jdbc.Driver).
- connectionURL : Chaîne d'URL de connexion JDBC. Exemple :
jdbc:mysql://some-host:3306/sampledb
Peut être transmis en tant que chaîne encodée en base64 et chiffrée avec une clé Cloud KMS. Notez la différence entre une chaîne de connexion à une base de données Oracle non-RAC (jdbc:oracle:thin:@some-host:<port>:<sid>
) et une chaîne de connexion à une base de données Oracle RAC (jdbc:oracle:thin:@//some-host[:<port>]/<service_name>
). (Exemple : jdbc:mysql://some-host:3306/sampleb). - outputTable : Emplacement de table BigQuery dans lequel écrire la sortie. Le nom doit être au format
<project>:<dataset>.<table_name>
. Le schéma de la table doit correspondre aux objets d'entrée. (Exemple : - bigQueryLoadingTemporaryDirectory : Répertoire temporaire pour le processus de chargement BigQuery (exemple : gs://your-bucket/your-files/temp_dir).
Paramètres facultatifs
- connectionProperties : Chaîne de propriétés à utiliser pour la connexion JDBC. Le format de la chaîne doit être [propertyName=property;]*. (Exemple : unicode=true;characterEncoding=UTF-8).
- username : Nom d'utilisateur à utiliser pour la connexion JDBC. Peut être transmis en tant que chaîne encodée en base64 et chiffrée avec une clé Cloud KMS.
- password : Mot de passe à utiliser pour la connexion JDBC. Peut être transmis en tant que chaîne encodée en base64 et chiffrée avec une clé Cloud KMS.
- query : Requête à exécuter sur la source pour extraire les données. Vous devez spécifier "query" OU spécifier "table" ET "PartitionColumn". (Exemple : select * from sampledb.sample_table).
- KMSEncryptionKey : Clé de chiffrement Cloud KMS permettant de déchiffrer le nom d'utilisateur, le mot de passe et la chaîne de connexion. Si la clé Cloud KMS est transmise, le nom d'utilisateur, le mot de passe et la chaîne de connexion doivent tous être transmis de manière chiffrée. (Exemple : projects/your-project/locations/global/keyRings/your-keyring/cryptoKeys/your-key).
- useColumnAlias : Si cette option est activée (définie sur "true"), le pipeline considère les alias de colonne ("AS") au lieu du nom de colonne pour mapper les lignes sur BigQuery. Valeur par défaut : "false".
- isTruncate : Si cette option est activée (définie sur "true"), le pipeline est tronqué avant de charger les données dans BigQuery. La valeur par défaut est "false", qui permet uniquement d'ajouter des données.
- partitionColumn : Si ce paramètre est fourni (avec
table
), JdbcIO lit la table en parallèle en exécutant plusieurs instances de la requête sur la même table (sous-requête) à l'aide de plages. Actuellement, seules les colonnes de partition Long sont acceptées. Vous devez spécifier "query" OU spécifier "table" ET "PartitionColumn". - table : Table à partir de laquelle lire en utilisant des partitions. Vous devez spécifier "query" OU spécifier "table" ET "PartitionColumn". Ce paramètre accepte également une sous-requête entre parenthèses. (Exemple : (select id, name from Person) as subq).
- numPartitions : Nombre de partitions. Ce paramètre, avec les limites inférieure et supérieure, forme des pas de partition pour les expressions de clause WHERE générées, qui sont utilisées pour diviser la colonne de partition de manière uniforme. Lorsque l'entrée est inférieure à 1, le nombre est défini sur 1.
- lowerBound : Limite inférieure utilisée dans le schéma de partition. Si aucune valeur n'est fournie, elle est automatiquement déduite par Beam (pour les types compatibles).
- upperBound : Limite supérieure utilisée dans le schéma de partition. Si aucune valeur n'est fournie, elle est automatiquement déduite par Beam (pour les types compatibles).
- fetchSize : Nombre de lignes à extraire simultanément de la base de données. Non utilisé pour les lectures partitionnées. La valeur par défaut est 50 000.
- createDisposition : CreateDisposition BigQuery. Par exemple, CREATE_IF_NEEDED, CREATE_NEVER. La valeur par défaut est CREATE_NEVER.
- bigQuerySchemaPath : Chemin d'accès Cloud Storage pour le schéma JSON BigQuery. Si
createDisposition
est défini sur CREATE_IF_NEEDED, ce paramètre doit être spécifié. (Exemple : gs://your-bucket/your-schema.json). - disabledAlgorithms : Algorithmes à désactiver, séparés par une virgule. Si cette valeur est définie sur
none
, aucun algorithme n'est désactivé. Soyez prudent, car les algorithmes désactivés par défaut souffrent de failles ou de problèmes de performances connus. (Exemple : SSLv3, RC4). - extraFilesToStage : Chemins d'accès Cloud Storage ou secrets Secret Manager séparés par une virgule afin que les fichiers soient traités dans le nœud de calcul. Ces fichiers seront enregistrés dans le répertoire
/extra_files
de chaque nœud de calcul (exemple : gs://your-bucket/file.txt,projects/project-id/secrets/secret-id/versions/version-id). - useStorageWriteApi : Si cette option est activée (définie sur "true"), le pipeline utilise l'API Storage Write lors de l'écriture des données dans BigQuery (voir https://cloud.google.com/blog/products/data-analytics/streaming-data-into-bigquery-using-storage-write-api). La valeur par défaut est "false".
- useStorageWriteApiAtLeastOnce : Ce paramètre ne prend effet que si l'option "Utiliser l'API BigQuery Storage Write" est activée. Si cette option est activée, la sémantique de type "au moins une fois" est utilisée pour l'API Storage Write. Sinon, la sémantique de type "exactement une fois" est utilisée. La valeur par défaut est "false".
Exécuter le modèle
Console
- Accédez à la page Dataflow Créer un job à partir d'un modèle. Accéder à la page Créer un job à partir d'un modèle
- Dans le champ Nom du job, saisissez un nom de job unique.
- 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.
- Dans le menu déroulant Modèle Dataflow, sélectionnez the SQL Server to BigQuery template.
- Dans les champs fournis, saisissez vos valeurs de paramètres.
- Cliquez sur Run Job (Exécuter la tâche).
gcloud
Dans le shell ou le terminal, exécutez le modèle :
gcloud dataflow flex-template run JOB_NAME \ --project=PROJECT_ID \ --region=REGION_NAME \ --template-file-gcs-location=gs://dataflow-templates-REGION_NAME/VERSION/flex/SQLServer_to_BigQuery \ --parameters \ connectionURL=JDBC_CONNECTION_URL,\ query=SOURCE_SQL_QUERY,\ outputTable=PROJECT_ID:DATASET.TABLE_NAME, bigQueryLoadingTemporaryDirectory=PATH_TO_TEMP_DIR_ON_GCS,\ connectionProperties=CONNECTION_PROPERTIES,\ username=CONNECTION_USERNAME,\ password=CONNECTION_PASSWORD,\ KMSEncryptionKey=KMS_ENCRYPTION_KEY
Remplacez les éléments suivants :
JOB_NAME
: nom de job unique de votre choixVERSION
: version du modèle que vous souhaitez utiliserVous pouvez utiliser les valeurs suivantes :
latest
pour utiliser la dernière version du modèle, disponible dans le dossier parent non daté du bucket gs://dataflow-templates-REGION_NAME/latest/- Le nom de la version, par exemple
2023-09-12-00_RC00
, pour utiliser une version spécifique du modèle, qui est imbriqué dans le dossier parent daté respectif dans le bucket : gs://dataflow-templates-REGION_NAME/
REGION_NAME
: région dans laquelle vous souhaitez déployer votre job Dataflow, par exempleus-central1
JDBC_CONNECTION_URL
: URL de connexion JDBCSOURCE_SQL_QUERY
: requête SQL à exécuter sur la base de données source.DATASET
: votre ensemble de données BigQuery.TABLE_NAME
: nom de votre table BigQuery.PATH_TO_TEMP_DIR_ON_GCS
: chemin d'accès Cloud Storage au répertoire temporaireCONNECTION_PROPERTIES
: propriétés de connexion JDBC, le cas échéant.CONNECTION_USERNAME
: nom d'utilisateur de la connexion JDBCCONNECTION_PASSWORD
: mot de passe de la connexion JDBCKMS_ENCRYPTION_KEY
: clé de chiffrement Cloud KMS.
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/flexTemplates:launch { "launchParameter": { "jobName": "JOB_NAME", "containerSpecGcsPath": "gs://dataflow-templates-LOCATION/VERSION/flex/SQLServer_to_BigQuery" "parameters": { "connectionURL": "JDBC_CONNECTION_URL", "query": "SOURCE_SQL_QUERY", "outputTable": "PROJECT_ID:DATASET.TABLE_NAME", "bigQueryLoadingTemporaryDirectory": "PATH_TO_TEMP_DIR_ON_GCS", "connectionProperties": "CONNECTION_PROPERTIES", "username": "CONNECTION_USERNAME", "password": "CONNECTION_PASSWORD", "KMSEncryptionKey":"KMS_ENCRYPTION_KEY" }, "environment": { "zone": "us-central1-f" } } }
Remplacez les éléments suivants :
PROJECT_ID
: ID du projet Google Cloud dans lequel vous souhaitez exécuter le job DataflowJOB_NAME
: nom de job unique de votre choixVERSION
: version du modèle que vous souhaitez utiliserVous pouvez utiliser les valeurs suivantes :
latest
pour utiliser la dernière version du modèle, disponible dans le dossier parent non daté du bucket gs://dataflow-templates-REGION_NAME/latest/- Le nom de la version, par exemple
2023-09-12-00_RC00
, pour utiliser une version spécifique du modèle, qui est imbriqué dans le dossier parent daté respectif dans le bucket : gs://dataflow-templates-REGION_NAME/
LOCATION
: région dans laquelle vous souhaitez déployer votre job Dataflow, par exempleus-central1
JDBC_CONNECTION_URL
: URL de connexion JDBCSOURCE_SQL_QUERY
: requête SQL à exécuter sur la base de données source.DATASET
: votre ensemble de données BigQuery.TABLE_NAME
: nom de votre table BigQuery.PATH_TO_TEMP_DIR_ON_GCS
: chemin d'accès Cloud Storage au répertoire temporaireCONNECTION_PROPERTIES
: propriétés de connexion JDBC, le cas échéant.CONNECTION_USERNAME
: nom d'utilisateur de la connexion JDBCCONNECTION_PASSWORD
: mot de passe de la connexion JDBCKMS_ENCRYPTION_KEY
: clé de chiffrement Cloud KMS.
Étapes suivantes
- Apprenez-en plus sur les modèles Dataflow.
- Consultez la liste des modèles fournis par Google.