InflexDB v0.1.2 InflexDB View Source

Checkout InflexDB.Client on how to instantiate and configure a client.

Link to this section Summary

Functions

Creates a new database.

Deletes all of the data, measurements, series, continuous queries, and retention policies from the specified database. If you attempt to drop a database that does not exist, InfluxDB does not return an error.

list_databases(client)

Returns a list of all databases on your instance.

ping(client)

Check the status of yout InfluxDB instance.

query(client, db, query)

Query data with a SELECT statement.

write_point(client, db, point)

Write a single point to a pre-existing database.

write_points(client, db, points)

Write points to a pre-existing database.

Link to this section Types

error_response()

error_response() ::
  {:error, InflexDB.HTTPResponse.t()}
  | {:error, :econnrefused}
  | {:error, term()}

Link to this section Functions

create_database(client, name)

create_database(client :: InflexDB.Client.t(), name :: String.t()) ::
  :ok | error_response()

Creates a new database.

Example

client = %InflexDB.Client{}

InflexDB.create_database(client, "mydb")

delete_database(client, name)

delete_database(client :: InflexDB.Client.t(), name :: String.t()) ::
  :ok | error_response()

Example

client = %InflexDB.Client{}

InflexDB.delete_database(client, "mydb")

list_databases(client)

list_databases(client :: InflexDB.Client.t()) ::
  {:ok, [String.t()]} | error_response()

Returns a list of all databases on your instance.

client = %InflexDB.Client{}

InflexDB.list_databases(client)
# {:ok, ["_internal", "mydb"]}

ping(client)

ping(client :: InflexDB.Client.t()) :: :ok | error_response()

Check the status of yout InfluxDB instance.

Example

client = %InflexDB.Client{}

InflexDB.ping(client)

query(client, db, query)

query(client :: InflexDB.Client.t(), db :: String.t(), query :: String.t()) ::
  {:ok, map()} | error_response()

Query data with a SELECT statement.

Example

client = %InflexDB.Client{}

InflexDB.query(client, "mydb", "SELECT * FROM weather")
# {:ok,
#  [
#    %{
#      name: "weather",
#      statement_id: 0,
#      tags: nil,
#      values: [
#        %{
#          "location" => "us-midwest",
#          "season" => "summer",
#          "temperature" => 82,
#          "time" => "2020-03-29T20:34:46.725338219Z"
#        },
#        %{
#          "season" => "summer",
#          "location" => "us-east",
#          "temperature" => 879,
#          "time" => "2020-03-29T20:40:46.790074049Z"
#        }
#      ]
#    }
#  ]}

Multiple SELECT statements are also supported:

client = %Inflex.Client{}
statement = "SELECT * FROM weather group by location; SELECT * from weather2 group by season"

InflexDB.query(client, "mydb", statement)
# {:ok,
#  [
#    %{
#      name: "weather",
#      statement_id: 0,
#      tags: %{"location" => "us-east"},
#      values: [
#        %{
#          "season" => "summer",
#          "temperature" => 879,
#          "time" => "2020-03-29T20:40:46.790074049Z"
#        },
#        %{
#          "season" => "winter",
#          "temperature" => 8096,
#          "time" => "2020-03-29T20:40:46.790074049Z"
#        }
#      ]
#    },
#    %{
#      name: "weather",
#      statement_id: 0,
#      tags: %{"location" => "us-midwest"},
#      values: [
#        %{
#          "season" => "summer",
#          "temperature" => 82,
#          "time" => "2020-03-29T20:34:46.725338219Z"
#        },
#        %{
#          "season" => "summer",
#          "temperature" => 82,
#          "time" => "2020-03-29T20:35:15.531091771Z"
#        }
#      ]
#    },
#    %{
#      name: "weather2",
#      statement_id: 1,
#      tags: %{"season" => "summer"},
#      values: [
#        %{
#          "location" => "us-east",
#          "temperature" => 842,
#          "time" => "2020-03-29T20:59:41.755035346Z"
#        },
#        %{
#          "location" => "us-midwest",
#          "temperature" => 2342,
#          "time" => "2020-03-29T20:59:41.755035346Z"
#        }
#      ]
#    },
#    %{
#      name: "weather2",
#      statement_id: 1,
#      tags: %{"season" => "winter"},
#      values: [
#        %{
#          "location" => "us-east",
#          "temperature" => 7554,
#          "time" => "2020-03-29T20:59:41.755035346Z"
#        },
#        %{
#          "location" => "us-midwest",
#          "temperature" => 5473,
#          "time" => "2020-03-29T20:59:41.755035346Z"
#        }
#      ]
#    }
#  ]}

write_point(client, db, point)

write_point(
  client :: InflexDB.Client.t(),
  db :: String.t(),
  point :: InflexDB.Point.t()
) :: :ok | error_response()

Write a single point to a pre-existing database.

Example

client = %InflexDB.Client{}

point = %Point{
  measurement: "weather",
  tag_set: %{location: "us-midwest"},
  field_set: %{temperature: 82}
}

InflexDB.write_point(client, "mydb", point)

write_points(client, db, points)

write_points(
  client :: InflexDB.Client.t(),
  db :: String.t(),
  points :: [InflexDB.Point.t()]
) :: :ok | error_response()

Write points to a pre-existing database.

Example

client = %InflexDB.Client{}

points = [
  %Point{
    measurement: "weather",
    tag_set: %{location: "us-midwest"},
    field_set: %{temperature: 82}
  },
  %Point{
    measurement: "weather",
    tag_set: %{location: "us-midwest"},
    field_set: %{temperature: 76}
  }
]

InflexDB.write_points(client, "mydb", points)