LookML bearbeiten und validieren

IDE verwenden

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

Automatisch vorschlagen

Während der Eingabe schlägt die IDE mögliche Parameter und Werte vor, die empfindlich auf den Kontext Ihrer Eingabe reagieren. Die Vorschläge für einen type-Parameter enthalten beispielsweise nur gültige Optionen für diesen Parameter. Felder in sql-Parametern müssen außerdem mit ${...} gekennzeichnet werden. Die IDE fügt diese Syntax beim Vorschlagen von Feldern hinzu.

Automatisch vorschlagen wird überall dort, wo es angezeigt werden kann. Drücken Sie zum Schließen auf der Tastatur die Esc-Taste. Sie können die Tastenkombination jederzeit aufrufen, indem Sie Strg + Leertaste (Windows) bzw. Strg + Leertaste (Mac) drücken.

Ad-hoc-Fehlerprüfung

Die IDE erkennt Syntaxfehler, während Sie tippen. 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.

Für eine vollständige Modellvalidierung ist nach wie vor der LookML Validator erforderlich. Einige Fehler, z. B. eine ungültige Feldreferenz aufgrund eines fehlenden Joins, erfordern einen ganzheitlichen Blick auf das Modell. Daher werden sie nur angezeigt, wenn der LookML-Validator ausgeführt wird.

Soforthilfe-Bereich

Klicken Sie auf das Informationssymbol, um den Bereich Hilfe zu öffnen. Dort finden Sie Erläuterungen und Optionen zur aktuellen Position im Code. Klicken Sie in der Seitenleiste auf einen Parameternamen, um die Looker-Dokumentationsseite für diesen Parameter zu öffnen.

Im Metadatenbereich können Sie sich auch kontextrelevante Informationen zu den Objekten im Metadatenbereich von Looker IDE ansehen. Weitere Informationen finden Sie auf der Dokumentationsseite Metadaten für LookML-Objekte.

Automatische Formatierung

Im Entwicklungsmodus können Sie das Tastenkürzel „Formatdatei“ verwenden, um die LookML-Datei automatisch einzurücken. Der Einzug gibt die Hierarchie der Parameter und Unterparameter an, wodurch die LookML leichter lesbar und verständlich ist.

Faltbar

Im Bundsteg wird ein kleiner Pfeil neben dem Anfang jedes LookML-Parameters auf oberster Ebene in der Datei angezeigt. Durch Klicken auf diesen Pfeil wird der entsprechende Abschnitt von LookML ein- oder ausgeblendet, sodass Sie sich auf bestimmte Abschnitte konzentrieren können.

Im Menü „Datei“ stehen außerdem die Optionen LookML und Unfold LookML zur Verfügung, um alle LookML-Abschnitte bis auf oberster Ebene des Parameters in der aktuellen Datei zu maximieren oder zu minimieren:

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

Hinzufügen, Ändern und Löschen markieren

In der LookML IDE werden im Entwicklungsmodus immer mehrere Indikatoren angezeigt und Sie haben keine unverbindlichen Änderungen.

  • Der Dateiname wird mit einem blauen Punkt auf der linken Seite des Fensters angezeigt. Dieser gibt an, dass die Datei neu ist, geändert wurde 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 Linien anzuzeigen, und eine horizontale rote Linie zeigt entfernte Zeilen an.

Kommentare hinzufügen

Sie können zu Ihrem LookML Kommentare hinzufügen, um die Lesbarkeit zu erhöhen. Verwenden Sie das Zeichen #, um einen einzelnen Kommentar hinzuzufügen:

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

Mit Tastenkombinationen können Sie einen ganzen Codeblock auskommentieren:

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

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. Daher sehen Sie Ihre Kommentare in der von LookML generierten SQL-Datei, die sich jedoch nicht auf die Abfrageergebnisse auswirken.

Zu Objekt oder Datei springen

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

Weitere Informationen finden Sie auf der Seite Projektinformationen aufrufen und bearbeiten.

Text im Projekt suchen und ersetzen

Die Looker-IDE hat 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.

Mit der Looker- und Ersetzungssuche in Looker können Sie LookML-Elemente in großen LookML-Projekten suchen und Text in Beschreibungen und Labels ersetzen. Wenn Sie in Ihrem Projekt nach den Namen von Modellen, Entdeckungen und Feldern suchen und sie ersetzen möchten, verwenden Sie stattdessen die Funktion „Suchen und ersetzen“ für Inhalte. Wenn Sie die Namen von Modellen, explorativen Datenanalysen und Feldern ändern, kann es zu Problemen mit Referenzen innerhalb Ihres Modells kommen. Der Content Validator kann Ihre LookML-Referenzen überprüfen und Fehler in LookML beheben, nachdem Sie diese Änderungen vorgenommen haben.

So verwenden Sie die Looker-IDE-Suche:

  1. Gehen Sie zum Suchfeld in der IDE.
  2. Geben Sie in das Feld Suchen einen Begriff ein.
  3. Sie können auch Groß-/Kleinschreibung beachten auswählen, um nur nach Instanzen zu suchen, die mit der von Ihnen im Feld Suchen eingegebenen Groß-/Kleinschreibung übereinstimmen. Sie können auch RegEX auswählen, um eine Suche anhand eines regulären Ausdrucks durchzuführen.
  4. Klicken Sie auf Suchen.
  5. Optional können Sie auf den Namen einer Datei klicken, 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 Text im 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. Klicken Sie auf Auswählen &ersetzen, um in einer Vorschau zu sehen, wie der Text im 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 sollen:

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

Neue Felder erstellen und testen

Hier ein Beispiel für die Bearbeitung von LookML: Wir fügen mehrere Felder hinzu und testen sie anschließend.

Dimension erstellen

Zuerst fügen wir unserer users-Ansicht eine neue Dimension hinzu, die bestimmt, ob ein Nutzer aus Kalifornien oder New York stammt. Die Dimension ist type: yesno. Das bedeutet, dass sie Yes zurückgibt, wenn der Nutzer aus Kalifornien oder New York stammt, und No, wenn nicht.

Die 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.

Weitere Informationen zu ${TABLE}.state erhältst du unter den Ersatzoperatoren.

Messwert erstellen

Als Nächstes fügen wir der Ansicht „user“ eine neue Maßnahme zum durchschnittlichen Alter unserer Nutzer hinzu. Dieser Wert beträgt type: average und wird über die Spalte age aggregiert.

Die LookML für diese neue Maßnahme sieht so aus:

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

Fügen Sie diesen Messwert der Datei user hinzu und klicken Sie dann auf Änderungen speichern.

Felder in der Funktion „Erkunden“ testen

Sie können die neue Dimension testen und sie analysieren. Nachdem Sie die Änderungen gespeichert haben, werden diese Felder in der Feldauswahl der Funktion „Erkunden“ angezeigt. Über das Drop-down-Menü neben dem Dateinamen einer Ansicht können Sie ganz einfach die Ansicht für die aktuelle Ansicht aufrufen:

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 der Nutzer aus Bayern oder New York und das durchschnittliche Alter der Nutzer anzeigt, die nicht:

Sie müssen sich im Entwicklermodus befinden, um auf diese neuen Felder zugreifen zu können, bis Sie die Änderungen übernommen und in die Produktion übernommen haben.

LookML prüfen

Wenn Sie mit den Änderungen zufrieden sind, können Sie Ihre Änderungen speichern. In der IDE werden Sie auf ungelöste Syntaxfehler in einer einzelnen Datei hingewiesen.

Verwenden Sie als Nächstes den LookML Validator, 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. Daher werden sie nur angezeigt, wenn der LookML-Validator ausgeführt wird. Prüfen Sie Ihre LookML-Änderungen, bevor Sie sie in der Produktionsumgebung veröffentlichen. Obwohl bei der Validierung nicht jedes Problem, z. B. Probleme mit Datenbankberechtigungen, erkannt wird, werden die meisten Fehler verhindert.

Der LookML-Validator ist nicht mit dem Inhaltsvalidator zu verwechseln, der stattdessen prüft, ob Ihre Änderungen Ihre gespeicherten Looks beeinträchtigen.

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 Datenansichten, in denen sie verwendet wird, noch einmal validiert.
  • Wenn sich ein Explore ändert, wird nur dieser Explore wieder validiert.

Tipp für das Google Chat-Team: Wenn die LookML-Validierung sehr lange dauert, sollten Sie zuerst den Parameter include in der Modelldatei prüfen. Wenn Sie alle Ansichtsdateien (include: "*.view") einschließen, muss der LookML-Validator alle prüfen, was sich auf die Leistung auswirken kann. Aktualisieren Sie in diesem Fall den Parameter include der Modelldatei, sodass nur die erforderlichen Ansichtsdateien enthalten sind.

Validierung wird ausgeführt

Klicken Sie zum Ausführen des LookML-Validators rechts oben in der Looker-IDE auf die Schaltfläche LookML (LookML) oder auf das Symbol Projektzustand oben in der IDE, um den Bereich Projektzustand zu öffnen. Wählen Sie dann die Schaltfläche LookML aus:

Nachdem Sie den LookML Validator ausgeführt haben, werden möglicherweise Fehler und andere Warnungen angezeigt, die behoben werden sollten. Sie können einen beliebigen Pfeil auswählen, um die Liste der Fehler oder Warnungen zu maximieren:

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

Validierungsmeldungen

Looker zeigt nach der Validierung in LookML Validierungsmeldungen an.

In den LookML-Dashboards werden in der Seitenleiste Informationsmeldungen anstelle von Warnungen angezeigt, wenn die permissive Lokalisierung aktiviert ist.

Keine LookML-Fehler gefunden

Wenn vom Validator keine Probleme gefunden werden, zeigt Looker ein grünes Häkchen neben dem Text No LookML errors found an.

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):

In der erweiterten Liste der Probleme sehen Sie, warum die Überprüfung fehlschlägt. Wenn Sie auf den Fehler klicken, gelangen Sie oft direkt zur problematischen Codezeile. Neben der Zeile wird ein rotes X angezeigt. Wenn Sie den Mauszeiger darauf bewegen, werden in einigen Fällen ausführlichere Fehlerinformationen angezeigt:

Tipp für das Google Chat-Team: Nach dem Validierungsfehler, nach dem wir am häufigsten gefragt werden, ist "Unbekannt oder nicht zugängliches Feld." In diesem Hilfeartikel finden Sie Informationen zu den Ursachen und Gegenmaßnahmen.

LookML-Warnungen

LookML-Warnungen verhindern zwar nicht, dass eine Abfrage ausgeführt wird, können aber trotzdem dazu führen, dass Ihre Nutzer fehlerhafte oder unbeabsichtigte Funktionen erhalten. Wie bei Fehlern gibt die Zahl in Klammern die Anzahl der gefundenen Warnungen an (im folgenden Beispiel drei Warnungen):

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

Änderungen bereitstellen

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

Wenn Sie Feldnamen ändern, die in Ihren Looks oder Dashboards als Filter dienen, prüfen Sie den Bereich Filter Ihrer geplanten Looks und Dashboards und aktualisieren Sie die Filter nach Bedarf, um Ihre Änderungen zu berücksichtigen. Wenn eine geplante Inhaltslieferung nicht mehr funktionsfähige Filter enthält (zum Beispiel wenn sich das Feld geändert hat, auf das verwiesen wird), könnte die geplante Lieferung ungefilterte Daten anzeigen.