<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">Fdb - FoundationDB Perl Interface

Use Fdb to interface with FoundationDB. It is based on the C API, so please
read the documentation on the FoundationDB website.

The Perl interface differs from the C one in 2 cases:

* where C methods expect tuples of (string, string_length), in Perl disregard
the need for string_length

* where C methods expect an output parameter (e.g. FDBCluster **out_cluster),
in Perl you instead do not pass it in but get it as a 2nd item in the output of
the method.

        use Fdb;
        Fdb::select_api_version(Fdb::FDB_API_VERSION);
        Fdb::setup_network();
        Fdb::run_network();
        my $cluster_f = Fdb::create_cluster(undef);
        Fdb::future_block_until_ready($cluster_f);
        my $err;
        my $err = Fdb::future_get_error($cluster_f);
        if ($err != 0) {
          warn $err;
        }
        my $res;
        my $cluster_handle = undef;
        ($res, $cluster_handle) = Fdb::future_get_cluster($cluster_f);
        Fdb::future_destroy($cluster_f);
        my $db_f = Fdb::cluster_create_database($cluster_handle, "DB");
        Fdb::future_block_until_ready($db_f);
        my $db_handle;
        ($res, $db_handle) = Fdb::future_get_database($db_f);
        Fdb::future_destroy($db_f);
        
        ...

        Fdb::database_destroy($db_handle);
        Fdb::cluster_destroy($cluster_handle);
        Fdb::stop_network();

Please see t/01_connect.t for a complete sample of transaction set/get.

With the exceptions described above, all the subroutines have the same
names and parameters as the C API.


INSTALLATION

To install this module, run the following commands:

	perl Makefile.PL
	make
	make test
	make install

WARNING: You *MUST* have a thread-enabled Perl interpreter (&gt;=5.008)

SUPPORT AND DOCUMENTATION

After installing, you can find documentation for this module with the
perldoc command.

    perldoc Fdb

You can also look for information at:

    RT, CPAN's request tracker (report bugs here)
        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Fdb

    AnnoCPAN, Annotated CPAN documentation
        http://annocpan.org/dist/Fdb

    CPAN Ratings
        http://cpanratings.perl.org/d/Fdb

    Search CPAN
        http://search.cpan.org/dist/Fdb/


LICENSE AND COPYRIGHT

Copyright (C) 2013-2018 Henri Asseily

This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:

L&lt;http://www.perlfoundation.org/artistic_license_2_0&gt;

Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

</pre></body></html>