Referencia de la herramienta de línea de comandos de bq
En este documento, se describe la sintaxis, los comandos, las marcas y los argumentos para bq, la herramienta de línea de comandos de BigQuery.
Está destinado a usuarios que estén familiarizados con BigQuery, pero que
quieran saber cómo usar un comando particular de la herramienta de línea de comandos de bq.
Para obtener información general sobre cómo usar la herramienta de línea de comandos de bq, consulta
Usa la herramienta de línea de comandos de bq.
Sinopsis
La herramienta de línea de comandos de bq usa el siguiente formato:
bq COMMAND [FLAGS] [ARGUMENTS]
Algunas marcas pueden usarse con varios comandos de la herramienta de línea de comandos de bq. Estas marcas se describen en la sección Marcas globales.
Otras marcas son específicas del comando, solo se pueden usar con un comando de herramienta de línea de comandos de bq en particular. Las marcas específicas de comandos se describen en las secciones de comandos.
Marcas booleanas
Algunas marcas de herramientas de línea de comandos de bq son booleanas. Puedes configurar el valor de la marca como
true o false.
La herramienta de línea de comandos de bq acepta los siguientes formatos para configurar marcas booleanas.
| Valor | Formato | Ejemplo |
|---|---|---|
true |
--FLAGNAME=true |
--debug_mode=true |
true |
--FLAGNAME |
--debug_mode |
false |
--FLAGNAME=false |
--debug_mode=false |
false |
--noFLAGNAME |
--nodebug_mode |
En este documento, se usa el formato --FLAGNAME=VALUE para marcas booleanas.
Todas las marcas booleanas son opcionales. Si no hay una marca, BigQuery usa el valor predeterminado de la marca.
Especifica valores para marcas
Cuando especificas un valor para una marca, el signo igual (=) es opcional. Por ejemplo, los siguientes dos comandos son equivalentes:
bq ls --format prettyjson myDataset bq ls --format=prettyjson myDataset
En este documento, se usa el signo igual para brindar mayor claridad.
Ayuda en línea
La documentación está disponible en la herramienta de línea de comandos de bq, de la siguiente manera:
| Descripción | Formato del comando de ayuda | Ejemplo |
|---|---|---|
| Lista de todos los comandos con ejemplos | bq help |
bq help |
| Descripción de las marcas globales | bq --help |
bq --help |
| Descripción de un comando en particular | bq help COMMAND |
bq help mk |
Especificación de recursos
El formato para especificar un recurso depende del contexto. En algunos casos, el separador entre el proyecto y el conjunto de datos es de dos puntos (:) y, en otros casos, un punto (.). En la siguiente tabla, se describe cómo especificar una tabla de BigQuery en diferentes contextos.
| Context | <
|---|