Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: retention period values in Namespace client 

Document the 0/null and negative value behaviours for retention periods
in the namespace RPC client.
pull/24376/head
Dom Dwyer 2023-02-01 14:39:18 +01:00
parent 52ac1b97a9
commit 77ff4dc4b8
No known key found for this signature in database
GPG Key ID: E4C40DBD9157879A
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
influxdb_iox_client/src/client/namespace.rs
View File

@ -33,8 +33,11 @@ impl Client {
/// Create a namespace
///
/// `retention_period_ns` is the the retention period in nanoseconds, measured from `now()`.
/// `None` represents infinite retention (i.e. never drop data).
/// `retention_period_ns` is the the retention period in nanoseconds,
/// measured from `now()`. `None` represents infinite retention (i.e. never
/// drop data), and 0 is also mapped to `None` on the server side.
///
/// Negative retention periods are rejected, returning an error.
pub async fn create_namespace(
&mut self,
namespace: &str,
@ -53,8 +56,11 @@ impl Client {
/// Update retention for a namespace
///
/// `retention_period_ns` is the the retention period in nanoseconds, measured from `now()`.
/// `None` represents infinite retention (i.e. never drop data).
/// `retention_period_ns` is the the retention period in nanoseconds,
/// measured from `now()`. `None` represents infinite retention (i.e. never
/// drop data), and 0 is also mapped to `None` on the server side.
///
/// Negative retention periods are rejected, returning an error.
pub async fn update_namespace_retention(
&mut self,
namespace: &str,