Bigtable v0.1.0 Bigtable.ReadRows View Source

Provides functions to build Google.Bigtable.V2.ReadRowsRequest and submit them to Bigtable.

Link to this section Summary

Functions

Builds a Google.Bigtable.V2.ReadRowsRequest with the configured table name

Builds a Google.Bigtable.V2.ReadRowsRequest with a provided table name

Submits a Google.Bigtable.V2.ReadRowsRequest to Bigtable

Submits a Google.Bigtable.V2.ReadRowsRequest to Bigtable

Link to this section Functions

Link to this function

build() View Source
build() :: Google.Bigtable.V2.ReadRowsRequest.t()

Builds a Google.Bigtable.V2.ReadRowsRequest with the configured table name.

Examples

iex> Bigtable.ReadRows.build()
%Google.Bigtable.V2.ReadRowsRequest{
  app_profile_id: "",
  filter: nil,
  rows: nil,
  rows_limit: 0,
  table_name: "projects/dev/instances/dev/tables/test"
}
Link to this function

build(table_name) View Source
build(binary()) :: Google.Bigtable.V2.ReadRowsRequest.t()

Builds a Google.Bigtable.V2.ReadRowsRequest with a provided table name.

Examples

iex> table_name = "projects/[project_id]/instances/[instnace_id]/tables/[table_name]"
iex> Bigtable.ReadRows.build(table_name)
%Google.Bigtable.V2.ReadRowsRequest{
  app_profile_id: "",
  filter: nil,
  rows: nil,
  rows_limit: 0,
  table_name: "projects/[project_id]/instances/[instnace_id]/tables/[table_name]"
}
Link to this function

read() View Source
read() ::
  {:error, GRPC.RPCError.t()} | [{:ok, Google.Bigtable.V2.ReadRowsResponse.t()}]

Submits a Google.Bigtable.V2.ReadRowsRequest to Bigtable.

Without arguments, Bigtable.ReadRows.read will read all rows from the configured table.

Returns a list of {:ok, %Google.Bigtable.V2.ReadRowsResponse{}}.

Link to this function

read(request) View Source
read(Google.Bigtable.V2.ReadRowsRequest.t()) ::
  {:error, GRPC.RPCError.t()} | [{:ok, Google.Bigtable.V2.ReadRowsResponse.t()}]
read(binary()) ::
  {:error, GRPC.RPCError.t()} | [{:ok, Google.Bigtable.V2.ReadRowsResponse.t()}]

Submits a Google.Bigtable.V2.ReadRowsRequest to Bigtable.

Can be called with either a Google.Bigtable.V2.ReadRowsRequest or a table name to read all rows from a non-configured table.

Returns a list of {:ok, %Google.Bigtable.V2.ReadRowsResponse{}}.