Struct TextFields 

pub struct TextFields {

    pub auth: Option<AuthMethod>,
    pub sql: Option<String>,
    pub key: Option<String>,
    pub value: Option<String>,
    pub collection: Option<String>,
    pub document_id: Option<String>,
    pub data: Option<Vec<u8>>,
    pub query_vector: Option<Vec<f32>>,
    pub top_k: Option<u32>,
    pub field: Option<String>,
    pub limit: Option<u64>,
    pub delta: Option<Vec<u8>>,
    pub peer_id: Option<u64>,
    pub vector_top_k: Option<u32>,
    pub edge_label: Option<String>,
    pub direction: Option<String>,
    pub expansion_depth: Option<u32>,
    pub final_top_k: Option<u32>,
    pub vector_k: Option<f64>,
    pub graph_k: Option<f64>,
    pub vector_field: Option<String>,
    pub start_node: Option<String>,
    pub end_node: Option<String>,
    pub depth: Option<u32>,
    pub from_node: Option<String>,
    pub to_node: Option<String>,
    pub edge_type: Option<String>,
    pub properties: Option<Value>,
    pub query_text: Option<String>,
    pub vector_weight: Option<f64>,
    pub fuzzy: Option<bool>,
    pub ef_search: Option<u32>,
    pub field_name: Option<String>,
    pub lower_bound: Option<Vec<u8>>,
    pub upper_bound: Option<Vec<u8>>,
    pub mutation_id: Option<u64>,
    pub vectors: Option<Vec<BatchVector>>,
    pub documents: Option<Vec<BatchDocument>>,
    pub query_geometry: Option<Vec<u8>>,
    pub spatial_predicate: Option<String>,
    pub distance_meters: Option<f64>,
    pub payload: Option<Vec<u8>>,
    pub format: Option<String>,
    pub time_range_start: Option<i64>,
    pub time_range_end: Option<i64>,
    pub bucket_interval: Option<String>,
    pub ttl_ms: Option<u64>,
    pub cursor: Option<Vec<u8>>,
    pub match_pattern: Option<String>,
    pub keys: Option<Vec<Vec<u8>>>,
    pub entries: Option<Vec<(Vec<u8>, Vec<u8>)>>,
    pub fields: Option<Vec<String>>,
    pub incr_delta: Option<i64>,
    pub incr_float_delta: Option<f64>,
    pub expected: Option<Vec<u8>>,
    pub new_value: Option<Vec<u8>>,
    pub index_name: Option<String>,
    pub sort_columns: Option<Vec<(String, String)>>,
    pub key_column: Option<String>,
    pub window_type: Option<String>,
    pub window_timestamp_column: Option<String>,
    pub window_start_ms: Option<u64>,
    pub window_end_ms: Option<u64>,
    pub top_k_count: Option<u32>,
    pub score_min: Option<Vec<u8>>,
    pub score_max: Option<Vec<u8>>,
    pub updates: Option<Vec<(String, Vec<u8>)>>,
    pub filters: Option<Vec<u8>>,
    pub vector: Option<Vec<f32>>,
    pub vector_id: Option<u64>,
    pub policy: Option<Value>,
    pub algorithm: Option<String>,
    pub match_query: Option<String>,
    pub algo_params: Option<Value>,
    pub index_paths: Option<Vec<String>>,
    pub source_collection: Option<String>,
    pub field_position: Option<u64>,
    pub backfill: Option<bool>,
    pub m: Option<u16>,
    pub ef_construction: Option<u16>,
    pub metric: Option<String>,
    pub index_type: Option<String>,
    pub database: Option<String>,
    pub sql_params: Option<Vec<Value>>,
}

Catch-all text fields used by most operations.

Each operation uses a subset; unused fields default to None/empty.

Wire format: MsgPack map with u16 numeric field IDs. None fields are omitted. Unknown keys are ignored by the decoder (forward-compat).

Fields

auth: Option<AuthMethod>

sql: Option<String>

key: Option<String>

value: Option<String>

collection: Option<String>

document_id: Option<String>

data: Option<Vec<u8>>

query_vector: Option<Vec<f32>>

top_k: Option<u32>

field: Option<String>

limit: Option<u64>

delta: Option<Vec<u8>>

peer_id: Option<u64>

vector_top_k: Option<u32>

edge_label: Option<String>

direction: Option<String>

expansion_depth: Option<u32>

final_top_k: Option<u32>

vector_k: Option<f64>

graph_k: Option<f64>

vector_field: Option<String>

start_node: Option<String>

end_node: Option<String>

depth: Option<u32>

from_node: Option<String>

to_node: Option<String>

edge_type: Option<String>

properties: Option<Value>

query_text: Option<String>

vector_weight: Option<f64>

fuzzy: Option<bool>

ef_search: Option<u32>

field_name: Option<String>

Named vector field (for multi-field vector collections).

lower_bound: Option<Vec<u8>>

upper_bound: Option<Vec<u8>>

mutation_id: Option<u64>

Monotonic mutation ID for CRDT delta deduplication.

vectors: Option<Vec<BatchVector>>

documents: Option<Vec<BatchDocument>>

query_geometry: Option<Vec<u8>>

Query geometry as GeoJSON bytes (for SpatialScan).

spatial_predicate: Option<String>

Spatial predicate name: “dwithin”, “contains”, “intersects”, “within”.

distance_meters: Option<f64>

Distance threshold in meters (for ST_DWithin).

payload: Option<Vec<u8>>

ILP payload bytes (for TimeseriesIngest).

format: Option<String>

Ingest format (default: “ilp”).

time_range_start: Option<i64>

Time range start (epoch ms, for TimeseriesScan).

time_range_end: Option<i64>

Time range end (epoch ms, for TimeseriesScan).

bucket_interval: Option<String>

Bucket interval string for time_bucket aggregation (e.g., “5m”).

ttl_ms: Option<u64>

TTL in milliseconds (for KvExpire, KvBatchPut).

cursor: Option<Vec<u8>>

Cursor bytes for KvScan pagination.

match_pattern: Option<String>

Glob pattern for KvScan key matching.

keys: Option<Vec<Vec<u8>>>

Multiple keys for BatchGet / Delete.

entries: Option<Vec<(Vec<u8>, Vec<u8>)>>

Key-value entries for BatchPut: [(key, value), …].

fields: Option<Vec<String>>

Field names for FieldGet.

incr_delta: Option<i64>

Integer delta for KvIncr.

incr_float_delta: Option<f64>

Float delta for KvIncrFloat.

expected: Option<Vec<u8>>

Expected value for KvCas.

new_value: Option<Vec<u8>>

New value for KvCas / KvGetSet.

index_name: Option<String>

Sorted index name.

sort_columns: Option<Vec<(String, String)>>

Sort columns: [(column_name, direction), …].

key_column: Option<String>

Primary key column for sorted index.

window_type: Option<String>

Window type for sorted index: “none”, “daily”, “weekly”, “monthly”, “custom”.

window_timestamp_column: Option<String>

Timestamp column for windowed sorted index.

window_start_ms: Option<u64>

Custom window start (ms since epoch).

window_end_ms: Option<u64>

Custom window end (ms since epoch).

top_k_count: Option<u32>

Top-K value for SortedIndexTopK.

score_min: Option<Vec<u8>>

Score min for SortedIndexRange (encoded bytes).

score_max: Option<Vec<u8>>

Score max for SortedIndexRange (encoded bytes).

updates: Option<Vec<(String, Vec<u8>)>>

Field-level updates: [(field_name, value_bytes), …].

filters: Option<Vec<u8>>

Serialized filter predicates (MessagePack).

vector: Option<Vec<f32>>

Single vector embedding (for VectorInsert).

vector_id: Option<u64>

Vector ID for deletion. Wire type is u64 to accommodate future range expansion; the server narrows to u32 via the surrogate space check.

policy: Option<Value>

algorithm: Option<String>

Algorithm name for GraphAlgo (e.g., “pagerank”, “wcc”, “sssp”).

match_query: Option<String>

Cypher-subset MATCH query string for GraphMatch.

algo_params: Option<Value>

Algorithm-specific parameters (JSON object).

index_paths: Option<Vec<String>>

Index paths for DocumentRegister.

source_collection: Option<String>

Source collection for InsertSelect.

field_position: Option<u64>

Field position in tuple for KvRegisterIndex.

backfill: Option<bool>

Whether to backfill existing keys on index creation.

m: Option<u16>

HNSW M parameter (max connections per layer).

ef_construction: Option<u16>

HNSW ef_construction parameter.

metric: Option<String>

Distance metric name (“cosine”, “euclidean”, “dot”).

index_type: Option<String>

Index type (“hnsw”, “hnsw_pq”, “ivf_pq”).

database: Option<String>

Target database name sent in the Auth handshake frame.

Field ID 83. None = server default (DatabaseId::DEFAULT). The server binds this to the session’s current_database at handshake time so every subsequent operation runs in this database context without per-request overhead.

sql_params: Option<Vec<Value>>

Caller-supplied bound parameters for $1, $2, … placeholders in sql.

Field ID 84. None (or empty) = no bound parameters; the server runs the SQL as-is. When Some, the server inlines each value as a SQL literal before planning. The wire encoding is Vec<Value> written via the generic zerompk array implementation — Value has its own hand-rolled ToMessagePack/FromMessagePack so the canonical scalar variants (Null, Bool, Integer, Float, String, Bytes) round-trip without a lossy intermediate JSON step.

We carry Vec<Value> directly rather than Vec<u8> of a pre-serialised inner blob because zerompk’s generic ToMessagePack for Vec<T> writes a MessagePack array (length header + each element via T::write), which round-trips cleanly with the symmetric Vec::<Value>::read. A pre-serialised Vec<u8> carried in this field would be re-encoded as an array-of-u8 on the way out and fail to decode as binary on the way in — exactly the silent-drop pattern this field is added to close.

Trait Implementations

impl Clone for TextFields

fn clone(&self) -> TextFields

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextFields

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TextFields

fn default() -> TextFields

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextFields

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> FromMessagePack<'a> for TextFields

fn read<R: Read<'a>>(reader: &mut R) -> Result<Self>

Reads the MessagePack representation of this value from the provided reader.

impl Serialize for TextFields

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToMessagePack for TextFields

fn write<W: Write>(&self, writer: &mut W) -> Result<()>

Writes the MessagePack representation of this value into the provided writer.