LookML bearbeiten und validieren

IDE verwenden

Auf dieser Seite werden einige der Funktionen der Looker-IDE beschrieben, die Sie beim Schreiben von LookML-Codes unterstützen.

Sie können über das Looker-Menü Entwickeln auf die Looker IDE (integrierte Entwicklungsumgebung) zugreifen. Details und andere Optionen finden Sie unter Auf Projektdateien zugreifen.

Automatischer Vorschlag

Während der Eingabe schlägt die IDE mögliche Parameter und Werte vor, die für den Kontext Ihrer Eingabe empfindlich sind. Beispielsweise enthalten die Vorschläge für den Parameter type einer Dimension nur gültige Optionen für diesen Parameter. Außerdem müssen Felder in sql-Parametern mit ${...} markiert werden. Daher fügt die IDE diese Syntax hinzu, wenn Felder vorgeschlagen werden.

Automatische Vorschläge werden überall dort automatisch angezeigt, wo sie angezeigt werden können. Drücken Sie zum Schließen die Esc auf Ihrer Tastatur. Sie können den Ordner jederzeit aufrufen, indem Sie Strg+Leertaste (Windows) bzw. Strg+Leertaste (Mac) drücken.

Ad-hoc-Fehlerprüfung

Die IDE erkennt Syntaxfehler während der Eingabe. Ein rotes X im Bundsteg weist auf einen Syntaxfehler hin, der rot unterstrichen ist. Wenn Sie den Mauszeiger auf das rote X bewegen, wird eine kurze Beschreibung des Problems angezeigt. Wenn Sie beispielsweise versehentlich avrage anstelle von average als Wert des Parameters type für einen Messwert eingeben, zeigt die IDE den Fehler Invalid value for "type":avrage an.

Der LookML Validator ist weiterhin erforderlich, um eine vollständige Modellvalidierung durchzuführen. Einige Fehler, z. B. ein ungültiger Feldverweis aufgrund eines fehlenden Joins, erfordern eine ganzheitliche Betrachtung des Modells und werden daher nur angezeigt, wenn der LookML-Validator ausgeführt wird.

Soforthilfe-Bereich

Wählen Sie das Symbol Soforthilfe aus, um die Soforthilfe zu öffnen. Dort finden Sie Erläuterungen und Optionen für die aktuelle Position im Code. Wählen Sie in der Seitenleiste einen Parameternamen aus, um die Looker-Dokumentationsseite für diesen Parameter zu öffnen.

Automatische Formatierung

Wenn Sie sich im Entwicklungsmodus befinden, können Sie die Tastenkombination „Formatdatei“ verwenden, um Ihre LookML-Datei automatisch einzurücken. Die Einrückung zeigt die Hierarchie der Parameter und Unterparameter an, sodass Ihr LookML-Code leichter zu lesen und zu verstehen ist.

Zusammenklappbar

Im Bundsteg neben dem Anfang jedes LookML-Parameters der obersten Ebene in der Datei wird ein kleiner Pfeil angezeigt. Wenn Sie diesen Pfeil auswählen, wird der entsprechende Abschnitt in LookML aufgeklappt bzw. geöffnet, sodass Sie sich auf bestimmte Abschnitte konzentrieren können.

Das Menü „Dateiaktionen anzeigen“ für die LookML-Datei enthält auch die Optionen LookML aufklappen und LookML aufklappen, um alle LookML-Abschnitte bis zum Parameter auf oberster Ebene in der aktuellen Datei zu maximieren oder zu minimieren.

Sie können auch Tastenkombinationen verwenden, um LookML-Code zuzu- und ausklappen.

Ergänzungen, Änderungen und Löschungen markieren

In der LookML-IDE werden mehrere Indikatoren immer angezeigt, wenn Sie sich im Entwicklungsmodus befinden und Änderungen ohne Commit vorgenommen wurden.

  • Der Name der Datei wird mit einem blauen Punkt auf der linken Seite des Fensters angezeigt. Dies weist darauf hin, dass es sich um eine neue, geänderte oder umbenannte Datei handelt.
  • Wenn Sie eine neue oder geänderte Datei öffnen, werden die Zeilennummern in der Datei grün hervorgehoben, um neue oder geänderte Zeilen anzuzeigen. Eine horizontale rote Linie weist auf entfernte Zeilen hin.

Kommentare hinzufügen

Sie können Ihrem LookML-Code Kommentare hinzufügen, um ihn lesbarer zu machen. Verwenden Sie das Zeichen #, um einen einzelnen Kommentar hinzuzufügen:

dimension: name {
  sql: ${TABLE}.name ;; # This is the customer's full name
}

Mithilfe von Tastenkombinationen können Sie einen ganzen Codeblock auskommentieren. Gehen Sie dazu so vor:

  1. Wählen Sie die Zeilen aus, die Sie auskommentieren möchten.
  2. Drücken Sie Befehlstaste + / (Mac) oder Strg + / (Windows).

Die IDE fügt in jede ausgewählte Zeile das Zeichen # ein.

SQL-Blöcke auskommentieren

Wenn Sie Zeilen auskommentieren, die vollständig in einem SQL-Codeblock enthalten sind, fügen Sie die SQL-Kommentarnotation manuell hinzu.

Wenn Sie den SQL-Kommentarblock verwenden, werden die auskommentierten Abschnitte weiterhin als LookML-Code interpretiert. Daher werden die Kommentare in LookML-generiertem SQL angezeigt, aber sie haben keinen Einfluss auf die Abfrageergebnisse.

Zu Objekt oder Datei springen

In der Looker-IDE können Sie über die Funktion Zu Objekt oder Datei springen direkt zu LookML-Objekten und Projektdateien wechseln. Klicken Sie im Dateibrowser oder im Objektbrowser auf das Symbol Zu Objekt oder Datei springen. Alternativ können Sie die Tastenkombination Befehlstaste + J (Mac) oder Strg + J (Windows) verwenden.

Weitere Informationen finden Sie auf der Dokumentationsseite Auf LookML-Projektdateien zugreifen.

Text in Ihrem Projekt suchen und ersetzen

Die Looker-IDE hat eine Suchen-und-Ersetzen-Funktion, mit der Sie in allen Projektdateien nach Text suchen und dann alle Instanzen oder ausgewählten Instanzen in einem Bulk-Vorgang ersetzen können.

So verwenden Sie die Suchfunktion der Looker-IDE:

  1. Gehen Sie in der IDE zum Suchfeld.
  2. Geben Sie einen Begriff in das Feld Suchen ein.
  3. Sie können auch Groß-/Kleinschreibung beachten auswählen, um nur nach Instanzen zu suchen, die mit der im Feld Suchen eingegebenen Groß-/Kleinschreibung übereinstimmen. Oder wählen Sie RegEX aus, um eine Suche mit regulären Ausdrücken durchzuführen.
  4. Wählen Sie Suchen aus.
  5. Sie können auch einen Dateinamen auswählen, um die Datei in der IDE zu öffnen.

Wenn Sie sich im Entwicklungsmodus befinden, wird auch das Feld Ersetzen durch angezeigt. So ersetzen Sie Text in Ihrem Projekt:

  1. Geben Sie den Ersatztext in das Feld Ersetzen durch ein. Optional können Sie das Feld Ersetzen durch leer lassen, wenn Sie den Text im Feld Suchen löschen möchten, anstatt ihn zu ersetzen.

  2. Wählen Sie Auswählen und ersetzen aus, um in einer Vorschau zu sehen, wie der Text in Ihrem Projekt ersetzt wird.

  3. In den Ergebnissen werden alle Instanzen im Projekt zum Ersetzen hervorgehoben. Mit den folgenden Optionen können Sie anpassen, welche Instanzen ersetzt werden:

    • Verwenden Sie das Kästchen neben der Ergebniszusammenfassung, um alle Instanzen im gesamten Projekt auszuwählen oder die Auswahl aufzuheben.
    • Klicken Sie auf das Kästchen neben einer einzelnen Instanz, um diese Instanz auszuwählen oder ihre Auswahl aufzuheben.
  4. Klicken Sie auf die Schaltfläche Auswahl ersetzen, um die Ersetzung auf die ausgewählten Instanzen anzuwenden. In der IDE werden die vorgenommenen Änderungen angezeigt.

Neue Felder erstellen und testen

Als Beispiel für die Bearbeitung von LookML fügen wir mehrere Felder hinzu und testen sie dann.

Dimension erstellen

Zuerst fügen wir der Ansicht users eine neue Dimension hinzu, mit der ermittelt wird, ob ein Nutzer aus Kalifornien oder New York kommt. Die Dimension ist type: yesno und gibt Yes zurück, wenn der Nutzer aus Kalifornien oder New York stammt, und No, wenn nicht.

Der LookML-Code für unsere neue Dimension sieht so aus:

dimension: from_ca_or_ny {
  type: yesno
  sql: ${TABLE}.state = "California" OR ${TABLE}.state = "New York" ;;
}

Fügen Sie diese Dimension der Ansichtsdatei user hinzu und klicken Sie dann in der Datei auf die Schaltfläche Änderungen speichern.

Unter Substitutionsoperatoren finden Sie weitere Informationen zu ${TABLE}.state.

Messung erstellen

Als Nächstes fügen wir der Ansicht user eine neue Kennzahl für das durchschnittliche Alter der Nutzer hinzu. Diese Messung ist type: average und wird über die Spalte age aggregiert.

Der LookML-Code für diesen neuen Messwert sieht so aus:

measure: average_age {
  type: average
  sql: ${TABLE}.age ;;
}

Fügen Sie diese Messung der Ansichtsdatei user hinzu und klicken Sie dann in der Datei auf die Schaltfläche Änderungen speichern.

Felder im Explore testen

Sie können die neue Dimension testen und analysieren, indem Sie sie abfragen. Nachdem Sie Ihre Änderungen gespeichert haben, werden diese Felder im Field Picker im Explore angezeigt. Verwenden Sie das Drop-down-Menü Dateiaktionen anzeigen neben dem Dateinamen der Ansicht, um bequem auf das Explore für die aktuelle Ansicht zuzugreifen. Im Drop-down-Menü Dateiaktionen anzeigen werden alle Explores aufgelistet, die auf der Ansicht basieren, einschließlich Explores, mit denen die Ansicht verknüpft ist. Wenn Sie beispielsweise für eine Ansicht mit dem Namen users auf das Explore zugreifen möchten, können Sie im Drop-down-Menü Dateiaktionen ansehen die Option Explore-Nutzer auswählen.

Im Explore Nutzer können Sie die neuen Felder auswählen, um sie einer Abfrage hinzuzufügen. Sie können beispielsweise eine Abfrage mit den beiden neuen Feldern erstellen, die das Durchschnittsalter der Nutzer aus Kalifornien oder New York und das Durchschnittsalter der Nutzer anzeigt, die nicht:

Datentabelle für ein Beispiel für „Nutzer erkunden“ mit den ausgewählten Feldern „Nutzer aus Kanada“ oder „NY (Ja/Nein)“ und „Durchschnittliches Alter der Nutzer“.

LookML validieren

Wenn du mit den Änderungen zufrieden bist, kannst du deine Änderungen speichern. Die IDE warnt Sie auf alle nicht behobenen Syntaxfehler in einer einzelnen Datei.

Verwenden Sie als Nächstes den LookML-Validator, um eine vollständige Modellvalidierung durchzuführen. Einige Fehler, z. B. ein ungültiger Feldverweis aufgrund eines fehlenden Joins, erfordern eine ganzheitliche Betrachtung des Modells und werden daher nur angezeigt, wenn der LookML-Validator ausgeführt wird. Achten Sie darauf, Ihre LookML-Änderungen zu validieren, bevor Sie sie in der Produktionsumgebung veröffentlichen. Obwohl bei der Validierung nicht alle Probleme, wie z. B. Probleme mit Datenbankberechtigungen, erkannt werden, werden die meisten Fehler verhindert.

Der LookML Validator scannt nur LookML-Dateien, die seit der letzten LookML-Validierung aktualisiert wurden, oder Dateien, die von Aktualisierungen betroffen sind:

  • Wenn sich eine Einstellung auf Modellebene ändert, wird alles noch einmal validiert.
  • Wenn sich eine Ansicht ändert, werden nur die Explores, in denen sie verwendet wird, noch einmal validiert.
  • Ändert sich ein Explore, wird nur dieses Explore noch einmal validiert.

Validierung wird ausgeführt

Um den LookML-Validator auszuführen, wählen Sie oben rechts in der Looker-IDE die Schaltfläche LookML validieren aus oder oben in der IDE das Symbol Projektzustand, um den Bereich Projektzustand zu öffnen. Klicken Sie dann auf das Symbol LookML validieren.

Nachdem Sie den LookML-Validator ausgeführt haben, wird möglicherweise eine Liste mit Fehlern und anderen Warnungen angezeigt, die Sie beheben sollten. Sie können einen beliebigen Pfeil auswählen, um die Liste der Fehler oder Warnungen zu erweitern.

Die Schaltfläche für die Validierung im Bereich Projektzustand ist wieder verfügbar, wenn Sie eine weitere Änderung vornehmen und speichern.

Validierungsmeldungen

Looker zeigt nach der Validierung Ihres LookML-Codes Validierungsmeldungen an.

Keine LookML-Fehler gefunden

Wenn vom Validator keine Probleme gefunden werden, zeigt Looker ein grünes Häkchen zusammen mit dem Text Keine LookML-Fehler gefunden an.

LookML-Fehler

LookML-Fehler sind Probleme, die die Ausführung von Abfragen verhindern können. Die Zahl in Klammern ist die Anzahl der gefundenen Fehler (im folgenden Beispiel neun):

Beispiel für eine Validierungsnachricht mit dem Text LookML-Fehler (9).

In der erweiterten Liste der Probleme wird nun der Grund für das Fehlschlagen der Überprüfung angezeigt. Wenn Sie auf den Fehler klicken, gelangen Sie häufig direkt zur Problemzeile mit dem Code. Neben der Zeile wird ein rotes "X" angezeigt. Wenn Sie den Mauszeiger darauf bewegen, erhalten Sie in einigen Fällen detailliertere Fehlerinformationen:

Beispiel für einen Fehler, der angezeigt wird, wenn der Mauszeiger auf eine Typparameterdefinition ohne Wert bewegt wird. Der Fehlertext enthält einen Fehlertext, der angibt, dass Sie einen Wert für den Typ angeben müssen.

Tipp für das Google Chat-Team: Der am häufigsten gestellte Validierungsfehler lautet „Unbekanntes oder unzugängliches Feld“. Auf der Seite Fehler: Unbekanntes oder nicht zugängliches Feld mit Best Practices erfahren Sie mehr über die Ursachen und was Sie dagegen unternehmen können.

LookML-Warnungen

LookML-Warnungen verhindern möglicherweise nicht, dass eine Abfrage ausgeführt wird, aber sie können dennoch zu fehlerhaften oder unbeabsichtigten Funktionen für Ihre Benutzer führen. Wie bei den Fehlern steht die Zahl in Klammern für die Anzahl der gefundenen Warnungen (im folgenden Beispiel drei Warnungen):

Beispiel für eine Validierungsnachricht mit dem Text LookML-Warnungen (3).

Wie bei LookML-Fehlern können Sie Warnungen maximieren und zum Problemcode springen, indem Sie die Warnung im Bereich Project Health (Projektzustand) auswählen und dann den Mauszeiger auf das rote Symbol X bewegen, um weitere Informationen aufzurufen:

Beispiel für eine Warnung mit dem Text, dass das Explore mit einem Ansichtsnamen übereinstimmen oder dass das Explore eine „from“- oder „view_name“-Eigenschaft haben muss.

Änderungen bereitstellen

Nachdem Sie sich vergewissert haben, dass Ihre Änderungen ordnungsgemäß funktionieren, können Sie die Git-Integration von Looker verwenden, um Ihre Änderungen per Commit zu übertragen und für die Produktion bereitzustellen.