InfluxEx.Orgs (influx_ex v0.2.1)

Module for working with organizations in InfluxDB

Link to this section Summary

Types

Options for creating an org

Options for searching orgs

Functions

Get a list of orgs

Create a new org in the InfluxDB

Delete an org

Link to this section Types

Link to this type

create_org_opt()

@type create_org_opt() :: {:description, binary()}

Options for creating an org

Link to this type

search_opt()

@type search_opt() :: {:org, InfluxEx.Org.name()}

Options for searching orgs

Link to this section Functions

Link to this function

all(client, opts \\ [])

@spec all(InfluxEx.Client.t(), [search_opt()]) ::
  {:ok, InfluxEx.response_list(InfluxEx.Org)} | {:error, InfluxEx.error()}

Get a list of orgs

Optionally you can filter for an org by the org name by passing the :org option.

InfluxEx.orgs(client, org: "theorg")
Link to this function

create(client, org_name, opts \\ [])

@spec create(InfluxEx.Client.t(), InfluxEx.Org.name(), [create_org_opt()]) ::
  {:ok, InfluxEx.Org.t()} | {:error, InfluxEx.error()}

Create a new org in the InfluxDB

Link to this function

delete(client, org_id)

@spec delete(InfluxEx.Client.t(), InfluxEx.Org.id()) ::
  :ok | {:error, InfluxEx.error()}

Delete an org