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.