LookML bearbeiten und validieren

IDE verwenden

Die integrierte Entwicklungsumgebung (IDE) von Looker bietet verschiedene Funktionen zum Schreiben von LookML.

Automatische Vorschläge

Während der Eingabe werden in der IDE mögliche Parameter und Werte vorgeschlagen, die für den eingegebenen Text sensibel sind. So beziehen sich die Vorschläge für den type-Parameter einer Dimension nur auf gültige Optionen für diesen Parameter. Außerdem müssen Felder in sql-Parametern mit ${...} gekennzeichnet werden. Die IDE fügt diese Syntax beim Vorschlagen von Feldern hinzu.

Automatische Vorschläge werden automatisch angezeigt, sofern sie angezeigt werden können. Drücken Sie zum Schließen die Esc-Taste auf Ihrer Tastatur. Drücken Sie Strg + Leertaste (Windows) bzw. Strg-Taste (Mac), um ihn aufzurufen.

Ad-hoc-Fehlerprüfung

Die IDE erfasst während der Eingabe Syntaxfehler. Ein rotes X im Bund 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 statt average als Wert des Parameters type für eine Messung 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. eine ungültige Feldreferenz aufgrund eines fehlenden Joins, erfordern einen ganzheitlichen Blick auf das Modell. Sie werden daher nur angezeigt, wenn der LookML-Validator ausgeführt wird.

Soforthilfe-Bereich

Klicken Sie auf das Symbol Schnellhilfe, um den Bereich Schnellhilfe zu öffnen. Er enthält Erläuterungen und Optionen für den aktuellen Standort im Code. Wählen Sie einen Parameternamen in der Seitenleiste aus, um die Looker-Dokumentationsseite für diesen Parameter zu öffnen.

Automatische Formatierung

Im Entwicklermodus können Sie die Tastenkombinationen für die Dateidatei verwenden, um die LookML-Datei automatisch einrücken zu lassen. Der Einzug gibt die Hierarchie der Parameter und Unterparameter an, die LookML leichter lesbar und verständlich ist.

Faltbar

Ein kleiner Pfeil erscheint im Bundsteg neben dem Anfang jedes übergeordneten LookML-Parameters in der Datei. Mit diesem Pfeil lässt sich der entsprechende Abschnitt von LookML ein- bzw. ausblenden, sodass Sie sich nur auf bestimmte Abschnitte konzentrieren können.

Das Menü Dateiaktionen anzeigen für die LookML-Datei enthält auch die Optionen Fold LookML und Unfold LookML, um alle LookML-Abschnitte auf den Parameter der obersten Ebene in der aktuellen Datei zu maximieren oder zu minimieren.

Sie können LookML auch mithilfe von Tastenkombinationen aus- bzw. einblenden.

Hinzufügen, Ändern und Löschen von Markierungen

In der LookML-IDE werden immer mehrere Indikatoren angezeigt, wenn Sie sich im Entwicklungsmodus befinden und nicht zugeteilte Änderungen haben.

  • Der Dateiname wird mit einem blauen Punkt auf der linken Seite angezeigt. Das bedeutet, dass die Datei neu ist, geändert oder umbenannt wurde.
  • Wenn Sie eine neue oder geänderte Datei öffnen, werden die Zeilennummern in der Datei grün markiert, um neue oder geänderte Zeilen anzuzeigen, und eine horizontale rote Linie zeigt entfernte Zeilen an.

Kommentare hinzufügen

Sie können in LookML Kommentare hinzufügen, um die Lesbarkeit zu verbessern. Wenn du einen einzelnen Kommentar hinzufügen möchtest, verwende das Zeichen #:

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

Mit Tastenkombinationen können Sie einen gesamten Codeblock kommentieren:

  1. Wählen Sie die Zeilen aus, die Sie kommentieren möchten.
  2. Drücken Sie ⌘ + # auf einem Mac oder Strg + # auf einem Windows-Computer.

Die IDE fügt jeder ausgewählten Zeile das Zeichen # hinzu.

SQL-Blöcke auskommentieren

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

Wenn Sie den SQL-Kommentarblock verwenden, werden die auskommentierten Abschnitte trotzdem als LookML-Code interpretiert. Sie sehen daher Ihre Kommentare in der von LookML generierten SQL-Abfrage, die Kommentare wirken sich jedoch nicht auf die Abfrageergebnisse aus.

Zu Objekt oder Datei springen

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

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

Text in Ihrem Projekt suchen und ersetzen

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

So verwenden Sie die Looker-IDE-Funktion:

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

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

  1. Geben Sie den gewünschten Text in das Feld Ersetzen durch ein. Sie können 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 herauszufinden, wie der Text in Ihrem Projekt ersetzt werden würde.

  3. In den Ergebnissen werden alle Instanzen in Ihrem Projekt als Ersatz markiert. Mit den folgenden Optionen können Sie anpassen, welche Instanzen ersetzt werden:

    • Klicken Sie auf 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 sie auszuwählen oder die Auswahl aufzuheben.
  4. Klicken Sie auf die Schaltfläche Auswahl ersetzen, um die Ersetzung auf die ausgewählten Instanzen anzuwenden. Die IDE zeigt die vorgenommenen Änderungen an.

Neue Felder erstellen und testen

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

Dimension erstellen

Wir fügen unserer users-Ansicht eine neue Dimension hinzu, mit der festgelegt wird, ob ein Nutzer aus Kalifornien oder New York stammt. Die Dimension ist type: yesno, was bedeutet, dass der Wert Yes angezeigt wird, wenn der Nutzer aus Kalifornien oder New York stammt, und No, wenn nicht.

LookML 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 Datei user hinzu und klicken Sie dann auf die Schaltfläche Änderungen speichern in der Datei.

Weitere Informationen zu ${TABLE}.state finden Sie unter Substitutionsoperatoren.

Messung erstellen

Als Nächstes fügen wir der Ansicht „user“ eine neue Messung hinzu, die das durchschnittliche Alter unserer Nutzer darstellt. Die Messung ist type: average und wird über der Spalte age zusammengefasst.

Das LookML für diese neue Messung sieht so aus:

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

Fügen Sie dieses Maß der Datei user hinzu und klicken Sie dann auf die Schaltfläche Änderungen speichern in der Datei.

Felder in der Funktion „Erkunden“ testen

Sie können die neue Dimension testen und entsprechende Messungen durchführen. Nachdem Sie die Änderungen gespeichert haben, werden diese Felder in der Feldauswahl der Funktion „Erkunden“ angezeigt. Über das Drop-down-Menü Dateiaktionen anzeigen neben dem Dateinamen der Ansicht können Sie ganz einfach auf das Symbol „Erkunden“ für die aktuelle Ansicht zugreifen. Im Drop-down-Menü Dateiaktionen ansehen sind alle explorativen Datenanalysen zu sehen, die auf der Ansicht basieren, einschließlich der explorativen Datenanalysen, mit denen die Ansicht verknüpft ist. Wenn Sie beispielsweise auf die Schaltfläche „Erkunden“ für eine Ansicht mit dem Namen users zugreifen möchten, können Sie im Drop-down-Menü Dateiaktionen ansehen die Option Nutzer ansehen auswählen.

Im explorativen Analysetool unter Nutzer können Sie die neuen Felder auswählen, um sie einer Abfrage hinzuzufügen. Sie können beispielsweise eine Abfrage mit beiden neuen Feldern erstellen, die das durchschnittliche Alter von Nutzern aus Kalifornien und New York und das durchschnittliche Alter von Nutzern anzeigen, die nicht:

Datentabelle für ein Beispiel mit den Feldern „Nutzer ansehen“ und den Feldern „Nutzer aus Kalifornien“ oder „New York“ und „Durchschnittliches Nutzeralter“.

LookML validieren

Wenn Sie mit Ihren Änderungen zufrieden sind, können Sie Ihre Änderungen speichern. Die IDE benachrichtigt Sie über nicht behobene Syntaxfehler in einer einzelnen Datei.

Führen Sie als Nächstes den LookML-Validator aus, um eine vollständige Modellvalidierung durchzuführen. Einige Fehler, z. B. eine ungültige Feldreferenz aufgrund eines fehlenden Joins, erfordern einen ganzheitlichen Blick auf das Modell. Sie werden daher nur angezeigt, wenn der LookML-Validator ausgeführt wird. Prüfen Sie Ihre LookML-Änderungen, bevor Sie sie in der Produktionsumgebung veröffentlichen. Die Validierung erkennt zwar nicht alle Probleme, z. B. Probleme mit Datenbankberechtigungen, jedoch die meisten Fehler.

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, bei denen sie verwendet wird, noch einmal validiert.
  • Wenn sich ein exploratives Analysetool ändert, wird nur dieses explorative Analysetool noch einmal validiert.

Validierung wird ausgeführt

Klicken Sie zum Ausführen des LookML-Validators rechts oben in der Looker-IDE auf die Schaltfläche LookML überprüfen. Sie können auch oben auf der IDE auf das Symbol Projektstatus klicken, um den Bereich Projektstatus zu öffnen, und dann auf LookML validieren.

Nachdem Sie den LookML Validator ausgeführt haben, werden möglicherweise eine Liste von 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 maximieren.

Die Schaltfläche zum Validieren im Bereich Projektstatus ist wieder verfügbar, wenn Sie eine weitere Änderung vornehmen und speichern.

Validierungsnachrichten

Nach der Ausführung der Validierung in LookML werden in Looker Validierungsmeldungen angezeigt.

Keine LookML-Fehler gefunden

Wenn beim Validator keine Probleme gefunden werden, wird in Looker ein grünes Häkchen neben Keine LookML-Fehler gefunden angezeigt.

LookML-Fehler

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

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

In der maximierten Liste der Probleme wird angezeigt, warum die Überprüfung nicht bestanden wurde. Wenn Sie auf den Fehler klicken, werden Sie oft direkt zur Problemzeile des Codes weitergeleitet. Neben der Zeile wird ein rotes „X“ angezeigt. Wenn Sie den Mauszeiger darauf bewegen, werden in einigen Fällen ausführlichere Fehlerinformationen angezeigt:

Beispiel für einen Fehler, bei dem der Mauszeiger auf eine Parameterparameterdefinition ohne Wert mit einem Fehlertext erscheint, der angibt, dass Sie einen Wert für den Typ angeben müssen.

Tipp für den Chatteam: Der am häufigsten genannte Validierungsfehler ist „Unbekannt oder nicht zugänglich“. Rufen Sie die Seite Fehler: Unbekanntes oder nicht zugängliches Feld auf: Best Practices für die Ursachen und Maßnahmen zur Fehlerbehebung.

LookML-Warnungen

LookML-Warnungen verhindern zwar nicht die Ausführung einer Abfrage, können Ihren Nutzern jedoch trotzdem fehlerhafte oder unbeabsichtigte Funktionen zur Verfügung stellen. Wie bei Fehlern ist die Zahl in Klammern die Anzahl der gefundenen Warnungen (im folgenden Beispiel drei Warnungen):

Beispiel für eine Validierungsnachricht mit dem Text LookML Warnings (3)

Genau wie bei LookML-Fehlern können Sie die Warnungen maximieren und zum Problemcode springen, indem Sie die Warnung im Bereich Projektstatus auswählen und dann den Mauszeiger auf das rote X bewegen, um weitere Informationen zu sehen:

Beispiel für eine Warnung mit einem Text, der darauf hinweist, dass das Explore-Objekt mit einem Ansichtsnamen übereinstimmen muss oder dass das Explore-Objekt die Property „from“ oder „view_name“ haben muss

Änderungen bereitstellen

Nachdem Sie überprüft haben, ob Ihre Änderungen richtig funktionieren, können Sie sie mithilfe der Git-Integration von Looker Commit durchführen und in der Produktion bereitstellen.