Referenz zum bq-Befehlszeilentool
In diesem Dokument werden die Syntax, Befehle, Flags und Argumente für das BigQuery-Befehlszeilentool bq
beschrieben.
Es richtet sich an Nutzer, die mit BigQuery vertraut sind, aber wissen möchten, wie ein bestimmter Befehl des bq-Befehlszeilentools verwendet wird.
Allgemeine Informationen zur Verwendung des bq-Befehlszeilentools finden Sie unter bq-Befehlszeilentool verwenden.
Zusammenfassung
Das bq-Befehlszeilentool hat das folgende Format:
bq COMMAND [FLAGS] [ARGUMENTS]
Einige Flags können mit mehreren Befehlen des bq-Befehlszeilentools verwendet werden. Diese Flags werden im Abschnitt Globale Flags beschrieben.
Andere Flags sind befehlsspezifisch – sie können nur mit einem bestimmten Befehl des bq-Befehlszeilentools verwendet werden. Die befehlsspezifischen Flags werden in den Befehlsabschnitten beschrieben.
Boolesche Flags
Einige Flags für das bq-Befehlszeilentool sind boolesch; Sie können den Wert des Flags auf true
oder false
setzen.
Das bq-Befehlszeilentool akzeptiert die folgenden Formate zum Festlegen von booleschen Flags.
Wert | Format | Beispiel |
---|---|---|
true |
--FLAGNAME=true |
--debug_mode=true |
true |
--FLAGNAME |
--debug_mode |
false |
--FLAGNAME=false |
--debug_mode=false |
false |
--noFLAGNAME |
--nodebug_mode |
In diesem Dokument wird für boolesche Flags das Format --FLAGNAME=VALUE
verwendet.
Alle booleschen Flags sind optional. Wenn kein boolesches Flag vorhanden ist, verwendet BigQuery den Standardwert des Flags.
Werte für Flags angeben
Wenn Sie einen Wert für ein Flag festlegen, ist das Gleichheitszeichen (=
) optional. Die folgenden beiden Befehle entsprechen beispielsweise einander:
bq ls --format prettyjson myDataset bq ls --format=prettyjson myDataset
In diesem Dokument wird zur Verdeutlichung das Gleichheitszeichen verwendet.
Onlinehilfe
Dokumentation im bq-Befehlszeilentool ist so verfügbar:
Beschreibung | Format des Hilfebefehls | Beispiel |
---|---|---|
Liste aller Befehle mit Beispielen | bq help |
bq help |
Beschreibung der globalen Flags | bq --help |
bq --help |
Beschreibung eines bestimmten Befehls | bq help COMMAND |
bq help mk |
Ressourcenspezifikation
Das Format für die Angabe einer Ressource hängt vom Kontext ab. In einigen Fällen ist das Trennzeichen zwischen Projekt und Dataset ein Doppelpunkt (:
) und in einigen Fällen ist es ein Punkt (.
). In der folgenden Tabelle wird beschrieben, wie Sie eine BigQuery-Tabelle in verschiedenen Kontexten angeben.
Kontext | Format | Beispiel |
---|---|---|
bq-Befehlszeilentool, also: Befehlszeilentool "bq" | PROJECT:DATASET.TABLE |
myProject:myDataset.myTable |
GoogleSQL-Abfrage | PROJECT.DATASET.TABLE |
myProject.myDataset.myTable |
Legacy-SQL-Abfrage | PROJECT:DATASET.TABLE |
myProject:myDataset.myTable |
Wenn Sie kein Projekt angeben, verwendet BigQuery das aktuelle Projekt. Wenn das aktuelle Projekt beispielsweise myProject
ist, interpretiert BigQuery myDataset.myTable
als myProject:myDataset.myTable
(oder myProject.myDataset.myTable
).
Einige Ressourcen-IDs müssen in Graviszeichen (`
) gesetzt werden. Wenn die Ressourcenkennzeichnung mit einem Buchstaben oder einem Unterstrich beginnt und nur Zeichen enthält, die aus Buchstaben, Ziffern und Unterstrichen bestehen, müssen Sie sie nicht hervorheben. Wenn Ihre Ressourcen-ID jedoch andere Zeichen oder reservierte Schlüsselwörter enthält, müssen Sie die ID (oder den Teil der ID mit den Sonderzeichen oder reservierten Schlüsselwörtern) mit Graviszeichen umschließen. Weitere Informationen finden Sie unter Kennungen.
Globale Flags
Sie können, falls zutreffend, die mit jedem bq
-Befehl die folgenden Flags verwenden:
--api=ENDPOINT
- Gibt den API-Endpunkt an, der aufgerufen werden soll. Der Standardwert ist
https://www.googleapis.com
. --api_version=VERSION
- Gibt die zu verwendende API-Version an. Der Standardwert ist
v2
. --apilog=FILE
Loggt alle API-Anfragen und -Antworten in der von
FILE
angegebenen Datei. Folgende Werte sind möglich:- Der Pfad zu einer Datei – Logs werden in der angegebene Datei erfasst
stdout
: API-Anfragen und -Antworten werden in der Standardausgabe geloggtstderr
: API-Anfragen und -Antworten werden im Standardfehler geloggtfalse
: API-Anfragen und -Antworten werden nicht geloggt (Standard)
--bigqueryrc=PATH
Gibt den Pfad zur Konfigurationsdatei des bq-Befehlszeilentools an. Wenn Sie das Flag
--bigqueryrc
nicht angeben, verwendet der Befehl die UmgebungsvariableBIGQUERYRC
. Wenn die Umgebungsvariable nicht festgelegt ist, wird$HOME/.bigqueryrc
verwendet. Wenn diese Datei nicht vorhanden ist, wird~/.bigqueryrc
verwendet. Weitere Informationen finden Sie unter Standardwerte für Befehlszeilen-Flags festlegen.--ca_certificates_file=PATH
Gibt den Speicherort der CA-Datei (Certificate Authority Service) an.
--dataset_id=DATASET_ID
Gibt das Standard-Dataset an, das mit dem Befehl verwendet werden soll. Dieses Flag wird ignoriert, wenn es nicht anwendbar ist. Sie können das Argument
DATASET_ID
im FormatPROJECT:DATASET
oderDATASET
angeben. Wenn der TeilPROJECT
fehlt, wird das Standardprojekt verwendet. Sie können die Standardprojekteinstellung durch Angabe des Flags--project_id
überschreiben.--debug_mode={true|false}
Wenn auf
true
festgelegt, werden Tracebacks für Python-Ausnahmen angezeigt. Der Standardwert istfalse
.--disable_ssl_validation={true|false}
Wenn auf
true
festgelegt, wird die HTTPS-Zertifikatsprüfung aktiviert. Der Standardwert istfalse
.--discovery_file=PATH
Gibt die JSON-Datei an, die für die Erkennung gelesen werden soll.
--enable_gdrive={true|false}
Wenn auf
false
festgelegt, wird ein neues OAuth-Token ohne Google Drive-Bereich angefordert. Der Standardwert isttrue
, mit dem ein neues OAuth-Token mit dem Drive-Bereich angefordert wird.--fingerprint_job_id={true|false}
Wenn Sie eine Job-ID verwenden möchten, die von einem Fingerabdruck der Jobkonfiguration abgeleitet wird, legen Sie
true
fest. Dadurch wird verhindert, dass derselbe Job versehentlich mehrmals ausgeführt wird. Der Standardwert istfalse
.--format=FORMAT
Gibt das Format der Ausgabe des Befehls an. Verwenden Sie einen der folgenden Werte:
pretty
: Formatierte Tabellenausgabesparse
: Einfachere Tabellenausgabeprettyjson
: Leicht lesbares JSON-Formatjson
: Maximal komprimiertes JSONcsv
: CSV-Format mit Header
pretty
,sparse
undprettyjson
sind für Menschen lesbar.json
undcsv
sind für die Verwendung durch ein anderes Programm vorgesehen. Wennnone
angegeben ist, erzeugt der Befehl keine Ausgabe. Wenn das Flag--format
fehlt, wird basierend auf dem Befehl ein geeignetes Ausgabeformat ausgewählt.--headless={true|false}
Legen Sie
true
fest, um diebq
-Sitzung ohne Nutzerinteraktion auszuführen. So wird beispielsweise der Debugger durchdebug_mode
nicht unterbrochen, und die Häufigkeit des Informationsdrucks verringert sich. Der Standardwert istfalse
.--httplib2_debuglevel=DEBUG_LEVEL
Gibt an, ob HTTP-Informationen zur Fehlerbehebung angezeigt werden sollen. Wenn
DEBUG_LEVEL
größer als0
ist, loggt der Befehl zusätzlich zu Fehlermeldungen HTTP-Serveranfragen und -Antworten an stderr. WennDEBUG_LEVEL
nicht > 0 ist oder wenn das Flag--httplib2_debuglevel
nicht verwendet wird, werden nur Fehlermeldungen angezeigt.Beispiel:
--httplib2_debuglevel=1
--job_id=<