Gaffer

Bapak

Untuk mendapatkan akses cepat dan mudah ke lingkungan dengan segala sesuatunya terinstal dan diatur dengan benar, Anda dapat menggunakan GitHub Codespaces, atau alternatifnya GitLab GitPod. Ini menyediakan lingkungan pengkodean jarak jauh menggunakan VS Code dengan plugin yang diperlukan, versi Java dan Maven yang sudah diinstal sebelumnya.

Javadoc kami dapat ditemukan di sini. Dokumentasi Gaffer disimpan di repositori gaffer-doc dan dipublikasikan di halaman GitHub (gchq.github.io).

Persyaratan Lokal

Untuk membangun Gaffer secara lokal, Anda memerlukan Java 8 atau 11 dan Maven diinstal secara lokal di lingkungan *nix. MS Windows dapat digunakan untuk sebagian besar tujuan, namun tidak disarankan karena pengujian yang menggunakan Hadoop gagal karena terbatasnya dukungan Hadoop pada Windows. Gaffer akan dikompilasi dengan versi Java yang lebih baru, namun beberapa pengujian akan gagal karena kurangnya dukungan untuk Java yang lebih baru dalam dependensi eksternal tertentu.

Untuk membangun Gaffer, jalankan mvn clean install -Pquick di direktori tingkat atas. Ini akan membangun semua perpustakaan inti Gaffer dan beberapa contoh cara memuat dan mengkueri data.

Proses Kontribusi

Informasi terperinci tentang cara kami bekerja dapat ditemukan di dokumen pengembang kami. Singkatnya:

• Tanda tangani Perjanjian Lisensi Kontributor GCHQ
• Dorong perubahan Anda ke fork
• Kirimkan permintaan tarik

Penyertaan dalam proyek lain

Gaffer dihosting di Maven Central dan dapat dengan mudah dimasukkan ke dalam proyek pakar Anda sendiri.

Untuk menggunakan Gaffer dari Java API, satu-satunya dependensi yang diperlukan adalah modul grafik Gaffer dan modul penyimpanan untuk teknologi database spesifik yang digunakan untuk menyimpan data, misalnya untuk penyimpanan 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 >

Ini akan mencakup semua dependensi wajib lainnya. Komponen (opsional) lainnya dapat ditambahkan ke proyek Anda sesuai kebutuhan.

Repositori terkait

Repositori gafferpy berisi shell python yang dapat menjalankan operasi.

Repositori gaffer-docker berisi kode yang diperlukan untuk menjalankan Gaffer menggunakan Docker atau Kubernetes.

Repositori koryphe berisi pustaka fungsi yang dapat diperluas untuk memfilter, menggabungkan, dan mengubah data berdasarkan Java Function API. Ini adalah ketergantungan Gaffer.

Lisensi

Gaffer dilisensikan di bawah lisensi Apache 2 dan dilindungi oleh Hak Cipta 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.