Gaffer

Гаффер

Чтобы быстро и легко получить доступ к среде со всем установленным и правильно настроенным, вы можете использовать GitHub Codespaces или, альтернативно, GitLab GitPod. Они предоставляют среды удаленного кодирования с использованием VS Code с необходимыми плагинами, предустановленной версией Java и Maven.

Наш Javadoc можно найти здесь. Документация Gaffer хранится в репозитории gaffer-doc и публикуется на страницах GitHub (gchq.github.io).

Местные требования

Для локальной сборки Gaffer вам потребуется Java 8 или 11 и Maven, установленный локально в среде *nix. MS Windows подойдет для большинства целей, но это не рекомендуется, поскольку тесты с использованием Hadoop не проходят из-за ограниченной поддержки Hadoop в Windows. Gaffer будет компилироваться с более новыми версиями Java, но некоторые тесты завершатся неудачно из-за отсутствия поддержки более новой версии Java в некоторых внешних зависимостях.

Чтобы собрать Gaffer, запустите mvn clean install -Pquick в каталоге верхнего уровня. При этом будут созданы все основные библиотеки Gaffer и несколько примеров загрузки и запроса данных.

Процесс внесения вклада

Подробную информацию о наших методах работы можно найти в нашей документации для разработчиков. Вкратце:

• Подпишите лицензионное соглашение для участников GCHQ.
• Отправьте изменения в вилку
• Отправьте запрос на вытягивание

Включение в другие проекты

Gaffer размещается на Maven Central и может быть легко включен в ваши собственные проекты Maven.

Чтобы использовать Gaffer из Java API, единственными необходимыми зависимостями являются модуль графа 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, которая может выполнять операции.

Репозиторий gaffer-docker содержит код, необходимый для запуска Gaffer с использованием Docker или Kubernetes.

Репозиторий koryphe содержит расширяемую библиотеку функций для фильтрации, агрегирования и преобразования данных на основе API функций Java. Это зависимость от Gaffer.

Лицензия

Gaffer распространяется по лицензии Apache 2 и защищен авторскими правами Crown.

 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.