docx-store 0.1.5

Storage models and schema helpers for docx-mcp.
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

pub const TABLE_PROJECT: &str = "project";
pub const TABLE_INGEST: &str = "ingest";
pub const TABLE_DOC_SOURCE: &str = "doc_source";
pub const TABLE_SYMBOL: &str = "symbol";
pub const TABLE_DOC_BLOCK: &str = "doc_block";
pub const TABLE_DOC_CHUNK: &str = "doc_chunk";

pub const REL_CONTAINS: &str = "contains";
pub const REL_MEMBER_OF: &str = "member_of";
pub const REL_DOCUMENTS: &str = "documents";
pub const REL_REFERENCES: &str = "references";
pub const REL_SEE_ALSO: &str = "see_also";
pub const REL_INHERITS: &str = "inherits";
pub const REL_IMPLEMENTS: &str = "implements";
pub const REL_OVERLOAD_OF: &str = "overload_of";
pub const REL_TYPE_OF: &str = "type_of";
pub const REL_RETURNS: &str = "returns";
pub const REL_PARAM_TYPE: &str = "param_type";
pub const REL_OBSERVED_IN: &str = "observed_in";

pub const SOURCE_KIND_CSHARP_XML: &str = "csharp_xml";
pub const SOURCE_KIND_RUSTDOC_JSON: &str = "rustdoc_json";
pub const SOURCE_KIND_DOXYGEN_XML: &str = "doxygen_xml";

/// Initial schema migration applied by the runtime.
///
/// Schema migrations live in `schema/*.surql`, with `M0001_INIT.surql` defining
/// the full initial model.
pub const SCHEMA_BOOTSTRAP_SURQL: &str = include_str!("../schema/M0001_INIT.surql");

/// Formats a `SurrealDB` record id string for the given table and id.
#[must_use]
pub fn make_record_id(table: &str, id: &str) -> String {
    format!("{table}:{id}")
}

#[must_use]
pub fn make_symbol_key(language: &str, project_id: &str, local_id: &str) -> String {
    format!("{language}|{project_id}|{local_id}")
}

#[must_use]
pub fn make_csharp_symbol_key(project_id: &str, doc_id: &str) -> String {
    make_symbol_key("csharp", project_id, doc_id)
}