View Source Xandra.Prepared (Xandra v0.18.1)

A data structure used to internally represent prepared queries.

See %Xandra.Prepared{} for information about which fields are public. All other fields are documented in t/0 to avoid Dialyzer warnings, but are not meant to be used by users.

Summary

Types

t()

The type for a prepared query.

Functions

%Xandra.Prepared{}

A struct that represents a prepared query.

Types

Link to this type

t()

View Source 
@type t() :: %Xandra.Prepared{
  bound_columns: [Xandra.Page.column()] | nil,
  compressor: module() | nil,
  default_consistency: atom() | nil,
  id: binary() | nil,
  keyspace: binary() | nil,
  protocol_module: module() | nil,
  request_custom_payload: Xandra.custom_payload() | nil,
  response_custom_payload: Xandra.custom_payload() | nil,
  result_columns: list() | nil,
  result_metadata_id: binary() | nil,
  statement: Xandra.statement(),
  tracing_id: binary() | nil,
  values: Xandra.values() | nil
}

The type for a prepared query.

The only public fields here are :tracing_id and :response_custom_payload. See %Xandra.Prepared{}.

Functions

Link to this function

%Xandra.Prepared{}

View Source (struct)

A struct that represents a prepared query.

These are the publicly-accessible fields of this struct:

  • :tracing_id - the tracing ID (as a UUID binary) if tracing was enabled, or nil if no tracing was enabled. See the "Tracing" section in Xandra.execute/4.

  • :response_custom_payload - the custom payload sent by the server, if present. If the server doesn't send a custom payload, this field is nil. Otherwise, it's of type Xandra.custom_payload/0. See the "Custom payloads" section in the documentation for the Xandra module.