Documentation de référence de l'outil de ligne de commande

Ce document présente une description détaillée des commandes et des indicateurs de l'outil de ligne de commande bq. Pour plus d'informations sur l'utilisation de l'interface de ligne de commande, consultez la page Utiliser l'outil de ligne de commande bq.

Indicateurs globaux

L'outil de ligne de commande bq vous permet d'utiliser les indicateurs globaux suivants.

[OBSOLÈTE] Indicateurs d'autorisation bq

Les indicateurs d'autorisation bq sont obsolètes. Pour configurer une autorisation pour l'outil de ligne de commande bq, reportez-vous à la page Autoriser les outils du SDK Cloud.

--application_default_credential_file
Pour plus d'informations, consultez la page Configurer l'authentification des applications de production serveur à serveur. La valeur par défaut est ''.
--credential_file
Nom de fichier utilisé pour le stockage de votre jeton OAuth. La valeur par défaut est $HOME/.bigquery.v2.token.
--service_account
Utilisez l'adresse e-mail de ce compte de service pour l'autorisation. Exemple : 1234567890@developer.gserviceaccount.com. La valeur par défaut est ''.
--service_account_credential_file
Fichier utilisé pour le stockage des identifiants des comptes de service. Cet indicateur doit être défini si vous utilisez un compte de service.
--service_account_private_key_file
Fichier contenant la clé privée du compte de service. Cet indicateur est nécessaire si l'indicateur --service_account est spécifié. La valeur par défaut est ''.
--service_account_private_key_password
Mot de passe de la clé privée. Le mot de passe doit correspondre au mot de passe défini sur la clé lors de sa création. La valeur par défaut est notasecret.
--use_gce_service_account
Spécifiez cet indicateur pour utiliser les identifiants du compte de service au lieu des identifiants stockés lors d'opérations sur une instance Google Compute Engine. Pour en savoir plus, consultez la page Créer et activer des comptes de service pour les instances. La valeur par défaut est false.

Indicateurs globaux bq

--api
Point de terminaison de l'API à appeler. La valeur par défaut est https://www.googleapis.com.

--api_version Version de l'API à utiliser. La valeur par défaut est v2.

--apilog
Consignez toutes les requêtes et les réponses de l'API dans le fichier spécifié par cet indicateur. Vous pouvez également utiliser les journaux stdout et stderr. Spécifier la chaîne vide ('') dirige sur stdout.
--bigqueryrc
Chemin d'accès au fichier de configuration de l'outil de ligne de commande. Le fichier de configuration spécifie les nouveaux paramètres par défaut des indicateurs et peut être remplacé en spécifiant l'indicateur dans la ligne de commande. Si l'indicateur --bigqueryrc n'est pas spécifié, la variable d'environnement BIGQUERYRC est utilisée. Si cette dernière n'est pas spécifiée, le chemin ~/.bigqueryrc est utilisé. La valeur par défaut est $HOME/.bigqueryrc.
--ca_certificates_file
Emplacement de votre fichier de certificat CA. La valeur par défaut est ''.
--dataset_id
Ensemble de données par défaut à utiliser pour les requêtes. Cet indicateur est ignoré lorsqu'il n'est pas applicable. Vous pouvez définir la valeur sur [PROJECT_ID]:[DATASET] ou [DATASET]. Si [PROJECT_ID] n'est pas indiqué, le projet par défaut est utilisé. Vous pouvez remplacer ce paramètre en spécifiant l'indicateur --project_id. La valeur par défaut est ''.
--debug_mode
Pour afficher les traces sur les exceptions Python. La valeur par défaut est false.
--disable_ssl_validation
Désactive la validation du certificat HTTPS. La valeur par défaut est false.
--discovery_file
Nom de fichier du fichier JSON à lire pour la découverte. La valeur par défaut est ''.
--enable_gdrive
Si défini sur true, un nouveau jeton OAuth associé au niveau d'accès GDrive est demandé. Si défini sur false, un nouveau jeton OAuth sans niveau d'accès GDrive est demandé.
--fingerprint_job_id
Indique s'il faut utiliser un ID de tâche issu d'une empreinte de la configuration de la tâche. Empêche d'exécuter plusieurs fois la même tâche par inadvertance. La valeur par défaut est false.
--flagfile
Si spécifié, les définitions d'indicateurs du fichier fourni sont insérées dans l'outil de ligne de commande. La valeur par défaut est ''.
--format

Spécifie le format de sortie de la commande, soit :

  • pretty : sortie en tant que table formatée
  • sparse : sortie en tant que table simplifiée
  • prettyjson : format JSON facile à lire
  • json : format JSON le plus compact possible
  • csv : format CSV avec en-tête

Les formats pretty, sparse et prettyjson sont conçus pour être lisibles. Les formats json et csv son conçus pour permettre le passage à un autre programme. Si la valeur none est spécifiée, la commande ne produit aucun résultat. Si l'indicateur --format est absent, un format de sortie approprié est choisi en fonction de la commande.

--headless

Spécifie si la session bq doit être exécutée sans interaction de l'utilisateur. Si défini sur true, l'interaction est désactivée. Par exemple, debug_mode n'interférera pas avec le débogueur et la fréquence d'impression des informations sera réduite. La valeur par défaut est false.

--job_id

ID de tâche unique à utiliser pour la requête. S'il n'est pas spécifié dans une requête de création de tâche, un ID de tâche est généré. Cet indicateur ne s'applique qu'aux commandes destinées à créer des tâches : cp, extract, load et query. Pour plus d'informations, consultez la page Générer un ID de tâche.

--job_property

Paire clé/valeur supplémentaire à inclure dans le champ des propriétés de la configuration de la tâche. Répétez cet indicateur pour spécifier des propriétés supplémentaires.

--location

Chaîne correspondant à votre région ou à un emplacement multirégional. L'indicateur d'emplacement est nécessaire pour les commandes cancel et show (lorsque l'indicateur -j est utilisé pour afficher les informations de tâche). L'indicateur d'emplacement est facultatif pour les commandes ci-dessous :

Toutes les autres commandes ignorent l'indicateur --location.

--max_rows_per_request

Entier spécifiant le nombre maximal de lignes à renvoyer par opération de lecture.

--project_id

ID de projet à utiliser pour les requêtes. La valeur par défaut est ''.

--proxy_address

Nom ou adresse IP de l'hôte proxy à utiliser pour se connecter à GCP. La valeur par défaut est ''.

--proxy_password

Mot de passe à utiliser pour s'authentifier avec l'hôte proxy. La valeur par défaut est ''.

--proxy_port

Numéro de port à utiliser pour se connecter à l'hôte proxy. La valeur par défaut est ''.

--proxy_username

Nom d'utilisateur à utiliser pour s'authentifier avec l'hôte proxy. La valeur par défaut est ''.

--quiet ou -q

Si défini sur true, permet d'ignorer les mises à jour de l'état pendant l'exécution des tâches. La valeur par défaut est false.

--synchronous_mode ou -sync

Si défini sur true, attendez que l'exécution de la commande soit terminée avant de renvoyer et utilisez l'état d'avancement de la tâche comme code d'erreur. Si défini sur false, la tâche est créée et l'état d'exécution "réussie" est utilisé pour le code d'erreur. La valeur par défaut est true.

--trace

Jeton de traçage spécifié en tant que token:[TOKEN] à inclure dans les requêtes d'API.

Indicateurs spécifiques à la commande

L'outil de ligne de commande bq propose les indicateurs de commande ci-après.

bq cancel

La commande cancel permet d'annuler des tâches. La commande cancel ne comporte pas d'indicateur spécifique à la commande.

Pour plus d'informations sur l'utilisation de la commande cancel, consultez la page Annuler des tâches.

La commande cancel utilise les indicateurs globaux suivants :

--job_id
ID de tâche unique à utiliser pour la requête d'annulation. Vous pouvez le spécifier sans utiliser l'indicateur --job_id. Exemple : bq cancel [JOB_ID].
--synchronous_mode ou --sync
Si spécifié, attend que l'exécution de la commande soit terminée avant de renvoyer. Si défini sur false, la commande est immédiatement renvoyée. La valeur par défaut est true.

bq cp

La commande cp permet de copier des tables. La commande cp utilise les indicateurs suivants, spécifiques à la commande.

Pour plus d'informations sur l'utilisation de la commande cp, consultez la page Copier des tables.

--append_table ou -a
Si spécifié, copie une table et l'ajoute à une table existante. La valeur par défaut est false.
--destination_kms_key
Clé Cloud KMS permettant de chiffrer les données de la table de destination.
--force ou -f
Si spécifié et si la table de destination existe, remplace celle-ci et n'affiche aucune invite. La valeur par défaut est false.
--no_clobber ou -n
Si spécifié et si la table de destination existe, ne remplace pas celle-ci. La valeur par défaut est false.

bq extract

La commande extract permet d'exporter des données de table vers Google Cloud Storage.

Pour plus d'informations sur l'utilisation de la commande extract, consultez la page Exporter des données de table.

La commande extract utilise les indicateurs spécifiques à la commande suivants :

--compression
Type de compression à utiliser pour les fichiers exportés. Valeurs possibles : GZIP (CSV et JSON uniquement), DEFLATE (Avro uniquement), SNAPPY (Avro uniquement) et NONE. La valeur par défaut est NONE.
--destination_format

Format des données exportées. Les valeurs possibles sont les suivantes :

  • CSV
  • NEWLINE_DELIMITED_JSON
  • AVRO

La valeur par défaut est CSV.

--field_delimiter ou -F

Caractère indiquant la délimitation entre les colonnes du fichier de sortie pour les exportations au format CSV. Les indicateurs \t et tab sont autorisés pour les délimiteurs de tabulation.

--print_header

Si spécifié, affiche les lignes d'en-tête pour les formats comportant des en-têtes. La valeur par défaut est true.

bq head

La commande head affiche les lignes d'une table.

Pour plus d'informations sur l'utilisation de la commande head, consultez la page Parcourir les données de table.

La commande head utilise les indicateurs spécifiques à la commande suivants :

--job ou -j
Spécifiez cet indicateur avec un ID de tâche valide pour lire les résultats d'une tâche de requête. La valeur par défaut est false.
--max_rows ou -n
Entier indiquant le nombre de lignes à afficher lors de l'affichage des données de la table. La valeur par défaut est 100.
--selected_fields ou -c
Liste séparée par des virgules indiquant un sous-ensemble de champs à renvoyer (y compris les champs imbriqués et répétés) lors de l'affichage des données de la table. Si non spécifié, toutes les colonnes sont récupérées.
--start_row ou -s
Entier indiquant le nombre de lignes à ignorer avant d'afficher les données de la table. La valeur par défaut est 0 (commencer à la première ligne).
--table ou -t
Spécifiez cet indicateur avec un ID de table pour lire les lignes d'une table. La valeur par défaut est false.

bq insert

La commande insert vous permet d'insérer des lignes de données au format JSON délimitées par un retour à la ligne à l'aide du tampon d'insertion en flux continu. Cette commande est conçue à des fins de test uniquement. Pour diffuser des données en flux continu dans BigQuery, utilisez la méthode API insertAll.

Pour plus d'informations, consultez la page Insérer des données en flux continu dans BigQuery.

La commande insert utilise les indicateurs spécifiques à la commande suivants :

--ignore_unknown_values ou -i
Si spécifié, ignore les valeurs d'une ligne qui ne sont pas présentes dans le schéma de la table.
--skip_invalid_rows ou -s
Si spécifié, tente d'insérer des lignes valides, même si des lignes non valides sont présentes.
--template_suffix ou -x
Si spécifié, traite la table de destination comme un modèle de base, puis insère les lignes dans une table d'instance nommée {destination}{templateSuffix}. BigQuery gère la création de la table d'instance à l'aide du schéma du modèle de base.

bq load

La commande load charge les données dans une table.

Pour plus d'informations sur le chargement de données à partir de Google Cloud Storage à l'aide de la commande load, consultez les pages ci-dessous :

Pour plus d'informations sur le chargement de données à partir d'une source locale à l'aide de la commande load, consultez la page Charger des données dans BigQuery à partir d'une source de données locale.

La commande load utilise les indicateurs spécifiques à la commande suivants :

--allow_jagged_rows
Si spécifié, autorise les colonnes finales facultatives manquantes dans les données CSV.
--allow_quoted_newlines
Si spécifié, autorise les nouvelles lignes entre guillemets dans les données CSV.
--autodetect
Si spécifié, active la détection automatique du schéma pour les données CSV et JSON.
--destination_kms_key
Clé Cloud KMS pour le chiffrement des données de la table de destination.
--encoding ou -E
Encodage de caractères utilisé dans les données. Les valeurs possibles sont les suivantes :
  • ISO-8859-1 (également appelé Latin-1)
  • UTF-8
--field_delimiter ou -F
Caractère indiquant la délimitation entre les colonnes de données. Les indicateurs \t et tab sont autorisés pour les délimiteurs de tabulation.
--ignore_unknown_values
Si spécifié, autorise et ignore les valeurs supplémentaires non reconnues dans les données CSV ou JSON.
--max_bad_records
Entier spécifiant le nombre maximal d'enregistrements incorrects autorisés avant l'échec total de la tâche. La valeur par défaut est 0. Cinq erreurs au plus de n'importe quel type sont renvoyées, quelle que soit la valeur --max_bad_records.
--null_marker
Chaîne personnalisée facultative qui représente une valeur NULL dans les données CSV.
--projection_fields
Si utilisé avec le paramètre --source_format défini sur DATASTORE_BACKUP, indique les propriétés d'entité à charger à partir d'une exportation Cloud Datastore sous forme de liste séparée par des virgules. Les noms de propriétés sont sensibles à la casse et doivent faire référence à des propriétés de niveau supérieur. La valeur par défaut est ''. Cet indicateur peut également être utilisé avec les exportations Cloud Firestore.
--quote
Guillemet à utiliser pour délimiter les enregistrements. La valeur par défaut est " qui indique qu'aucun caractère de guillemet n'est défini.
--replace
Si spécifié, les données existantes sont effacées lors du chargement de nouvelles données. La valeur par défaut est false.
--schema
Chemin d'accès à un fichier de schéma JSON local, ou liste de définitions de colonnes séparées par des virgules au format [FIELD]:[DATA_TYPE],[FIELD]:[DATA_TYPE].
--schema_update_option

Lorsque vous ajoutez des données à une table (dans une tâche de chargement ou de requête) ou que vous remplacez une partition de table, spécifie comment mettre à jour le schéma de la table de destination. Les valeurs possibles sont les suivantes :

  • ALLOW_FIELD_ADDITION : Autoriser l'ajout de nouveaux champs
  • ALLOW_FIELD_RELAXATION : Autoriser l'assouplissement des champs REQUIRED sur NULLABLE

Répétez cet indicateur pour spécifier plusieurs options de mise à jour de schéma.

--skip_leading_rows

Entier qui spécifie le nombre de lignes à ignorer au début du fichier source.

--source_format

Format des données source. Les valeurs possibles sont les suivantes :

  • CSV
  • NEWLINE_DELIMITED_JSON
  • AVRO
  • DATASTORE_BACKUP
  • PARQUET
  • ORC
--time_partitioning_expiration

Entier qui spécifie (en secondes) le moment où une partition temporelle doit être supprimée. Le délai d'expiration correspond à la date UTC de la partition plus la valeur entière. Un nombre négatif indique l'absence de délai d'expiration.

--time_partitioning_field

Champ utilisé pour déterminer comment créer une partition temporelle. Si le partitionnement temporel est activé sans cette valeur, la table est partitionnée en fonction de l'heure de chargement.

--time_partitioning_type

Active le partitionnement temporel sur une table et définit le type de partition. Actuellement, la seule valeur possible est DAY qui génère une partition par jour.

--use_avro_logical_types

Si sourceFormat est défini sur AVRO, indique s'il faut convertir les types logiques en types correspondants tels que TIMESTAMP, au lieu de n'utiliser que leurs types bruts tels que INTEGER.

bq ls

La commande ls répertorie les objets d'une collection.

Pour plus d'informations sur l'utilisation de la commande ls, consultez les pages suivantes :

La commande ls utilise les indicateurs spécifiques à la commande suivants :

--all ou -a
Si spécifié, affiche tous les résultats : tâches de tous les utilisateurs ou de tous les ensembles de données (y compris les ensembles masqués). Cet indicateur n'est pas nécessaire pour répertorier les configurations ou les exécutions de transferts.
--datasets ou -d
Si spécifié, répertorie les ensembles de données. La valeur par défaut est false.
--filter

Répertorie les ensembles de données qui correspondent à l'expression de filtre. Utilise une liste de clés d’étiquette et de valeurs séparées par des espaces au format labels.[KEY]:[VALUE]. Pour les configurations de transfert, une expression de filtre au format dataSourceIds:[DATA_SOURCES] répertorie les configurations de transfert pour les sources de données spécifiées. Les valeurs possibles sont les suivantes :

  • dcm_dt : Campaign Manager
  • google_cloud_storage : Cloud Storage
  • dfp_dt : Google Ad Manager
  • adwords : Google Ads
  • merchant_center : Google Merchant Center
  • play : Google Play
  • youtube_channel : rapports de chaîne YouTube
  • youtube_content_owner : rapports du propriétaire de contenu YouTube

Concernant les exécutions de transferts, une expression de filtre au format states:[STATE] répertorie les exécutions de transferts avec les états spécifiés. Les valeurs possibles sont les suivantes : + SUCCEEDED + FAILED + PENDING + RUNNING + CANCELLED

--jobs ou -j

Si spécifié, répertorie les tâches. La valeur par défaut est false. Par défaut, les résultats sont limités à 100 000.

--max_creation_time

Entier représentant un horodatage en millisecondes. Si spécifié avec l'indicateur -j, répertorie les tâches créées avant l'horodatage.

--max_results ou -n

Entier indiquant le nombre maximal de résultats. La valeur par défaut est 50.

--min_creation_time

Entier représentant un horodatage en millisecondes. Si spécifié avec l'indicateur -j, répertorie les tâches créées après l'horodatage.

--message_type

Pour répertorier les messages du journal d'exécution de transferts d'un type particulier, spécifiez messageTypes:[MESSAGE_TYPE]. Les valeurs possibles sont les suivantes :

  • INFO
  • WARNING
  • ERROR
--models ou -m

Si spécifié, répertorie les modèles BigQuery ML.

--page_token ou -k

Si spécifié, répertorie des éléments à partir de ce jeton de page.

--projects ou -p

Si spécifié, affiche tous les projets. La valeur par défaut est false.

--run_attempt

Définissez cet indicateur sur LATEST pour ne répertorier que les dernières exécutions de transferts.

--transfer_config

Si spécifié, répertorie les configurations de transfert. Lorsque vous utilisez cet indicateur, vous devez également spécifier --transfer_location. La valeur par défaut est false.

--transfer_location

Répertorie les configurations de transfert à l'emplacement spécifié. Vous définissez l'emplacement de transfert lors de la création du transfert.

--transfer_log

Si spécifié, répertorie les messages du journal de transfert pour l'exécution du transfert spécifiée. La valeur par défaut est false.

--transfer_run

Si spécifié, répertorie les exécutions de transferts. La valeur par défaut est false.

bq mk

La commande mk crée un ensemble de données, une table, une vue ou une configuration de transfert.

Pour plus d'informations sur l'utilisation de la commande mk avec BigQuery, consultez les pages suivantes :

Pour plus d'informations sur l'utilisation de la commande mk avec le service de transfert de données BigQuery, consultez les pages suivantes :

La commande mk utilise les indicateurs spécifiques à la commande suivants :

--clustering_fields
Liste de noms de colonnes, séparés par des virgules, utilisée pour mettre une table en cluster. Cet indicateur n'est actuellement disponible que pour les tables partitionnées. Si spécifié, la table est partitionnée, puis mise en cluster à l'aide de ces colonnes.
--data_location
(Ancien) Spécifie l'emplacement de l'ensemble de données. Utilisez à la place l'indicateur global --location.
--data_source

Spécifie la source de données pour une configuration de transfert. Les valeurs possibles sont les suivantes :

  • dcm_dt : Campaign Manager
  • google_cloud_storage : Cloud Storage
  • dfp_dt : Google Ad Manager
  • adwords : Google Ads
  • merchant_center : Google Merchant Center
  • play : Google Play
  • youtube_channel : rapports de chaîne YouTube
  • youtube_content_owner : rapports du propriétaire de contenu YouTube

La valeur par défaut est ''.

--dataset ou -d

Si spécifié, crée un ensemble de données. La valeur par défaut est false.

--default_partition_expiration

Entier spécifiant le délai d'expiration par défaut en secondes pour toutes les partitions des tables partitionnées nouvellement créées dans l'ensemble de données. Le délai d'expiration d'une partition est défini sur la date UTC de la partition plus la valeur entière. Si cette propriété est définie, elle remplace le délai d'expiration de la table par défaut au niveau de l'ensemble de données, si celle-ci existe. Si vous spécifiez l'indicateur --time_partitioning_expiration lors de la création ou de la mise à jour d'une table partitionnée, le délai d'expiration des partitions défini au niveau de la table est prioritaire sur le délai d'expiration des partitions défini par défaut au niveau de l'ensemble de données.

--default_table_expiration

Entier qui spécifie la durée de vie par défaut en secondes des tables nouvellement créées dans un ensemble de données. Le délai d'expiration correspond à l'heure UTC actuelle plus la valeur entière.

--description

Description de l'ensemble de données ou de la table.

--destination_kms_key

Clé Cloud KMS employée pour chiffrer les données de la table.

--display_name

Nom d'affichage pour la configuration de transfert. La valeur par défaut est ''.

--end_time

Horodatage qui spécifie l'heure de fin d'une plage d'exécutions de transferts. Le format de l'horodatage est le suivant : RFC3339 UTC "Zulu".

--expiration

Entier spécifiant le délai d'expiration de la table ou de la vue. Le délai d'expiration est défini sur l'heure UTC actuelle plus cette valeur.

--external_table_definition

Spécifie une définition de table à utiliser pour créer une table externe. La valeur peut être une définition de table intégrée ou un chemin d'accès à un fichier contenant une définition de table JSON. Le format d'une définition intégrée est schema@format=uri.

--force ou -f

Si spécifié et qu'une ressource existe déjà, le code de sortie est 0. La valeur par défaut est false.

--label

Étiquette à appliquer à la table, au format [KEY]:[VALUE]. Répétez ce paramètre pour spécifier plusieurs étiquettes.

--params pr -p

Paramètres pour une configuration de transfert au format JSON : {"[PARAMETER]":"[VALUE]"}. Les paramètres varient en fonction de la source de données. Pour plus d'informations, consultez la page Présentation du service de transfert de données BigQuery.

--refresh_window_days

Entier spécifiant la fenêtre d'actualisation pour une configuration de transfert en jours. La valeur par défaut est 0.

--require_partition_filter

Si spécifié, cet indicateur détermine s'il est nécessaire de recourir à un filtre de partition pour exécuter les requêtes sur la table fournie. Cet indicateur ne s'applique qu'aux tables partitionnées. La valeur par défaut est true.

--schema

Chemin d'accès à un fichier de schéma JSON local ou à une liste de définitions de colonnes séparées par des virgules au format [FIELD]:[DATA_TYPE],[FIELD]:[DATA_TYPE]. La valeur par défaut est ''.

--start_time

Horodatage qui spécifie l'heure de début d'une plage d'exécutions de transferts. Le format de l'horodatage est le suivant : RFC3339 UTC "Zulu".

--table ou -t

Si spécifié, crée une table. La valeur par défaut est false.

--target_dataset

Ensemble de données cible pour une configuration de transfert. La valeur par défaut est ''.

--time_partitioning_expiration

Entier qui spécifie (en secondes) le moment où une partition temporelle doit être supprimée. Le délai d'expiration correspond à la date UTC de la partition plus la valeur entière. Un nombre négatif indique l'absence de délai d'expiration.

--time_partitioning_field

Champ utilisé pour déterminer comment créer une partition temporelle. Si le partitionnement temporel est activé sans cette valeur, la table est partitionnée en fonction de l'heure de chargement.

--time_partitioning_type

Active le partitionnement temporel sur une table et définit le type de partition. Actuellement, la seule valeur possible est DAY qui génère une partition par jour.

--transfer_config

Si spécifié, crée une configuration de transfert. Lorsque vous utilisez cet indicateur, vous devez également spécifier les paramètres suivants : --data_source, --display_name, --target_dataset et --params. Les options pour --params varient en fonction de la valeur data_source spécifique. La valeur par défaut est false.

--transfer_run

Si spécifié, crée des exécutions de transferts pour une période donnée. La valeur par défaut est false.

--use_legacy_sql

Lorsque ce paramètre est défini sur false, il utilise une requête SQL standard pour créer une vue. La valeur par défaut est true (utilise l'ancien SQL).

--view

Si spécifié, crée une vue. La valeur par défaut est ''.

--view_udf_resource

URI Cloud Storage ou chemin d'accès à un fichier de code local chargé et évalué immédiatement en tant que ressource de fonction définie par l'utilisateur utilisée par la requête SQL d'une vue. Répétez ce paramètre pour spécifier plusieurs fichiers.

bq mkdef

La commande mkdef crée une définition de table au format JSON pour les données stockées dans Google Cloud Storage ou Google Drive.

Pour plus d'informations sur l'utilisation de la commande mkdef, consultez la page Créer un fichier de définition de table pour une source de données externe.

La commande mkdef utilise les indicateurs spécifiques à la commande suivants :

--autodetect
Si spécifié, permet d'utiliser la détection automatique de schéma pour les données CSV et JSON.
--ignore_unknown_values ou -i
Si spécifié, permet d'ignorer les valeurs d'une ligne qui ne sont pas présentes dans le schéma.
--source_format
Format des données source. Les valeurs possibles sont les suivantes :
  • CSV
  • NEWLINE_DELIMITED_JSON
  • AVRO
  • DATASTORE_BACKUP
  • GOOGLE_SHEETS La valeur par défaut est CSV.

bq partition

La commande partition permet de convertir les tables nommées par date (se terminant par [AAAAmmjj]) en tables partitionnées.

Pour plus d'informations sur l'utilisation de la commande partition, consultez la page Convertir des tables segmentées par date en tables partitionnées par temps d'ingestion.

La commande partition utilise les indicateurs spécifiques à la commande suivants :

--no_clobber ou -n
Si spécifié, ne remplace pas une partition existante. La valeur par défaut est false.
--time_partitioning_expiration
Entier qui spécifie (en secondes) le moment où une partition temporelle doit être supprimée. Le délai d'expiration correspond à la date UTC de la partition plus la valeur entière. Un nombre négatif indique l'absence de délai d'expiration.
--time_partitioning_type
Active le partitionnement temporel sur une table et définit le type de partition. Actuellement, la seule valeur possible est DAY qui génère une partition par jour.

bq query

La commande query crée une tâche de requête qui exécute la requête SQL fournie.

Pour plus d'informations sur l'utilisation de la commande query, consultez la page Exécuter des requêtes interactives et par lot.

La commande query utilise les indicateurs spécifiques à la commande suivants :

--allow_large_results
Si spécifié, active des tailles de tables de destination importantes pour les requêtes en ancien SQL.
--append_table
Si spécifié, ajoute des données à une table de destination. La valeur par défaut est false.
--batch
Si spécifié, exécute la requête en mode de traitement par lot. La valeur par défaut est false.
--clustering_fields
Si spécifié, une liste de colonnes séparées par des virgules permet de mettre la table de destination en cluster dans une requête. Cet indicateur doit être utilisé avec les indicateurs de partitionnement temporel pour créer une table partitionnée par date d'ingestion ou une table partitionnée sur une colonne DATE ou TIMESTAMP. Si spécifié, la table est d'abord partitionnée, puis mise en cluster à l'aide des colonnes fournies.
--destination_kms_key
Clé Cloud KMS utilisée pour chiffrer les données de la table de destination.
--destination_schema
Chemin d'accès à un fichier de schéma JSON local ou à une liste de définitions de colonnes séparées par des virgules au format [FIELD]:[DATA_TYPE],[FIELD]:[DATA_TYPE]. La valeur par défaut est ''.
--destination_table
Nom de la table de destination pour l'écriture des résultats de la requête. La valeur par défaut est ''.
--dry_run
Si spécifié, la requête est validée, mais pas exécutée.
--external_table_definition
Nom de table et définition de schéma utilisés dans une requête de table externe. Le schéma peut être un chemin d'accès à un fichier de schéma JSON local ou à une liste de définitions de colonnes séparées par des virgules au format [FIELD]:[DATA_TYPE],[FIELD]:[DATA_TYPE]. Le format de définition du nom et du schéma de la table est le suivant : [TABLE]::[PATH_TO_FILE] ou [TABLE]::[SCHEMA]@[SOURCE_FORMAT]=[CLOUD_STORAGE_URI]. Répétez cet indicateur pour interroger plusieurs tables.
--flatten_results
Si spécifié, aplatit les champs imbriqués et répétés dans les résultats des requêtes en ancien SQL existantes. La valeur par défaut est true.
--label
Étiquette à appliquer à une tâche de requête au format [KEY]:[VALUE]. Répétez ce paramètre pour spécifier plusieurs étiquettes.
--max_rows ou -n
Entier indiquant le nombre de lignes à renvoyer dans les résultats de la requête. La valeur par défaut est 100.
--maximum_bytes_billed
Entier qui limite le nombre d'octets facturés pour la requête. Si la requête dépasse la limite, elle échoue (sans frais). Si le paramètre n'est pas spécifié, le nombre d'octets facturés est défini sur la valeur par défaut du projet.
--min_completion_ratio
[Expérimental] Nombre compris entre 0 et 1.0 qui spécifie la fraction minimale de données à analyser avant le renvoi d'une requête. Si non défini, la valeur de serveur par défaut 1.0 est utilisée.
--parameter
Fichier JSON contenant une liste de paramètres de requête, ou paramètre de requête au format [NAME]:[TYPE]:[VALUE]. Un nom vide crée un paramètre positionnel. Le paramètre [TYPE] peut être omis pour suggérer une valeur STRING au format name::value ou ::value. Le paramètre NULL génère une valeur nulle. Répétez cet indicateur pour spécifier plusieurs paramètres.
--replace
Si spécifié, remplace la table de destination par les résultats de la requête. La valeur par défaut est false.
--require_cache
Si spécifié, n'exécute la requête que si les résultats peuvent être récupérés du cache.
--require_partition_filter
Si spécifié, un filtre de partition est nécessaire pour exécuter des requêtes sur la table fournie. Cet indicateur ne peut être utilisé qu'avec une table partitionnée.
--rpc
Si spécifié, utilisez l'API de requête de style RPC à la place de la méthode jobs.insert de l'API REST. La valeur par défaut est false.
--schema_update_option

Lorsque vous ajoutez des données à une table (dans une tâche de chargement ou de requête) ou que vous remplacez une partition de table, spécifie comment mettre à jour le schéma de la table de destination. Les valeurs possibles sont les suivantes :

  • ALLOW_FIELD_ADDITION : Autoriser l'ajout de nouveaux champs
  • ALLOW_FIELD_RELAXATION : Autoriser l'assouplissement des champs REQUIRED sur NULLABLE

Répétez cet indicateur pour spécifier plusieurs options de mise à jour de schéma.

--start_row ou -s

Entier spécifiant la première ligne à renvoyer dans le résultat de la requête. La valeur par défaut est 0.

--time_partitioning_expiration

Entier qui spécifie (en secondes) le moment où une partition temporelle doit être supprimée. Le délai d'expiration correspond à la date UTC de la partition plus la valeur entière. Un nombre négatif indique l'absence de délai d'expiration.

--time_partitioning_field

Champ utilisé pour déterminer comment créer une partition temporelle. Si le partitionnement temporel est activé sans cette valeur, la table est partitionnée en fonction de l'heure de chargement.

--time_partitioning_type

Active le partitionnement temporel sur une table et définit le type de partition. Actuellement, la seule valeur possible est DAY qui génère une partition par jour.

--udf_resource

Cet indicateur ne s'applique qu'aux requêtes en ancien SQL. Lorsqu'il est spécifié, il s'agit de l'URI Cloud Storage ou du chemin d'accès à un fichier de code local chargé et évalué immédiatement en tant que ressource de fonction définie par l'utilisateur, employée par une requête en ancien SQL. Répétez ce paramètre pour spécifier plusieurs fichiers.

--use_cache

Si spécifié, met en cache les résultats de la requête. La valeur par défaut est true.

--use_legacy_sql

Si défini sur false, exécute une requête SQL standard. La valeur par défaut est true (utilise l'ancien SQL).

bq rm

La commande rm supprime un ensemble de données, une table, une vue, un modèle ou une configuration de transfert.

Pour plus d'informations sur l'utilisation de la commande rm, consultez les pages suivantes :

La commande rm utilise les indicateurs spécifiques à la commande suivants :

--dataset ou -d
Si spécifié, supprime un ensemble de données. La valeur par défaut est false.
--force ou -f
Si spécifié, supprime une table, une vue, un modèle ou un ensemble de données sans affichage d'une invite. La valeur par défaut est false.
--model ou -m
Si spécifié, supprime un modèle BigQuery ML.
--recursive ou -r
Si spécifié, supprime un ensemble de données et toutes les tables, les données de table ou les modèles qu'il contient. La valeur par défaut est false.
--table ou -t
Si spécifié, supprime une table. La valeur par défaut est false.
--transfer_config
Si spécifié, supprime une configuration de transfert. La valeur par défaut est false.

bq show

La commande show affiche les informations relatives à un objet.

Pour plus d'informations sur l'utilisation de la commande show, consultez les pages suivantes :

La commande show utilise les indicateurs spécifiques à la commande suivants :

--dataset ou -d
Si spécifié, affiche les informations relatives à un ensemble de données. La valeur par défaut est false.
--encryption_service_account
Si spécifié, affiche le compte de service d'un utilisateur s'il existe ou en crée un. La valeur par défaut est false.
--job ou -j
Si spécifié, affiche les informations relatives à une tâche. La valeur par défaut est false.
--model ou -m
Si spécifié, affiche les informations relatives à un modèle BigQuery ML.
--schema
Si spécifié, n'affiche que le schéma de la table. La valeur par défaut est false.
--transfer_config
Si spécifié, affiche les informations relatives à une configuration de transfert. La valeur par défaut est false.
--transfer_run
Si spécifié, affiche les informations relatives à une exécution de transfert. La valeur par défaut est false.
--view
Si spécifié, affiche les informations relatives à une vue. La valeur par défaut est false.

bq update

La commande update met à jour une configuration d'ensemble de données, de table, de vue, de modèle ou de transfert.

Pour plus d'informations sur l'utilisation de la commande update, consultez les pages suivantes :

La commande update utilise les indicateurs spécifiques à la commande suivants :

--clear_label
Supprime une étiquette au format [KEY]:. Répétez cet indicateur pour supprimer plusieurs étiquettes.
--dataset ou -d
Met à jour un ensemble de données. La valeur par défaut est false.
--default_partition_expiration

Entier spécifiant le délai d'expiration par défaut en secondes pour toutes les partitions des tables partitionnées nouvellement créées dans l'ensemble de données. Aucune valeur minimale n'est définie pour cet indicateur.

Le délai d'expiration d'une partition est défini sur la date UTC de la partition plus la valeur entière. Si cette propriété est définie, elle remplace le délai expiration de la table par défaut au niveau de l'ensemble de données, s'il existe. Si vous spécifiez l'indicateur --time_partitioning_expiration lors de la création ou de la mise à jour d'une table partitionnée, le délai d'expiration des partitions défini au niveau de la table est prioritaire sur le délai d'expiration des partitions défini par défaut au niveau de l'ensemble de données. Spécifiez la valeur 0 pour supprimer un délai d'expiration existant.

--default_table_expiration

Entier qui met à jour la durée de vie par défaut en secondes des tables nouvellement créées dans un ensemble de données. Le délai d'expiration correspond à l'heure UTC actuelle plus la valeur entière. Spécifiez la valeur 0 pour supprimer le délai d'expiration existant.

--description

Met à jour la description d'un ensemble de données, d'une table, d'un modèle ou d'une vue.

--display_name

Met à jour le nom à afficher pour une configuration de transfert. La valeur par défaut est ''.

--etag

Ne met à jour les ressources que si les ETag correspondent.

--expiration

Entier qui met à jour le délai d'expiration en secondes d'une table, d'une vue ou d'un modèle. Spécifiez la valeur 0 pour supprimer le délai d'expiration.

--external_table_definition

Met à jour une table externe avec la définition de table spécifiée. Le schéma peut être un chemin d'accès à un fichier de schéma JSON local ou à une liste de définitions de colonnes séparées par des virgules au format [FIELD]:[DATA_TYPE],[FIELD]:[DATA_TYPE]. Le format de définition du nom et du schéma de la table est le suivant : [TABLE]::[PATH_TO_FILE] ou [TABLE]::[SCHEMA]@[SOURCE_FORMAT]=[CLOUD_STORAGE_URI].

--model ou -m

Met à jour les métadonnées d'un modèle BigQuery ML.

--params ou -p

Met à jour les paramètres d'une configuration de transfert au format JSON : {"[PARAMETER]":"[VALUE]"}. Les paramètres varient en fonction de la source de données. Pour plus d'informations, consultez la page Présentation du service de transfert de données BigQuery.

--refresh_window_days

Entier spécifiant une fenêtre d'actualisation en jours pour une configuration de transfert.

--schema

Chemin d'accès à un fichier de schéma JSON local ou à une liste de définitions de colonnes séparées par des virgules au format [FIELD]:[DATA_TYPE],[FIELD]:[DATA_TYPE]. La valeur par défaut est ''.

--set_label

Étiquette à mettre à jour au format [KEY]:[VALUE]. Répétez cet indicateur pour mettre à jour plusieurs étiquettes.

--source

Chemin d'accès à un fichier JSON local contenant une charge utile utilisée pour mettre à jour une ressource. Par exemple, cet indicateur permet de spécifier un fichier JSON contenant une ressource d'ensemble de données avec une propriété access mise à jour. Le fichier est utilisé pour remplacer les contrôles d'accès de l'ensemble de données.

--table ou -t

Si spécifié, met à jour une table. La valeur par défaut est false.

--target_dataset

Si spécifié, met à jour l'ensemble de données cible pour une configuration de transfert. La valeur par défaut est ''.

--time_partitioning_expiration

Entier mis à jour en secondes lorsqu'une partition temporelle doit être supprimée. Le délai d'expiration correspond à la date UTC de la partition plus la valeur entière. Un nombre négatif indique l'absence de délai d'expiration.

--time_partitioning_field

Met à jour le champ utilisé pour déterminer comment créer une partition temporelle. Si le partitionnement temporel est activé sans cette valeur, la table est partitionnée en fonction du temps de chargement.

--time_partitioning_type

Met à jour le type de partitionnement temporel pour une table. Actuellement, la seule valeur possible est DAY, qui génère une partition par jour.

--transfer_config

Si spécifié, met à jour une configuration de transfert. La valeur par défaut est false.

--update_credentials

Si spécifié, met à jour les identifiants de la configuration de transfert. La valeur par défaut est false.

--use_legacy_sql

Si défini sur false, convertit la requête SQL d'une vue générée en ancien SQL en SQL standard. La valeur par défaut est true (utilise l'ancien SQL).

--view

Si spécifié, met à jour la requête SQL d'une vue. La valeur par défaut est ''.

--view_udf_resource

Met à jour l'URI Cloud Storage ou le chemin d'accès à un fichier de code local chargé et évalué immédiatement en tant que ressource de fonction définie par l'utilisateur dans une requête SQL d'une vue. Répétez ce paramètre pour spécifier plusieurs fichiers.

bq wait

La commande wait permet d'attendre un certain nombre de secondes qu'une tâche se termine.

La commande wait utilise l'indicateur global --job_id et les indicateurs spécifiques à la commande suivants :

[INTEGER]
Valeur entière >= 0 spécifiant le temps d'attente. Cette valeur n'est pas un indicateur. Vous indiquez l'entier sur la ligne de commande. Si vous spécifiez la valeur 0, la commande vérifie si la tâche est terminée et affiche immédiatement le résultat. Si vous ne spécifiez pas de valeur entière, la commande attend indéfiniment.
--fail_on_error
Si spécifié, quitte sur un message d'erreur si la tâche est toujours en cours d'exécution ou s'est terminée en échec. La valeur par défaut est true.
--wait_for_status

Si spécifié, attend un état particulier de la tâche avant de quitter. Les valeurs possibles sont les suivantes :

  • PENDING
  • RUNNING
  • DONE

La valeur par défaut est DONE.

Cette page vous a-t-elle été utile ? Évaluez-la :

Envoyer des commentaires concernant…

Besoin d'aide ? Consultez notre page d'assistance.