Feat/schema wasm (#295)

* feat: public schema() on WASM

* chore: 0.1.4

* chore: fix typo

Author: KKould

Cargo.lock

@@ -2,7 +2,7 @@
 
 [package]
 name          = "kite_sql"
-version       = "0.1.3"
+version       = "0.1.4"
 edition       = "2021"
 authors       = ["Kould <[email protected]>", "Xwg <[email protected]>"]
 description   = "SQL as a Function for Rust"

Cargo.toml

@@ -55,6 +55,8 @@ console.log(rows.map((r) => r.values.map((v) => v.Int32 ?? v)));
 ## Examples
 
 ```rust
+use kite_sql::db::{DataBaseBuilder, ResultIter};
+
 let kite_sql = DataBaseBuilder::path("./data").build()?;
 
 kite_sql
@@ -64,7 +66,13 @@ kite_sql
     .run("insert into t1 values(0, 0), (1, 1)")?
     .done()?;
 
-for tuple in kite_sql.run("select * from t1")? {
+let mut iter = kite_sql.run("select * from t1")?;
+
+// Query schema is available on every result iterator.
+let column_names: Vec<_> = iter.schema().iter().map(|c| c.name()).collect();
+println!("columns: {column_names:?}");
+
+for tuple in iter {
     println!("{:?}", tuple?);
 }
 ```

README.md

@@ -12,7 +12,16 @@ async function main() {
   await db.execute("create table my_struct (c1 int primary key, c2 int)");
   await db.execute("insert into my_struct values(0, 0), (1, 1)");
 
-  const rows = db.run("select * from my_struct").rows();
+  const iter = db.run("select * from my_struct");
+  const schema = iter.schema();
+  assert.deepEqual(
+    schema.map(({ name, datatype, nullable }) => ({ name, datatype, nullable })),
+    [
+      { name: "c1", datatype: "Integer", nullable: false },
+      { name: "c2", datatype: "Integer", nullable: true },
+    ],
+  );
+  const rows = iter.rows();
   assert.equal(rows.length, 2, "should return two rows");
 
   const [first, second] = rows;

examples/wasm_hello_world.test.mjs

@@ -13,6 +13,13 @@ struct WasmRow {
     values: Vec<DataValue>,
 }
 
+#[derive(Serialize)]
+struct WasmSchemaColumn {
+    name: String,
+    datatype: String,
+    nullable: bool,
+}
+
 fn to_js_err(err: impl ToString) -> JsValue {
     js_sys::Error::new(&err.to_string()).into()
 }
@@ -89,6 +96,26 @@ impl WasmResultIter {
         }
     }
 
+    /// Returns the output schema as an array of `{ name, datatype, nullable }`.
+    #[wasm_bindgen(js_name = schema)]
+    pub fn schema(&self) -> Result<JsValue, JsValue> {
+        let iter = self
+            .inner
+            .as_ref()
+            .ok_or_else(|| to_js_err("iterator already consumed"))?;
+        let columns: Vec<WasmSchemaColumn> = iter
+            .schema()
+            .iter()
+            .map(|col| WasmSchemaColumn {
+                name: col.name().to_string(),
+                datatype: col.datatype().to_string(),
+                nullable: col.nullable(),
+            })
+            .collect();
+        serde_wasm_bindgen::to_value(&columns)
+            .map_err(|e| to_js_err(format!("serialize schema: {e}")))
+    }
+
     /// Collect all remaining rows into an array and finish the iterator.
     #[wasm_bindgen(js_name = rows)]
     pub fn rows(&mut self) -> Result<JsValue, JsValue> {