InfluxElixir.Admin.Databases (InfluxElixir v0.1.35)

Copy Markdown View Source

v3 database CRUD operations via /api/v3/configure/database.

Delegates to the configured InfluxElixir.Client implementation. In production this performs HTTP requests; in tests the LocalClient is used for fast, isolated operation.

Examples

{:ok, conn} = InfluxElixir.Client.Local.start()

:ok = InfluxElixir.Admin.Databases.create(conn, "my_db")
{:ok, dbs} = InfluxElixir.Admin.Databases.list(conn)
:ok = InfluxElixir.Admin.Databases.delete(conn, "my_db")

Summary

Functions

create(connection, name, opts \\ [])

Creates a database in InfluxDB v3.

delete(connection, name)

Deletes a database in InfluxDB v3.

list(connection)

Lists all databases in InfluxDB v3.

Functions

create(connection, name, opts \\ [])

@spec create(InfluxElixir.Client.connection(), binary(), keyword()) ::
  :ok | {:error, term()}

Creates a database in InfluxDB v3.

Parameters

  • connection - a client connection term
  • name - the database name to create
  • opts - optional keyword list:
    • :retention - retention period as a duration string, e.g. "30d", "1h 30m" or "1.5h" (units are case-sensitive: M months, m minutes); omit it for data that never expires. Anything else — an integer number of seconds, as a v2 bucket takes — is InfluxDB 3's 400 expected a duration, from Client.Local too

Returns

  • :ok on success
  • {:error, reason} on failure

delete(connection, name)

@spec delete(InfluxElixir.Client.connection(), binary()) :: :ok | {:error, term()}

Deletes a database in InfluxDB v3.

Parameters

  • connection - a client connection term
  • name - the database name to delete

Returns

  • :ok on success
  • {:error, reason} on failure

list(connection)

@spec list(InfluxElixir.Client.connection()) :: {:ok, [map()]} | {:error, term()}

Lists all databases in InfluxDB v3.

Parameters

  • connection - a client connection term

Returns

  • {:ok, [map()]} on success
  • {:error, reason} on failure