agdb 0.12.10

Agnesoft Graph Database
Documentation
pub mod insert;
pub mod insert_aliases;
pub mod insert_edge;
pub mod insert_index;
pub mod insert_nodes;
pub mod insert_values;
pub mod remove;
pub mod remove_aliases;
pub mod remove_ids;
pub mod remove_index;
pub mod remove_values;
pub mod search;
pub mod select;
pub mod select_aliases;
pub mod select_edge_count;
pub mod select_ids;
pub mod select_indexes;
pub mod select_key_count;
pub mod select_keys;
pub mod select_node_count;
pub mod select_values;
pub mod where_;

use self::insert::Insert;
use self::remove::Remove;
use self::search::Search;
use self::select::Select;
use crate::SearchQuery;

/// The starting point of all queries.
///
/// Options:
///
/// ```
/// use agdb::QueryBuilder;
///
/// QueryBuilder::insert();
/// QueryBuilder::remove();
/// QueryBuilder::search();
/// QueryBuilder::select();
/// ```
#[cfg_attr(feature = "api", derive(agdb::TypeDef))]
pub struct QueryBuilder;

#[cfg_attr(feature = "api", agdb::impl_def())]
impl QueryBuilder {
    /// Allows inserting data into the database:
    ///
    /// Options:
    ///
    /// ```
    /// use agdb::{DbId, QueryBuilder, DbType};
    ///
    /// #[derive(DbType)]
    /// struct MyValue { db_id: Option<DbId>, key: String }
    ///
    /// QueryBuilder::insert().nodes();
    /// QueryBuilder::insert().edges();
    /// QueryBuilder::insert().aliases("a");
    /// QueryBuilder::insert().aliases(["a", "b"]);
    /// QueryBuilder::insert().element(&MyValue { db_id: Some(DbId(1)), key: "a".to_string(), });
    /// QueryBuilder::insert().elements(&[MyValue { db_id: Some(DbId(1)), key: "a".to_string(), }]);
    /// QueryBuilder::insert().index("k");
    /// QueryBuilder::insert().values([[("k", 1).into()]]);
    /// QueryBuilder::insert().values_uniform([("k", 1).into()]);
    /// ```
    pub fn insert() -> Insert {
        Insert {}
    }

    /// Allows removing data from the database:
    ///
    /// Options:
    ///
    /// ```
    /// use agdb::QueryBuilder;
    ///
    /// QueryBuilder::remove().ids(1);
    /// QueryBuilder::remove().ids([1, 2]);
    /// QueryBuilder::remove().ids(QueryBuilder::search().from(1).query());
    /// QueryBuilder::remove().index("k");
    /// QueryBuilder::remove().aliases("a");
    /// QueryBuilder::remove().aliases(["a", "b"]);
    /// QueryBuilder::remove().values("k");
    /// ```
    pub fn remove() -> Remove {
        Remove {}
    }

    /// Search the database by traversing the graph
    /// and returns element ids using breadth first,
    /// depth first or A* algorithm:
    ///
    /// Options:
    ///
    /// ```
    /// use agdb::QueryBuilder;
    ///
    /// QueryBuilder::search().from(1); // BDS
    /// QueryBuilder::search().to(1); // BDS
    /// QueryBuilder::search().breadth_first();
    /// QueryBuilder::search().depth_first();
    /// QueryBuilder::search().elements();
    /// ```
    pub fn search() -> Search<SearchQuery> {
        Search(SearchQuery::new())
    }

    /// Selects data from the database:
    ///
    /// Options:
    ///
    /// ```
    /// use agdb::QueryBuilder;
    /// use agdb::DbType;
    /// use agdb::DbId;
    ///
    /// #[derive(DbType)]
    /// struct MyValue { db_id: Option<DbId>, key: String }
    ///
    /// QueryBuilder::select().ids(1);
    /// QueryBuilder::select().ids([1, 2]);
    /// QueryBuilder::select().ids(QueryBuilder::search().from(1).query());
    /// QueryBuilder::select().aliases();
    /// QueryBuilder::select().elements::<MyValue>();
    /// QueryBuilder::select().keys();
    /// QueryBuilder::select().key_count();
    /// QueryBuilder::select().node_count();
    /// QueryBuilder::select().values("k");
    /// ```
    pub fn select() -> Select {
        Select {}
    }
}