v0.3.0-alpha

- project structure improvements
- documentation improvements

Author: git-user-cpp

Cargo.lock

@@ -1,7 +1,11 @@
 [package]
 name = "rapid_naive_sql"
-version = "0.2.1-alpha"
+version = "0.3.0-alpha"
+authors = ["Andrew Kushyk <akushyk799 at proton.me>"]
 edition = "2021"
+description = "Rapid Naive SQL is a database API designed for high-performance data management"
+license = "GPL-3.0-or-later"
+repository = "https://gitlab.com/git-user-cpp/rapid_naive_sql"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

Cargo.toml

@@ -1,42 +1,58 @@
 /*
  * NaiveSQL implemented in Rust.
  * Copyright (C) 2024  Andrew Kushyk
- * 
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+use super::table::Table;
 use std::collections::HashMap;
 
-use super::tables::table::Table;
-
+/// Creates database
+///
+/// # Examples
+///
+/// ```
+/// use rapid_naive_sql::RNSQL;
+/// use rapid_naive_sql::database::table::Table;
+///
+/// let mut project: RNSQL<String> = RNSQL::new();
+/// if let Some(database) = project.databases.get_mut("database name") {
+///     let tb1 = Table::create_table();
+///     database.add_table("table name", tb1);
+/// }
+/// ```
 #[derive(Debug)]
 pub struct Database<Value> {
     pub tables: HashMap<String, Table<Value>>,
 }
 
 impl<Value> Database<Value> {
+    /// Creates a database that holds tables
     pub fn create_database() -> Self {
         Self {
             tables: HashMap::new(),
         }
     }
 
+    /// Adds a table to the existing database
     pub fn add_table(&mut self, name: &str, table: Table<Value>) {
         self.tables.insert(name.to_string(), table);
     }
 
+    /// Removes a table from the existing database
     pub fn delete_table(&mut self, name: &str) {
         self.tables.remove(name);
     }
-}
+}

src/data/databases/tables/mod.rs

@@ -1,20 +1,21 @@
 /*
  * NaiveSQL implemented in Rust.
  * Copyright (C) 2024  Andrew Kushyk
- * 
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
 pub mod database;
-pub mod tables;
+pub mod row;
+pub mod table;

src/data/databases/tables/rows/mod.rs

@@ -1,40 +1,60 @@
 /*
  * NaiveSQL implemented in Rust.
  * Copyright (C) 2024  Andrew Kushyk
- * 
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
 use std::collections::HashMap;
 
+/// Creates row
+///
+/// # Examples
+///
+/// ```
+/// use rapid_naive_sql::RNSQL;
+///
+/// let mut project = RNSQL::new();
+///
+/// if let Some(database) = project.databases.get_mut("database name") {
+///     if let Some(table) = database.tables.get_mut("table name") {
+///         if let Some(row) = table.rows.get_mut(&1) {
+///             row.create_column("column name", String::from("hello"));
+///         }
+///     }
+/// }
+/// ```
 #[derive(Debug)]
 pub struct Row<Value> {
     pub columns: HashMap<String, Value>,
 }
 
 impl<Value> Row<Value> {
+    /// Creates a row that holds columns
     pub fn create_row() -> Self {
         Self {
             columns: HashMap::new(),
         }
     }
 
+    /// Adds a column to the existing row
     pub fn create_column(&mut self, name: &str, value: Value) {
         self.columns.insert(name.to_string(), value);
     }
 
+    /// Removes a column from the existing row
     pub fn delete_column(&mut self, name: &str) {
         self.columns.remove(name);
     }
-}
+}

src/data/mod.rs

@@ -1,41 +1,61 @@
 /*
  * NaiveSQL implemented in Rust.
  * Copyright (C) 2024  Andrew Kushyk
- * 
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+use super::row::Row;
 use std::collections::HashMap;
-use crate::data::databases::tables::rows::row::Row;
 
+/// Creates table
+///
+/// # Examples
+///
+/// ```
+/// use rapid_naive_sql::RNSQL;
+/// use rapid_naive_sql::database::row::Row;
+///
+/// let mut project: RNSQL<String> = RNSQL::new();
+///
+/// if let Some(database) = project.databases.get_mut("database name") {
+///     if let Some(table) = database.tables.get_mut("table name") {
+///         let rw1 = Row::create_row();
+///         table.add_row(1, rw1);
+///     }
+/// }
+/// ```
 #[derive(Debug)]
 pub struct Table<Value> {
     pub rows: HashMap<u32, Row<Value>>,
 }
 
 impl<Value> Table<Value> {
+    /// Creates a table that holds rows
     pub fn create_table() -> Self {
         Self {
             rows: HashMap::new(),
         }
     }
 
+    /// Adds a row to the existing table
     pub fn add_row(&mut self, primary_key: u32, row: Row<Value>) {
         self.rows.insert(primary_key, row);
     }
 
+    /// Removes a row from the existing table
     pub fn delete_row(&mut self, primary_key: u32) {
         self.rows.remove(&primary_key);
     }
-}
+}

src/data/databases/database.rs renamed to src/database/database.rs

@@ -1,17 +1,17 @@
 /*
  * NaiveSQL implemented in Rust.
  * Copyright (C) 2024  Andrew Kushyk
- * 
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- */
+ */