管理 LookML 檔案和資料夾

LookML 專案檔案會在 Looker IDE 的檔案瀏覽器區段中分類為資料夾。本頁面提供在 LookML 專案中建立及管理資料夾和檔案的操作說明。

如要瞭解 LookML 專案中各類型檔案的結構和用途,請參閱「LookML 專案中的檔案類型」說明文件頁面。

重要的檔案和資料夾命名慣例

建立檔案和資料夾時,請遵守下列命名慣例:

  • 區分大小寫: LookML 會區分大小寫。命名資料夾時,請務必遵循專案的慣例。舉例來說,如果您的慣例是在專案中使用全小寫字母,請將資料夾命名為 views,而非 Views。這一點尤其適用於您需要指定檔案路徑的情況,例如納入檔案。一般來說,建議您在命名 LookML 物件和資料夾時,一律使用小寫字母。
  • 空格和特殊字元:檔案名稱不得包含空格或下列任一字元:/ ? * : | " < > %
  • 檔案副檔名:使用 Looker IDE 建立 LookML 檔案時,如果您未手動加入副檔名,Looker 會自動在檔案名稱結尾加上 .lkml 副檔名。舉例來說,如果您輸入檔案名稱 flights_data_tests,Looker 會將檔案命名為 flights_data_tests.lkml
  • 變更 LookML 物件顯示名稱:如要變更模型或 LookML 物件的顯示名稱,建議您使用 label 參數或 alias 參數,而非重新命名檔案或物件。labelalias 參數會變更顯示名稱,但會保留用於電子郵件或其他系統的基礎網址。一般來說,您應採取預防措施,盡可能以非侵入性的方式變更模型。如果確實需要重新命名模型或物件,請使用內容驗證工具更新所有模型或物件的參照。

建立資料夾

您可以為不同檔案類型 (例如檢視檔案模型檔案) 建立資料夾。您甚至可以建立子資料夾,如果想include 檢視畫面的子集,這項功能就非常實用。

如要建立資料夾,請按照以下步驟進行:

  1. 在適當的選單中選取「Create Folder」選項:
    • 如要在目錄結構的頂層建立新資料夾,請使用「新增檔案或資料夾」選單,方法是選取「檔案瀏覽器」面板頂端的 + (加號) 圖示。
    • 如要在現有資料夾下建立新子資料夾,請使用現有資料夾的三點「資料夾選項」選單。
  2. 輸入新資料夾的名稱。
  3. 選取 [Create] (建立)。

新資料夾會新增至導覽窗格。

建立檔案

當您產生模型時,Looker 會自動建立以資料庫為基礎的模型檔案和檢視檔案。如果是現有專案,您可以手動建立新檔案。

如要在 LookML 專案中建立新檔案,請按照下列步驟操作:

  1. 選取適當的選單:

    • 如要在目錄結構的頂層建立新檔案,請使用「新增檔案或資料夾」選單,方法是選取「檔案瀏覽器」面板頂端的 + (加號) 圖示。
    • 如要在現有資料夾下建立新檔案,請使用現有資料夾的三點「資料夾選項」選單。
  2. 選取要建立的 LookML 檔案類型。請選取下列清單中的連結,進一步瞭解各類型檔案的詳細說明。您可以建立下列類型的檔案:

  3. 在「Create File」對話方塊中,輸入新檔案的名稱。如要瞭解命名檔案的限制和規範,請參閱「重要檔案和資料夾命名慣例」一節。

  4. 選取 [Create] (建立)。新檔案會顯示在建立檔案的位置。如有需要,您可以將檔案移至其他資料夾

建立檔案的注意事項

建立檔案時,請注意下列事項:

  • 建議您使用 Looker IDE 將檔案新增至 LookML 專案,方法是在 Looker IDE 中建立檔案,或是在 Looker IDE 中上傳檔案。如果您改為在 Looker IDE 外部建立檔案,然後使用 Looker IDE 從 (正式版分支) 中拉取,請務必使用正確的命名慣例,並在檔案名稱中加入 .lkml 副檔名 (或 Explore 檔案的 explore.lkml)。如果檔案名稱含有不支援的字元,Looker IDE 檔案瀏覽器會以紅色顯示檔案名稱,您必須使用支援的字元重新命名檔案,才能查看檔案內容。此外,如果檔案沒有 .lkml 副檔名,Looker IDE 就不會顯示該檔案。
  • 建立檔案後,如果要在專案的其他 LookML 檔案中參照該檔案中的元素,請務必使用 include 參數。詳情請參閱 include 參數說明文件頁面。
  • 如果建立的檔案會嵌套在七個或更多資料夾中,檔案總管就不會顯示該檔案。
  • 專案資訊清單檔案只能透過選取 + (加號) 圖示,開啟 Looker IDE 檔案瀏覽器頂端的「Add file or folder」選單,且專案中必須沒有現有的資訊清單檔案。這是因為專案只能有一個資訊清單檔案,且資訊清單檔案必須位於專案目錄結構的根層級。
  • 建立語言代碼字串檔案選項僅適用於 Looker IDE 檔案瀏覽器頂端的「Add file or folder」+ (加號) 圖示。不過,建立 (或上傳) 語言代碼字串檔案後,您可以將檔案移至資料夾。如果您要建立語言代碼字串檔案來將模型本地化,同時也想善用 Looker 內建的 UI 本地化功能,則必須使用特定語言代碼命名字串檔案。您可以在「使用者」說明文件頁面的「語言代碼」部分找到這些代碼。
  • 建立 Explore 檔案時,檔案名稱結尾必須加上 .explore.lkml 副檔名。如要上傳檔案,請務必使用完整的 .explore.lkml 副檔名。如果您使用 Looker IDE 建立檔案,並使用通用 LookML 檔案選項,Looker 會在檔案名稱結尾加上 .lkml (如果沒有副檔名),但您仍必須手動將擴充資料的 .explore 部分加入檔案名稱。舉例來說,如要使用 Looker IDE 建立名為 flights 的 Explore 檔案,您可以輸入 flights.exploreflights.explore.lkml,檔案就會命名為 flights.explore.lkml

建立檢視表檔案的注意事項

大多數 LookML 開發人員會從一或多個檢視畫面檔案開始,這些檔案會在 LookML 專案從資料庫中的一組資料表產生時自動建立。不過,除了本頁所述的建立空白檢視畫面檔案上傳檔案方法外,開發模式中的 Looker 開發人員還有許多方式,可以將檢視畫面檔案新增至 LookML 專案:

如要使用新檢視畫面,請使用 explore 參數將其新增至模型檔案,或是使用 join 參數將其加入模型檔案中現有的 Explore。

從現有資料庫資料表新增檢視

您可以在開發模式中,從現有的資料庫資料表建立檢視檔案。

  1. 在專案中,選取 Looker IDE 專案檔案清單頂端的 + (加號),選取「Add file or folder」選單,或選取資料夾的選單,在資料夾中建立檔案

  2. 選取「Create View From Table」(從資料表建立檢視表)

  3. Looker 會顯示與其中一個連線相關聯的資料表清單。如要變更連線,請使用左上方的「連線」下拉式選單。

  4. 勾選資料表名稱左側的方塊,選取要用來建立檢視表的任何資料表。您可以收合或展開清單中的資料庫或結構定義,以便存取所有可用的資料表。

  5. 前往頁面底部,然後選取「建立檢視項目」

  6. Looker 會為所有資料表欄產生包含 LookML 的檢視畫面。

上傳檔案

你也可以從電腦上傳檔案至專案。如果您已在電腦上建立 JSON 資料檔案或 LookML 檔案,這項功能就很實用。

如要將檔案上傳至專案,請使用 Looker IDE 中的拖曳功能,按照下列步驟操作:

  1. 前往專案檔案
  2. 將檔案從電腦拖曳至 Looker IDE。檔案會顯示在目錄結構的根目錄中。
  3. 檔案上傳完成後,請將項目移至其他資料夾

刪除檔案和資料夾

刪除資料夾也會刪除其中的內容,因此請小心刪除資料夾。刪除資料夾前,請按照下列步驟操作:

  • 請確認你要刪除資料夾中的檔案,或將檔案移至其他位置,再刪除資料夾。
  • 確認該資料夾不含有任何在專案 include 陳述式中提及的檔案。如要進一步瞭解如何在 IDE 資料夾中使用 include,請參閱 include 參數說明文件頁面中的「使用 include 搭配 IDE 資料夾」一節。

如要刪除資料夾或檔案,請在 IDE 左側面板中,從項目的三點「檔案選項」選單中選取「刪除」

刪除資料夾時,IDE 會顯示確認對話方塊。對話方塊會指定刪除作業要包含多少項目,包括資料夾和資料夾內的所有檔案。

刪除模型檔案後,系統不會從模型所屬的任何模型集中移除該模型。如果新建的模型檔案名稱與已刪除的模型相同,新模型就會納入包含已刪除模型的任何模型集。這可能會導致不必要的存取權限授予新模型檔案。Looker 管理員可以編輯模型組合,並移除已刪除的模型,以避免發生這類問題。

大量刪除檔案和資料夾

刪除資料夾也會刪除其中的內容,因此請小心刪除資料夾。刪除資料夾前,請按照下列步驟操作:

  • 請確認你要刪除資料夾中的檔案,或將檔案移至其他位置,再刪除資料夾。
  • 確認該資料夾不含有任何在專案 include 陳述式中提及的檔案。如要進一步瞭解如何在 IDE 資料夾中使用 include,請參閱 include 參數說明文件頁面中的「使用 include 搭配 IDE 資料夾」一節。

如要大量刪除資料夾和檔案,請按照下列步驟操作:

  1. 選取「檔案瀏覽器」面板頂端的「大量編輯」圖示。

  2. 選取要刪除的項目。「選取檔案」標題旁會顯示所選檔案的數量。

    • 如要選取或取消選取個別檔案,請展開相應的資料夾,然後勾選檔案名稱旁的核取方塊。
    • 如要選取或取消選取整個資料夾及其內容,請勾選資料夾名稱旁的核取方塊。
    • 如要選取目錄清單的整個部分,請按住 Shift 鍵並點選。選取範圍中頂端項目的核取方塊,然後按住 Shift 鍵,再選取清單中最後一個項目的核取方塊。系統會選取兩個項目,以及兩者之間的所有項目。您也可以按住 Shift 鍵並點選項目,選取該項目和目錄清單中前方的所有項目。
  3. 選取「刪除項目」垃圾桶圖示。接著,IDE 會顯示對話方塊,列出所選項目。

  4. 選取「是,刪除」確認要刪除的項目,或選取「取消」返回項目選取畫面。

  5. 選取「選取檔案」標題中的「X」,即可退出大量編輯模式。

移動資料夾專案中的項目

如要移動檔案,請將檔案或資料夾拖曳到其他資料夾。

目的地資料夾不需要展開,即可接收其他資料夾或檔案。將滑鼠游標懸停在資料夾上時,資料夾會自動展開。

變更檔案路徑時,請務必更新專案中的任何 include 陳述式,以符合新路徑。如要進一步瞭解如何搭配 IDE 資料夾使用 include,請參閱 include 參數說明文件頁面中的「搭配 IDE 資料夾使用 include」一節。

此外,請注意,當您變更檔案路徑時,Git 會有效地刪除該檔案,並建立具有新路徑的新檔案。這表示檔案的 Git 歷程記錄會是空白,因為 Git 會將其視為新檔案。如要查看檔案移至新位置前的 Git 記錄,請使用 Git 介面前往檔案的原始位置,然後查看 Git 記錄。(同樣的邏輯也適用於重新命名的檔案,因為 Git 會有效地刪除檔案,並建立名稱不同的新檔案)。

大量移動檔案和資料夾

如要大量移動資料夾和檔案,請按照下列步驟操作:

  1. 選取「檔案瀏覽器」面板頂端的「大量編輯」圖示。

  2. 選取要移動的項目。「選取檔案」標題旁會顯示所選檔案的數量。

    • 如要選取或取消選取個別檔案,請展開相應的資料夾,然後勾選檔案名稱旁的核取方塊。
    • 如要選取或取消選取整個資料夾及其內容,請勾選資料夾名稱旁的核取方塊。
    • 如要選取目錄清單的整個部分,請按住 Shift 鍵並點選。選取範圍中頂端項目的核取方塊,然後按住 Shift 鍵,再選取清單中最後一個項目的核取方塊。系統會選取兩個項目,以及兩者之間的所有項目。您也可以按住 Shift 鍵並點選項目,選取該項目和目錄清單中的所有前一個檔案
  3. 選取「Move Items」資料夾圖示,選取所需選項。接著,IDE 會顯示資料夾選取對話方塊。

  4. 在「移動至」對話方塊中,為所選項目選擇資料夾,或選取「新資料夾」來建立新資料夾。專案名稱會顯示您在下一個選單頁面頂端選取的資料夾路徑。如要將項目移至專案的根目錄,請選取「移動」,但不要選取任何資料夾。

  5. 選取「Move」確認所選目的地,選取「New Folder」在所選資料夾中建立新資料夾,或選取路徑中的專案名稱連結,返回主要資料夾選項選單。

  6. 選取「選取檔案」標題中的「X」,即可退出大量編輯模式。

變更檔案路徑後,請務必更新專案中的任何 include 陳述式,以符合新路徑。如要進一步瞭解如何在 IDE 資料夾中使用 include,請參閱 include 參數說明文件頁面中的「使用 include 搭配 IDE 資料夾」一節。

此外,請注意,當您變更檔案路徑時,Git 會有效地刪除該檔案,並建立具有新路徑的新檔案。這表示檔案的 Git 歷程記錄會是空白,因為 Git 會將其視為新檔案。如要查看檔案移至新位置前的 Git 記錄,請使用 Git 介面前往檔案的原始位置,然後查看 Git 記錄。(同樣的邏輯也適用於重新命名的檔案,因為 Git 會有效地刪除檔案,並建立名稱不同的新檔案)。