lix 0.17.1

Embeddable version control for apps and AI agents.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

pub(crate) mod error;
pub(crate) mod exact_batch;
mod execution_metadata;
pub(crate) mod identity;
pub(crate) mod json_pointer;
pub(crate) mod lix_path;
pub(crate) mod metadata;
pub(crate) mod read_retry;
mod read_budget;
pub(crate) use read_budget::{ReadResultBudget, with_read_deadline};
#[cfg(test)]
pub(crate) use read_budget::{MAX_READ_RESULT_BYTES, MAX_READ_RESULT_ROWS};
pub(crate) mod string_dictionary;
pub(crate) mod timestamp;
pub(crate) mod types;
pub(crate) mod wire;

pub use error::LixError;
pub(crate) use exact_batch::{ExactBatch, ExactValue};
pub use execution_metadata::{ExecuteStatementMetadata, MutationIdentity, RequestBlobSpliceProvenance};
#[cfg(feature = "server-protocol")]
pub(crate) use execution_metadata::VerifiedRequestBlob;
pub use identity::{BranchId, CanonicalPluginKey, CanonicalSchemaKey, FileId};
pub(crate) use identity::{json_pointer_get, validate_non_empty_identity_value};
pub(crate) use json_pointer::format_json_pointer;
#[cfg(test)]
pub(crate) use json_pointer::parse_json_pointer;
pub use lix_path::{LixPath, validate_lix_path_segment};
pub(crate) use lix_path::{compose_directory_path, compose_file_path};
pub(crate) use metadata::{
    parse_row_metadata_value, serialize_row_metadata, validate_row_metadata,
};
pub(crate) use read_retry::ExpiredReadRetryState;
pub(crate) use string_dictionary::{
    FastHashBuilder, StringDictionary, StringDictionaryBuilder, fast_hash_builder,
};
pub(crate) use timestamp::LixTimestamp;
pub use types::{
    Blob, Json, LixNotice, NullableKeyFilter, ResultColumnType, RowRef, SharedStr, SqlQueryResult,
    Value,
};
pub use wire::{WireQueryResult, WireValue};

/// Renders a JSON value through the public SQL string-column coercion.
///
/// Registered schemas are validated separately. The SQL surface has
/// historically kept malformed stored values readable by coercing any
/// non-null JSON scalar or container to text, so native indexes and joins
/// must use this exact representation too.
pub(crate) fn json_value_to_string(value: &serde_json::Value) -> Result<Option<String>, LixError> {
    Ok(match value {
        serde_json::Value::Null => None,
        serde_json::Value::String(value) => Some(value.clone()),
        serde_json::Value::Bool(value) => Some(value.to_string()),
        serde_json::Value::Number(value) => Some(value.to_string()),
        serde_json::Value::Array(_) | serde_json::Value::Object(_) => {
            Some(serde_json::to_string(value).map_err(|error| {
                LixError::new(
                    LixError::CODE_INTERNAL_ERROR,
                    format!("failed to render JSON string value: {error}"),
                )
            })?)
        }
    })
}