Skip to main content

TextFields

Struct TextFields 

Source
pub struct TextFields {
Show 81 fields 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<u64>, pub field: Option<String>, pub limit: Option<u64>, pub delta: Option<Vec<u8>>, pub peer_id: Option<u64>, pub vector_top_k: Option<u64>, pub edge_label: Option<String>, pub direction: Option<String>, pub expansion_depth: Option<u64>, pub final_top_k: Option<u64>, pub vector_k: Option<f64>, pub graph_k: Option<f64>, pub start_node: Option<String>, pub end_node: Option<String>, pub depth: Option<u64>, 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<u64>, 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<u32>, 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<u64>, pub ef_construction: Option<u64>, pub metric: Option<String>, pub index_type: Option<String>,
}
Expand description

Catch-all text fields used by most operations.

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

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<u64>§field: Option<String>§limit: Option<u64>§delta: Option<Vec<u8>>§peer_id: Option<u64>§vector_top_k: Option<u64>§edge_label: Option<String>§direction: Option<String>§expansion_depth: Option<u64>§final_top_k: Option<u64>§vector_k: Option<f64>§graph_k: Option<f64>§start_node: Option<String>§end_node: Option<String>§depth: Option<u64>§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<u64>§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<u32>

Vector ID for deletion.

§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<u64>

HNSW M parameter (max connections per layer).

§ef_construction: Option<u64>

HNSW ef_construction parameter.

§metric: Option<String>

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

§index_type: Option<String>

Index type (“hnsw”, “ivfpq”, “flat”).

Trait Implementations§

Source§

impl Clone for TextFields

Source§

fn clone(&self) -> TextFields

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextFields

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TextFields

Source§

fn default() -> TextFields

Returns the “default value” for a type. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

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

Source§

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

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

impl Serialize for TextFields

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl ToMessagePack for TextFields

Source§

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

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> FromMessagePackOwned for T
where T: for<'a> FromMessagePack<'a>,