Struct DataRecord 

pub struct DataRecord {
    pub id: Option<RecordId>,
    pub vectors: BTreeMap<String, DenseVector>,
    pub fields: Map<String, Value>,
}

Portable record payload used for inserts, updates, and query responses.

Use Self::without_id with the default LanceDB backend. Self::new supplies a logical ID only for implementations that support it; it does not enable logical-ID persistence on an unsupported backend.

Examples

use storage_kit::database::data::DataRecord;
let record = DataRecord::without_id().field("title", "Storage Kit")?;
assert_eq!(record.fields["title"], "Storage Kit");
assert!(record.id.is_none());

Fields

id: Option<RecordId>

Logical record identifier, when the selected backend supports ID persistence. Unsupported backends reject a populated ID rather than synthesizing one.

vectors: BTreeMap<String, DenseVector>

Named vector payloads stored with the record.

fields: Map<String, Value>

JSON document fields stored alongside vectors and the optional logical id.

Implementations

impl DataRecord

pub fn new(id: impl Into<RecordId>) -> Self

Creates a record with a logical id.

The selected backend must support logical IDs. For LanceDB, use Self::without_id and put the application identity in a normal field.

Examples

let record = storage_kit::database::data::DataRecord::new("doc-1");
assert_eq!(record.id.unwrap().as_string_lossy(), "doc-1");

pub fn without_id() -> Self

Creates a record without a logical id.

Examples

let record = storage_kit::database::data::DataRecord::without_id();
assert!(record.id.is_none());

pub fn field<T>( self, key: impl Into<String>, value: T, ) -> Result<Self, StorageError>

where T: Serialize,

Adds one serializable JSON field.

Examples

let record = storage_kit::database::data::DataRecord::without_id()
    .field("title", "Storage Kit")?;
assert_eq!(record.fields["title"], serde_json::json!("Storage Kit"));

Errors

Returns an error when the value cannot be serialized to JSON.

pub fn json_field(self, key: impl Into<String>, value: Value) -> Self

Adds one already-materialized JSON field.

Examples

let record = storage_kit::database::data::DataRecord::without_id()
    .json_field("title", serde_json::json!("Storage Kit"));
assert_eq!(record.fields["title"], serde_json::json!("Storage Kit"));

pub fn vector(self, key: impl Into<String>, vector: DenseVector) -> Self

Adds one named vector field.

Examples

let record = storage_kit::database::data::DataRecord::without_id().vector(
    "embedding",
    storage_kit::database::data::DenseVector::F32(vec![0.1, 0.2]),
);
assert_eq!(record.vectors.len(), 1);

Trait Implementations

impl Clone for DataRecord

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataRecord

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

Formats the value using the given formatter.

impl Default for DataRecord

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DataRecord

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DataRecord

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for DataRecord

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DataRecord