@lancedb/lancedb 0.29.0 → 0.30.0-beta.0

package/dist/native.d.ts

@@ -3,6 +3,8 @@
 export declare class Connection {
   /** Create a new Connection instance from the given URI. */
   static new(uri: string, options: ConnectionOptions, headerProvider?: JsHeaderProvider | undefined | null): Promise<Connection>
+  /** Create a new Connection instance backed by a namespace implementation. */
+  static newWithNamespace(implName: string, properties: Record<string, string>, options: ConnectNamespaceOptions): Promise<Connection>
   display(): string
   isOpen(): boolean
   close(): void
@@ -22,6 +24,20 @@ export declare class Connection {
   /** Drop table with the name. Or raise an error if the table does not exist. */
   dropTable(name: string, namespacePath?: Array<string> | undefined | null): Promise<void>
   dropAllTables(namespacePath?: Array<string> | undefined | null): Promise<void>
+  /** Describe a namespace and return its properties. */
+  describeNamespace(namespacePath: Array<string>): Promise<DescribeNamespaceResponse>
+  /** List child namespaces under the given namespace path */
+  listNamespaces(namespacePath?: Array<string> | undefined | null, pageToken?: string | undefined | null, limit?: number | undefined | null): Promise<ListNamespacesResponse>
+  /** Create a new namespace with optional properties. */
+  createNamespace(namespacePath: Array<string>, mode?: string | undefined | null, properties?: Record<string, string> | undefined | null): Promise<CreateNamespaceResponse>
+  /** Drop a namespace. */
+  dropNamespace(namespacePath: Array<string>, mode?: string | undefined | null, behavior?: string | undefined | null): Promise<DropNamespaceResponse>
+  /**
+   * Rename a table. `current_namespace_path` and `new_namespace_path` default to
+   * the root namespace when omitted; the caller is expected to either pass both
+   * or pass neither.
+   */
+  renameTable(currentName: string, newName: string, currentNamespacePath?: Array<string> | undefined | null, newNamespacePath?: Array<string> | undefined | null): Promise<void>
 }
 
 export declare class Index {
@@ -55,6 +71,30 @@ export declare class JsHeaderProvider {
   constructor(getHeadersCallback: () => Promise<Record<string, string>>)
 }
 
+/**
+ * A Rust-side view of a JS-constructed `Scannable`.
+ *
+ * Held in JS as the return value of the `Scannable` class constructor. When
+ * passed to a consumer that accepts `impl lancedb::data::scannable::Scannable`,
+ * the consumer invokes `scan_as_stream()` to pull batches through the JS
+ * callback.
+ */
+export declare class NapiScannable {
+  /**
+   * Construct a new `NapiScannable`.
+   *
+   * - `schema_buf` — Arrow IPC File buffer carrying only the schema (no batches).
+   * - `num_rows` — optional row count hint; not validated against the stream.
+   * - `rescannable` — whether `get_next_batch` may be re-driven after the
+   *   scan completes.
+   * - `get_next_batch` -- JS callback that yields the next batch as an Arrow
+   *   IPC Stream message wrapped in a `Buffer`, or `null` at EOF. The
+   *   `isStart` argument is `true` on the first call of each new scan;
+   *   JS uses it to discard any cached iterator before pulling.
+   */
+  constructor(schemaBuf: Buffer, numRows: number | undefined | null, rescannable: boolean, getNextBatch: (arg: boolean) => Promise<Buffer | undefined | null>)
+}
+
 /** A builder used to create and run a merge insert operation */
 export declare class NativeMergeInsertBuilder {
   whenMatchedUpdateAll(condition?: string | undefined | null): NativeMergeInsertBuilder
@@ -94,6 +134,7 @@ export declare class Query {
   nearestToRaw(data: Uint8Array, dtype: string): VectorQuery
   fastSearch(): void
   withRowId(): void
+  orderBy(ordering?: Array<ColumnOrdering> | undefined | null): void
   outputSchema(): Promise<Buffer>
   execute(maxBatchLength?: number | undefined | null, timeoutMs?: number | undefined | null): Promise<RecordBatchIterator>
   explainPlan(verbose: boolean): Promise<string>
@@ -154,7 +195,7 @@ export declare class Table {
   close(): void
   /** Return Schema as empty Arrow IPC file. */
   schema(): Promise<Buffer>
-  add(buf: Buffer, mode: string): Promise<AddResult>
+  add(buf: Buffer, mode: string, progressCallback?: (progress: WriteProgressInfo) => void): Promise<AddResult>
   countRows(filter?: string | undefined | null): Promise<number>
   delete(predicate: string): Promise<DeleteResult>
   createIndex(index: Index | undefined | null, column: string, replace?: boolean | undefined | null, waitTimeoutS?: number | undefined | null, name?: string | undefined | null, train?: boolean | undefined | null): Promise<void>
@@ -174,6 +215,9 @@ export declare class Table {
   addColumnsWithSchema(schemaBuf: Buffer): Promise<AddColumnsResult>
   alterColumns(alterations: Array<ColumnAlteration>): Promise<AlterColumnsResult>
   dropColumns(columns: Array<string>): Promise<DropColumnsResult>
+  setUnenforcedPrimaryKey(columns: Array<string>): Promise<void>
+  setLsmWriteSpec(spec: LsmWriteSpec): Promise<void>
+  unsetLsmWriteSpec(): Promise<void>
   version(): Promise<number>
   checkout(version: number): Promise<void>
   checkoutTag(tag: string): Promise<void>
@@ -234,6 +278,7 @@ export declare class VectorQuery {
   fastSearch(): void
   withRowId(): void
   rerank(rerankHybrid: (arg: RerankHybridCallbackArgs) => Promise<Buffer>): void
+  orderBy(ordering?: Array<ColumnOrdering> | undefined | null): void
   outputSchema(): Promise<Buffer>
   execute(maxBatchLength?: number | undefined | null, timeoutMs?: number | undefined | null): Promise<RecordBatchIterator>
   explainPlan(verbose: boolean): Promise<string>
@@ -316,6 +361,12 @@ export interface ColumnAlteration {
   nullable?: boolean
 }
 
+export interface ColumnOrdering {
+  ascending: boolean
+  nullsFirst: boolean
+  columnName: string
+}
+
 /** Statistics about a compaction operation. */
 export interface CompactionStats {
   /** The number of fragments removed */
@@ -383,15 +434,53 @@ export interface ConnectionOptions {
   hostOverride?: string
 }
 
+export interface ConnectNamespaceOptions {
+  /**
+   * The interval, in seconds, at which to check for updates to the table
+   * from other processes. If None, then consistency is not checked. For
+   * performance reasons, this is the default. For strong consistency, set
+   * this to zero seconds. Then every read will check for updates from other
+   * processes. As a compromise, you can set this to a non-zero value for
+   * eventual consistency.
+   */
+  readConsistencyInterval?: number
+  /**
+   * Configuration for object storage. The available options are described
+   * at https://docs.lancedb.com/storage/
+   */
+  storageOptions?: Record<string, string>
+  /** Extra properties for the backing namespace client. */
+  namespaceClientProperties?: Record<string, string>
+  /**
+   * The session to use for this connection. Holds shared caches and other
+   * session-specific state.
+   */
+  session?: Session
+}
+
+export interface CreateNamespaceResponse {
+  properties?: Record<string, string>
+  transactionId?: string
+}
+
 export interface DeleteResult {
   numDeletedRows: number
   version: number
 }
 
+export interface DescribeNamespaceResponse {
+  properties?: Record<string, string>
+}
+
 export interface DropColumnsResult {
   version: number
 }
 
+export interface DropNamespaceResponse {
+  properties?: Record<string, string>
+  transactionId?: Array<string>
+}
+
 export interface FragmentStatistics {
   /** The number of fragments in the table */
   numFragments: number
@@ -455,6 +544,32 @@ export interface IndexStatistics {
   loss?: number
 }
 
+export interface ListNamespacesResponse {
+  namespaces: Array<string>
+  pageToken?: string
+}
+
+/**
+ * Specification selecting Lance's MemWAL LSM-style write path for
+ * `mergeInsert`.
+ *
+ * `specType` must be `"bucket"`, `"identity"`, or `"unsharded"`. For
+ * `"bucket"`, `column` and `numBuckets` are required; for `"identity"`,
+ * `column` is required.
+ */
+export interface LsmWriteSpec {
+  /** One of `"bucket"`, `"identity"`, or `"unsharded"`. */
+  specType: string
+  /** Bucket and identity variants: the sharding column. */
+  column?: string
+  /** Bucket variant: the number of buckets, in `[1, 1024]`. */
+  numBuckets?: number
+  /** Names of indexes the MemWAL should keep up to date during writes. */
+  maintainedIndexes?: Array<string>
+  /** Default `ShardWriter` configuration recorded in the MemWAL index. */
+  writerConfigDefaults?: Record<string, string>
+}
+
 export interface MergeResult {
   version: number
   numInsertedRows: number
@@ -637,3 +752,27 @@ export interface Version {
   timestamp: number
   metadata: Record<string, string>
 }
+
+/**
+ * Progress snapshot for a write operation, delivered to the JS callback
+ * passed to `Table.add`.
+ */
+export interface WriteProgressInfo {
+  /** Number of rows written so far. */
+  outputRows: number
+  /** Number of bytes written so far. */
+  outputBytes: number
+  /**
+   * Total rows expected, if the input source reports it.
+   * Always set on the final callback (where `done` is `true`).
+   */
+  totalRows?: number
+  /** Wall-clock seconds since monitoring started. */
+  elapsedSeconds: number
+  /** Number of parallel write tasks currently in flight. */
+  activeTasks: number
+  /** Total number of parallel write tasks (the write parallelism). */
+  totalTasks: number
+  /** `true` for the final callback; `false` otherwise. */
+  done: boolean
+}

package/dist/native.js

@@ -76,8 +76,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-android-arm64');
                 const bindingPackageVersion = require('@lancedb/lancedb-android-arm64/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -95,8 +95,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-android-arm-eabi');
                 const bindingPackageVersion = require('@lancedb/lancedb-android-arm-eabi/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -120,8 +120,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-win32-x64-gnu');
                     const bindingPackageVersion = require('@lancedb/lancedb-win32-x64-gnu/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -139,8 +139,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-win32-x64-msvc');
                     const bindingPackageVersion = require('@lancedb/lancedb-win32-x64-msvc/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -159,8 +159,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-win32-ia32-msvc');
                 const bindingPackageVersion = require('@lancedb/lancedb-win32-ia32-msvc/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -178,8 +178,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-win32-arm64-msvc');
                 const bindingPackageVersion = require('@lancedb/lancedb-win32-arm64-msvc/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -201,8 +201,8 @@ function requireNative() {
         try {
             const binding = require('@lancedb/lancedb-darwin-universal');
             const bindingPackageVersion = require('@lancedb/lancedb-darwin-universal/package.json').version;
-            if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+            if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
             }
             return binding;
         }
@@ -219,8 +219,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-darwin-x64');
                 const bindingPackageVersion = require('@lancedb/lancedb-darwin-x64/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -238,8 +238,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-darwin-arm64');
                 const bindingPackageVersion = require('@lancedb/lancedb-darwin-arm64/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -262,8 +262,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-freebsd-x64');
                 const bindingPackageVersion = require('@lancedb/lancedb-freebsd-x64/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -281,8 +281,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-freebsd-arm64');
                 const bindingPackageVersion = require('@lancedb/lancedb-freebsd-arm64/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -306,8 +306,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-linux-x64-musl');
                     const bindingPackageVersion = require('@lancedb/lancedb-linux-x64-musl/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -325,8 +325,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-linux-x64-gnu');
                     const bindingPackageVersion = require('@lancedb/lancedb-linux-x64-gnu/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -346,8 +346,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-linux-arm64-musl');
                     const bindingPackageVersion = require('@lancedb/lancedb-linux-arm64-musl/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -365,8 +365,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-linux-arm64-gnu');
                     const bindingPackageVersion = require('@lancedb/lancedb-linux-arm64-gnu/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -386,8 +386,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-linux-arm-musleabihf');
                     const bindingPackageVersion = require('@lancedb/lancedb-linux-arm-musleabihf/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -405,8 +405,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-linux-arm-gnueabihf');
                     const bindingPackageVersion = require('@lancedb/lancedb-linux-arm-gnueabihf/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -426,8 +426,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-linux-loong64-musl');
                     const bindingPackageVersion = require('@lancedb/lancedb-linux-loong64-musl/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -445,8 +445,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-linux-loong64-gnu');
                     const bindingPackageVersion = require('@lancedb/lancedb-linux-loong64-gnu/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -466,8 +466,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-linux-riscv64-musl');
                     const bindingPackageVersion = require('@lancedb/lancedb-linux-riscv64-musl/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -485,8 +485,8 @@ function requireNative() {
                 try {
                     const binding = require('@lancedb/lancedb-linux-riscv64-gnu');
                     const bindingPackageVersion = require('@lancedb/lancedb-linux-riscv64-gnu/package.json').version;
-                    if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                        throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                    if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                        throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                     }
                     return binding;
                 }
@@ -505,8 +505,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-linux-ppc64-gnu');
                 const bindingPackageVersion = require('@lancedb/lancedb-linux-ppc64-gnu/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -524,8 +524,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-linux-s390x-gnu');
                 const bindingPackageVersion = require('@lancedb/lancedb-linux-s390x-gnu/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -548,8 +548,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-openharmony-arm64');
                 const bindingPackageVersion = require('@lancedb/lancedb-openharmony-arm64/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -567,8 +567,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-openharmony-x64');
                 const bindingPackageVersion = require('@lancedb/lancedb-openharmony-x64/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -586,8 +586,8 @@ function requireNative() {
             try {
                 const binding = require('@lancedb/lancedb-openharmony-arm');
                 const bindingPackageVersion = require('@lancedb/lancedb-openharmony-arm/package.json').version;
-                if (bindingPackageVersion !== '0.29.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-                    throw new Error(`Native binding package version mismatch, expected 0.29.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
+                if (bindingPackageVersion !== '0.30.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+                    throw new Error(`Native binding package version mismatch, expected 0.30.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
                 }
                 return binding;
             }
@@ -657,6 +657,7 @@ module.exports.Connection = nativeBinding.Connection;
 module.exports.Index = nativeBinding.Index;
 module.exports.JsFullTextQuery = nativeBinding.JsFullTextQuery;
 module.exports.JsHeaderProvider = nativeBinding.JsHeaderProvider;
+module.exports.NapiScannable = nativeBinding.NapiScannable;
 module.exports.NativeMergeInsertBuilder = nativeBinding.NativeMergeInsertBuilder;
 module.exports.PermutationBuilder = nativeBinding.PermutationBuilder;
 module.exports.Query = nativeBinding.Query;

package/dist/query.d.ts

@@ -19,6 +19,11 @@ export interface QueryExecutionOptions {
      */
     timeoutMs?: number;
 }
+export interface ColumnOrdering {
+    columnName: string;
+    ascending?: boolean;
+    nullsFirst?: boolean;
+}
 /**
  * Options that control the behavior of a full text search
  */
@@ -201,6 +206,11 @@ export declare class StandardQueryBase<NativeQueryType extends NativeQuery | Nat
      * This is useful for pagination.
      */
     offset(offset: number): this;
+    /**
+     * Sort the results by the specified column(s).
+     * @returns This query builder.
+     */
+    orderBy(ordering: ColumnOrdering | ColumnOrdering[]): this;
     /**
      * Skip searching un-indexed data. This can make search faster, but will miss
      * any data that is not yet indexed.

package/dist/query.js

@@ -332,6 +332,20 @@ class StandardQueryBase extends QueryBase {
         this.doCall((inner) => inner.offset(offset));
         return this;
     }
+    /**
+     * Sort the results by the specified column(s).
+     * @returns This query builder.
+     */
+    orderBy(ordering) {
+        const orderings = Array.isArray(ordering) ? ordering : [ordering];
+        const normalized = orderings.map((o) => ({
+            columnName: o.columnName,
+            ascending: o.ascending ?? true,
+            nullsFirst: o.nullsFirst ?? false,
+        }));
+        this.doCall((inner) => inner.orderBy(normalized));
+        return this;
+    }
     /**
      * Skip searching un-indexed data. This can make search faster, but will miss
      * any data that is not yet indexed.