diff options
Diffstat (limited to 'nixos/modules/services/databases/foundationdb.xml')
| -rw-r--r-- | nixos/modules/services/databases/foundationdb.xml | 52 |
1 files changed, 42 insertions, 10 deletions
diff --git a/nixos/modules/services/databases/foundationdb.xml b/nixos/modules/services/databases/foundationdb.xml index 51fe9ae3f91..f4090c49276 100644 --- a/nixos/modules/services/databases/foundationdb.xml +++ b/nixos/modules/services/databases/foundationdb.xml @@ -12,12 +12,10 @@ <para><emphasis>Maintainer:</emphasis> Austin Seipp</para> -<para><emphasis>Available version(s):</emphasis> 5.1.x</para> +<para><emphasis>Available version(s):</emphasis> 5.1.x, 5.2.x, 6.0.x</para> -<para>FoundationDB (or "FDB") is a distributed, open source, high performance, -transactional key-value store. It can store petabytes of data and deliver -exceptional performance while maintaining consistency and ACID semantics -(serializable transactions) over a large cluster.</para> +<para>FoundationDB (or "FDB") is an open source, distributed, transactional +key-value store.</para> <section><title>Configuring and basic setup</title> @@ -26,12 +24,12 @@ exceptional performance while maintaining consistency and ACID semantics <programlisting> services.foundationdb.enable = true; -services.foundationdb.package = pkgs.foundationdb51; # FoundationDB 5.1.x +services.foundationdb.package = pkgs.foundationdb52; # FoundationDB 5.2.x </programlisting> </para> <para>The <option>services.foundationdb.package</option> option is required, -and must always be specified. Because FoundationDB network protocols and +and must always be specified. Due to the fact FoundationDB network protocols and on-disk storage formats may change between (major) versions, and upgrades must be explicitly handled by the user, you must always manually specify this yourself so that the NixOS module will use the proper version. Note that minor, @@ -70,6 +68,40 @@ fdb> </programlisting> </para> +<para>You can also write programs using the available client libraries. +For example, the following Python program can be run in order to grab the +cluster status, as a quick example. (This example uses +<command>nix-shell</command> shebang support to automatically supply the +necessary Python modules). + +<programlisting> +a@link> cat fdb-status.py +#! /usr/bin/env nix-shell +#! nix-shell -i python -p python pythonPackages.foundationdb52 + +import fdb +import json + +def main(): + fdb.api_version(520) + db = fdb.open() + + @fdb.transactional + def get_status(tr): + return str(tr['\xff\xff/status/json']) + + obj = json.loads(get_status(db)) + print('FoundationDB available: %s' % obj['client']['database_status']['available']) + +if __name__ == "__main__": + main() +a@link> chmod +x fdb-status.py +a@link> ./fdb-status.py +FoundationDB available: True +a@link> +</programlisting> +</para> + <para>FoundationDB is run under the <command>foundationdb</command> user and group by default, but this may be changed in the NixOS configuration. The systemd unit <command>foundationdb.service</command> controls the @@ -295,7 +327,6 @@ only undergone fairly basic testing of all the available functionality.</para> individual <command>fdbserver</command> processes. Currently, all server processes inherit all the global <command>fdbmonitor</command> settings. </para></listitem> - <listitem><para>Python bindings are not currently installed.</para></listitem> <listitem><para>Ruby bindings are not currently installed.</para></listitem> <listitem><para>Go bindings are not currently installed.</para></listitem> </itemizedlist> @@ -306,8 +337,9 @@ only undergone fairly basic testing of all the available functionality.</para> <para>NixOS's FoundationDB module allows you to configure all of the most relevant configuration options for <command>fdbmonitor</command>, matching it -quite closely. For a complete list of all options, check <command>man -configuration.nix</command>.</para> +quite closely. A complete list of options for the FoundationDB module may be +found <link linkend="opt-services.foundationdb.enable">here</link>. You should +also read the FoundationDB documentation as well.</para> </section> |