Documentation

Deprecated

Deprecated

Enables trace output to a file in a directory of the clients choosing

Sets the maximum size in bytes of a single trace output file. This value should be in the range ``[0, INT64_MAX]``. If the value is set to 0, there is no limit on individual file size. The default is a maximum size of 10,485,760 bytes.

Sets the maximum size of all the trace output files put together. This value should be in the range ``[0, INT64_MAX]``. If the value is set to 0, there is no limit on the total size of the files. The default is a maximum size of 104,857,600 bytes. If the default roll size is used, this means that a maximum of 10 trace files will be written at a time.

Sets the LogGroup attribute with the specified value for all events in the trace output files. The default log group is 'default'.

Select the format of the log files. xml (the default) and json are supported.

Select clock source for trace files. now (the default) or realtime are supported.

Once provided, this string will be used to replace the port/PID in the log file names.

Set file suffix for partially written log files.

Set internal tuning or debugging knobs

Deprecated

Set the certificate chain

Set the file from which to load the certificate chain

Set the private key corresponding to your own certificate

Set the file from which to load the private key corresponding to your own certificate

Set the peer certificate field verification criteria

Set the probability of a BUGGIFY section being active for the current execution. Only applies to code paths first traversed AFTER this option is changed.

Set the probability of an active BUGGIFY section being fired

Set the ca bundle

Set the file from which to load the certificate authority bundle

Set the passphrase for encrypted private key. Password should be set before setting the key for the password to be used.

Disables the multi-version client API and instead uses the local client directly. Must be set before setting up the network.

If set, callbacks from external client libraries can be called from threads created by the FoundationDB client library. Otherwise, callbacks will be called from either the thread used to add the callback or the network thread. Setting this option can improve performance when connected using an external client, but may not be safe to use in all environments. Must be set before setting up the network. WARNING: This feature is considered experimental at this time.

Adds an external client library for use by the multi-version client API. Must be set before setting up the network.

Searches the specified path for dynamic libraries and adds them to the list of client libraries for use by the multi-version client API. Must be set before setting up the network.

Prevents connections through the local client, allowing only connections through externally loaded client libraries.

Spawns multiple worker threads for each version of the client that is loaded. Setting this to a number greater than one implies disable_local_client.

Disables logging of client statistics, such as sampled transaction activity.

Deprecated

Enables debugging feature to perform run loop profiling. Requires trace logging to be enabled. WARNING: this feature is not recommended for use in production.

Enable client buggify - will make requests randomly fail (intended for client testing)

Disable client buggify

Set the probability of a CLIENT_BUGGIFY section being active for the current execution.

Set the probability of an active CLIENT_BUGGIFY section being fired. A section will only fire if it was activated

Set a tracer to run on the client. Should be set to the same value as the tracer set on the server.

This option is set automatically to communicate the list of supported clients to the active client.

This option is set automatically on all clients loaded externally using the multi-version API.

This option tells a child on a multiversion client what transport ID to use.