Gaffer

領班

若要快速輕鬆地存取已正確安裝和設定所有內容的環境，您可以使用 GitHub Codespaces 或 GitLab GitPod。它們使用 VS Code 提供遠端編碼環境，並預先安裝所需的插件、Java 版本和 Maven。

我們的 Javadoc 可以在這裡找到。 Gaffer 的文檔保存在 gaffer-doc 儲存庫中，並發佈在 GitHub 頁面 (gchq.github.io) 上。

當地要求

要在本機建置 Gaffer，您需要在 *nix 環境中本機安裝 Java 8 或 11 和 Maven。 MS Windows 適用於大多數用途，但不建議使用，因為由於 Windows 上的 Hadoop 支援有限，利用 Hadoop 的測試會失敗。 Gaffer 將使用較新版本的 Java 進行編譯，但由於某些外部相依性缺乏對較新 Java 的支持，某些測試將會失敗。

若要建置 Gaffer，請在頂層目錄中執行mvn clean install -Pquick 。這將建立 Gaffer 的所有核心庫以及一些如何載入和查詢資料的範例。

貢獻流程

有關我們工作方式的詳細資訊可以在我們的開發人員文件中找到。簡而言之：

• 簽署 GCHQ 貢獻者許可協議
• 將您的變更推送到 fork
• 提交拉取請求

納入其他項目

Gaffer 託管在 Maven Central 上，可以輕鬆合併到您自己的 Maven 專案中。

要從 Java API 使用 Gaffer，唯一需要的依賴項是 Gaffer 圖形模組和用於儲存資料的特定資料庫技術的儲存模組，例如 Accumulo 儲存：

< dependency >
    < groupId >uk.gov.gchq.gaffer</ groupId >
    < artifactId >graph</ artifactId >
    < version >${gaffer.version}</ version >
</ dependency >
< dependency >
    < groupId >uk.gov.gchq.gaffer</ groupId >
    < artifactId >accumulo-store</ artifactId >
    < version >${gaffer.version}</ version >
</ dependency >

這將包括所有其他強制依賴項。可以根據需要將其他（可選）元件新增到您的專案中。

相關儲存庫

gafferpy 儲存庫包含一個可以執行操作的 python shell。

gaffer-docker 儲存庫包含使用 Docker 或 Kubernetes 執行 Gaffer 所需的程式碼。

koryphe 儲存庫包含一個可擴充函數庫，用於基於 Java 函數 API 過濾、聚合和轉換資料。它是 Gaffer 的依賴項。

執照

Gaffer 根據 Apache 2 許可證獲得許可，並受皇家版權保護。

 Copyright 2016-2023 Crown Copyright

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.