github/sprockets-influxdb
1
0
Fork 0
mirror of https://github.com/sprockets/sprockets-influxdb.git synced 2024-11-15 03:00:24 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update the docstring values for defaults in install

Browse source
This commit is contained in:
Gavin M. Roy 2016-11-09 15:53:26 -05:00
parent f671b7029c
commit a4c601d69b
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
sprockets_influxdb.py
View file

@ -217,15 +217,16 @@ def install(url=None, auth_username=None, auth_password=None, io_loop=None,
after the last batch submission before submitting a batch that is after the last batch submission before submitting a batch that is
smaller than ``trigger_size``. Default: ``60000`` smaller than ``trigger_size``. Default: ``60000``
:param int max_batch_size: The number of measurements to be submitted in a :param int max_batch_size: The number of measurements to be submitted in a
single HTTP request. Default: ``1000`` single HTTP request. Default: ``10000``
:param int max_clients: The number of simultaneous batch submissions that :param int max_clients: The number of simultaneous batch submissions that
may be made at any given time. Default: ``10`` may be made at any given time. Default: ``10``
:param dict base_tags: Default tags that are to be submitted with each :param dict base_tags: Default tags that are to be submitted with each
measurement. Default: ``None`` measurement. Default: ``None``
:param int max_buffer_size: The maximum number of pending measurements :param int max_buffer_size: The maximum number of pending measurements
in the buffer before new measurements are discarded. in the buffer before new measurements are discarded.
Default: ``25000``
:param int trigger_size: The minimum number of measurements that :param int trigger_size: The minimum number of measurements that
are in the buffer before a batch can be submitted. are in the buffer before a batch can be submitted. Default: ``5000``
:returns: :data:`True` if the client was installed by this call :returns: :data:`True` if the client was installed by this call
and :data:`False` otherwise. and :data:`False` otherwise.