Add documation about network options.

This commit is contained in:
Yao Xiao 2021-09-22 12:55:37 -07:00 committed by Yao Xiao
parent 7f09bdbda4
commit af51de902f
2 changed files with 91 additions and 0 deletions

View File

@ -588,3 +588,48 @@
.. |locality-get-addresses-for-key-blurb| replace::
Returns a list of public network addresses as strings, one for each of the storage servers responsible for storing ``key`` and its associated value.
.. |option-knob| replace::
Sets internal tuning or debugging knobs.
.. |option-tls-verify-peers| replace::
Sets the peer certificate field verification criteria.
.. |option-tls-ca-bytes| replace::
Sets the certificate authority bundle.
.. |option-tls-ca-path| replace::
Sets the file from which to load the certificate authority bundle.
.. |option-tls-password| replace::
Sets the passphrase for encrypted private key. Password should be set before setting the key for the password to be used.
.. |option-disable-multi-version-client-api| replace::
Disables the multi-version client API and instead uses the local client directly. Must be set before setting up the network.
.. |option-set-disable-local-client| replace::
Prevents connections through the local client, allowing only connections through externally loaded client libraries.
.. |option-set-client-threads-per-version| replace::
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.
.. |option-disable-client-statistics-logging| replace::
Disables logging of client statistics, such as sampled transaction activity.
.. |option-enable-run-loop-profiling| replace::
Enables debugging feature to perform run loop profiling. Requires trace logging to be enabled. WARNING: this feature is not recommended for use in production.
.. |option-set-distributed-client-tracer| replace::
Sets a tracer to run on the client. Should be set to the same value as the tracer set on the server.

View File

@ -125,6 +125,10 @@ After importing the ``fdb`` module and selecting an API version, you probably wa
.. note:: |network-options-warning|
.. method :: fdb.options.set_knob("knob_name=value")
|option-knob|
.. method :: fdb.options.set_trace_enable( output_directory=None )
|option-trace-enable-blurb|
@ -188,6 +192,48 @@ After importing the ``fdb`` module and selecting an API version, you probably wa
.. method :: fdb.options.set_tls_key_bytes(bytes)
|option-tls-key-bytes|
.. method :: fdb.options.set_tls_verify_peers(verification_pattern)
|option-tls-verify-peers|
.. method :: fdb.options.set_tls_ca_bytes(ca_bundle)
|option-tls-ca-bytes|
.. method :: fdb.options.set_tls_ca_path(path)
|option-tls-ca-path|
.. method :: fdb.options.set_tls_password(password)
|option-tls-password|
.. method :: fdb.options.set_disable_multi_version_client_api()
|option-disable-multi-version-client-api|
.. method :: fdb.options.set_disable_local_client()
|option-set-disable-local-client|
.. method :: fdb.options.set_ client_threads_per_version(number)
|option-set-client-threads-per-version|
.. method :: fdb.options.set_disable_client_statistics_logging()
|option-disable-client-statistics-logging|
.. method :: fdb.options.set_enable_run_loop_profiling()
|option-enable-run-loop-profiling|
.. method :: fdb.options.set_distributed_client_tracer(tracer_type)
|option-set-distributed-client-tracer|
Please refer to fdboptions.py (generated) for a comprehensive list of options.
.. _api-python-keys: