feat: rework NodeJS SDK using napi (#847)

Use Napi to write a Node.js SDK that follows Polars for better
maintainability, while keeping most of the logic in Rust.

nodejs/src/connection.rs

@@ -0,0 +1,86 @@
+// Copyright 2024 Lance Developers.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::sync::Arc;
+
+use napi::bindgen_prelude::*;
+use napi_derive::*;
+
+use crate::table::Table;
+use vectordb::connection::{Connection as LanceDBConnection, Database};
+use vectordb::ipc::ipc_file_to_batches;
+
+#[napi]
+pub struct Connection {
+    conn: Arc<dyn LanceDBConnection>,
+}
+
+#[napi]
+impl Connection {
+    /// Create a new Connection instance from the given URI.
+    #[napi(factory)]
+    pub async fn new(uri: String) -> napi::Result<Self> {
+        Ok(Self {
+            conn: Arc::new(Database::connect(&uri).await.map_err(|e| {
+                napi::Error::from_reason(format!("Failed to connect to database: {}", e))
+            })?),
+        })
+    }
+
+    /// List all tables in the dataset.
+    #[napi]
+    pub async fn table_names(&self) -> napi::Result<Vec<String>> {
+        self.conn
+            .table_names()
+            .await
+            .map_err(|e| napi::Error::from_reason(format!("{}", e)))
+    }
+
+    /// Create table from a Apache Arrow IPC (file) buffer.
+    ///
+    /// Parameters:
+    /// - name: The name of the table.
+    /// - buf: The buffer containing the IPC file.
+    ///
+    #[napi]
+    pub async fn create_table(&self, name: String, buf: Buffer) -> napi::Result<Table> {
+        let batches = ipc_file_to_batches(buf.to_vec())
+            .map_err(|e| napi::Error::from_reason(format!("Failed to read IPC file: {}", e)))?;
+        let tbl = self
+            .conn
+            .create_table(&name, Box::new(batches), None)
+            .await
+            .map_err(|e| napi::Error::from_reason(format!("{}", e)))?;
+        Ok(Table::new(tbl))
+    }
+
+    #[napi]
+    pub async fn open_table(&self, name: String) -> napi::Result<Table> {
+        let tbl = self
+            .conn
+            .open_table(&name)
+            .await
+            .map_err(|e| napi::Error::from_reason(format!("{}", e)))?;
+        Ok(Table::new(tbl))
+    }
+
+    /// Drop table with the name. Or raise an error if the table does not exist.
+    #[napi]
+    pub async fn drop_table(&self, name: String) -> napi::Result<()> {
+        self.conn
+            .drop_table(&name)
+            .await
+            .map_err(|e| napi::Error::from_reason(format!("{}", e)))
+    }
+}

nodejs/src/lib.rs

@@ -0,0 +1,46 @@
+// Copyright 2024 Lance Developers.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use connection::Connection;
+use napi_derive::*;
+
+mod connection;
+mod query;
+mod table;
+
+#[napi(object)]
+pub struct ConnectionOptions {
+    pub uri: String,
+    pub api_key: Option<String>,
+    pub host_override: Option<String>,
+}
+
+/// Write mode for writing a table.
+#[napi(string_enum)]
+pub enum WriteMode {
+    Create,
+    Append,
+    Overwrite,
+}
+
+/// Write options when creating a Table.
+#[napi(object)]
+pub struct WriteOptions {
+    pub mode: Option<WriteMode>,
+}
+
+#[napi]
+pub async fn connect(options: ConnectionOptions) -> napi::Result<Connection> {
+    Connection::new(options.uri.clone()).await
+}

nodejs/src/query.rs

@@ -0,0 +1,48 @@
+// Copyright 2024 Lance Developers.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use napi::bindgen_prelude::*;
+use napi_derive::napi;
+use vectordb::query::Query as LanceDBQuery;
+
+use crate::table::Table;
+
+#[napi]
+pub struct Query {
+    inner: LanceDBQuery,
+}
+
+#[napi]
+impl Query {
+    pub fn new(table: &Table) -> Self {
+        Self {
+            inner: table.table.query(),
+        }
+    }
+
+    #[napi]
+    pub fn vector(&mut self, vector: Float32Array) {
+        let inn = self.inner.clone().query_vector(&vector);
+        self.inner = inn;
+    }
+
+    #[napi]
+    pub fn to_arrow(&self) -> napi::Result<()> {
+        // let buf = self.inner.to_arrow().map_err(|e| {
+        //     napi::Error::from_reason(format!("Failed to convert query to arrow: {}", e))
+        // })?;
+        // Ok(buf)
+        todo!()
+    }
+}

nodejs/src/table.rs

@@ -0,0 +1,81 @@
+// Copyright 2024 Lance Developers.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use crate::query::Query;
+use arrow_ipc::writer::FileWriter;
+use napi::bindgen_prelude::*;
+use napi_derive::napi;
+use vectordb::{ipc::ipc_file_to_batches, table::Table as LanceDBTable};
+
+#[napi]
+pub struct Table {
+    pub(crate) table: LanceDBTable,
+}
+
+#[napi]
+impl Table {
+    pub(crate) fn new(table: LanceDBTable) -> Self {
+        Self { table }
+    }
+
+    /// Return Schema as empty Arrow IPC file.
+    #[napi]
+    pub fn schema(&self) -> napi::Result<Buffer> {
+        let mut writer = FileWriter::try_new(vec![], &self.table.schema())
+            .map_err(|e| napi::Error::from_reason(format!("Failed to create IPC file: {}", e)))?;
+        writer
+            .finish()
+            .map_err(|e| napi::Error::from_reason(format!("Failed to finish IPC file: {}", e)))?;
+        Ok(Buffer::from(writer.into_inner().map_err(|e| {
+            napi::Error::from_reason(format!("Failed to get IPC file: {}", e))
+        })?))
+    }
+
+    #[napi]
+    pub async unsafe fn add(&mut self, buf: Buffer) -> napi::Result<()> {
+        let batches = ipc_file_to_batches(buf.to_vec())
+            .map_err(|e| napi::Error::from_reason(format!("Failed to read IPC file: {}", e)))?;
+        self.table.add(batches, None).await.map_err(|e| {
+            napi::Error::from_reason(format!(
+                "Failed to add batches to table {}: {}",
+                self.table, e
+            ))
+        })
+    }
+
+    #[napi]
+    pub async fn count_rows(&self) -> napi::Result<usize> {
+        self.table.count_rows().await.map_err(|e| {
+            napi::Error::from_reason(format!(
+                "Failed to count rows in table {}: {}",
+                self.table, e
+            ))
+        })
+    }
+
+    #[napi]
+    pub async unsafe fn delete(&mut self, predicate: String) -> napi::Result<()> {
+        self.table.delete(&predicate).await.map_err(|e| {
+            napi::Error::from_reason(format!(
+                "Failed to delete rows in table {}: predicate={}",
+                self.table, e
+            ))
+        })
+    }
+
+    #[napi]
+    pub fn query(&self) -> Query {
+        Query::new(self)
+    }
+}