Implement a Java-backed DB_File provider

Offen
#2,013 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
20/100
Issue-Typ
Feature
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
java, perl, sqlite
Bereich
backend, databases

Rechercherichtung

Start with src/main/perl/lib/XSLoader.pm, src/main/java/org/perlonjava/runtime/perlmodule/DBM.java, and the upstream DB_File.pm API to understand module registration and the existing storage boundary. Then add the unchanged upstream DB_File tests and fixtures and validate them first with system Perl, followed by both PerlOnJava backends. Done means the documented API and file format pass the supported upstream tests and the stated dependency chain no longer fails solely on XS loading.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

area:cpan-port area:database enhancement high-impact

Summary

Implement a Java-backed DB_File provider so PerlOnJava applications can use the CPAN module's Perl-facing database API without loading its XS extension.

This is separate from #1494 and #1495: those implement Perl's dbmopen/dbmclose over a PerlOnJava SQLite format. They do not implement DB_File, its tie classes, or Berkeley DB's API.

Evidence and impact

  • In CPAN random run 20261109-091152-39587, Kwiki::GoogleLink 0.01 pulled in Kwiki 0.39, then Spoon 0.24; Spoon requires DB_File. The PerlOnJava run timed out during this dependency chain before the target distribution's tests started.
  • The archived system-Perl oracle passed the target tests: Kwiki::GoogleLink passed 1 test and Kwiki passed 59 tests (with optional cycle tests skipped).
  • A bounded isolated run of DB_File 1.861 with PerlOnJava's launcher built its Perl files, then failed its tests because XSLoader reports XS module not supported on PerlOnJava. The failing upstream test files included t/000prereq.t, t/db-btree.t, t/db-hash.t, t/db-recno.t, and t/db-threads.t.
  • The targeted CPAN reverse-dependency lookup found 63 unique released distributions with a runtime dependency on DB_File, including 7 recent dependants. Examples include BioPerl, LaTeXML, Geo-Coder-Free, XML-TMX, and IP-Country-DB_File.

Current implementation boundary

src/main/perl/lib/XSLoader.pm explicitly lists DB_File as unsupported. The existing PerlOnJava::DBM implementation in src/main/java/org/perlonjava/runtime/perlmodule/DBM.java stores data in SQLite and explicitly does not read or write native Berkeley DB files.

The first provider may use SQLite or another Java implementation, but it must document its file format and must not claim interoperability with Berkeley DB files unless that is actually implemented. Existing DB_File users should receive a clear error for unsupported features rather than silently getting different semantics.

Proposed scope

  • Preserve and expose the upstream DB_File.pm Perl API while registering Java-backed operations through PerlOnJava's module/XSLoader mechanism.
  • Support the common tied-hash use cases for DB_HASH and DB_BTREE, including open/create flags, byte-string keys and values, FETCH, STORE, DELETE, EXISTS, CLEAR, and stable key iteration.
  • Support the tied-array DB_RECNO interface, including array indexing and mutation behavior.
  • Implement and document the useful direct object methods (get, put, del, seq, sync, and duplicate-record methods where supported), exported constants, and DB configuration objects.
  • Define behavior for unsupported native-only operations such as returning a real file descriptor; do not report success with a fabricated value.
  • Keep the provider usable on both JVM and interpreter backends and independent of Berkeley DB libraries installed on the host for the initial Java-backed format.

A follow-up can add native Berkeley DB file interoperability if there is a supported, distributable cross-platform implementation. That requirement would add native-library packaging and platform work beyond this initial scope.

Acceptance criteria

  • use DB_File succeeds through the Java provider, without loading the XS extension.
  • Add the unchanged upstream DB_File test suite and fixtures to the repository and use it to track supported behavior; do not modify upstream tests to hide gaps.
  • Validate Perl-level tests with system Perl first, then run the supported tests on both PerlOnJava backends.
  • Cover persistence/reopen, binary keys and values, HASH/BTREE iteration, RECNO array semantics, read-only/error paths, duplicate behavior where implemented, close/untie, and documented unsupported operations.
  • Re-run the CPAN dependency chain that exposed this gap and verify DB_File tests no longer fail solely because XS loading is unsupported.
  • Update bundled-module and feature documentation with the API and file-format boundaries.
Vorherrschende Sprache
Perl
Sterne
67
Forks
8
Ø Merge
5 Std. 12 Min.
Gemergte PRs (30 T.)
131

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus fglock/PerlOnJava

Alle Issues in fglock/PerlOnJava

Ähnliche Issues

Weitere Issues zu Perl

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.