// 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. import { Field, Float64, Schema } from "apache-arrow"; import * as tmp from "tmp"; import { Connection, Table, connect } from "../lancedb"; describe("when connecting", () => { let tmpDir: tmp.DirResult; beforeEach(() => { tmpDir = tmp.dirSync({ unsafeCleanup: true }); }); afterEach(() => tmpDir.removeCallback()); it("should connect", async () => { const db = await connect(tmpDir.name); expect(db.display()).toBe( `NativeDatabase(uri=${tmpDir.name}, read_consistency_interval=None)`, ); }); it("should allow read consistency interval to be specified", async () => { const db = await connect(tmpDir.name, { readConsistencyInterval: 5 }); expect(db.display()).toBe( `NativeDatabase(uri=${tmpDir.name}, read_consistency_interval=5s)`, ); }); }); describe("given a connection", () => { let tmpDir: tmp.DirResult; let db: Connection; beforeEach(async () => { tmpDir = tmp.dirSync({ unsafeCleanup: true }); db = await connect(tmpDir.name); }); afterEach(() => tmpDir.removeCallback()); it("should raise an error if opening a non-existent table", async () => { await expect(db.openTable("non-existent")).rejects.toThrow("was not found"); }); it("should raise an error if any operation is tried after it is closed", async () => { expect(db.isOpen()).toBe(true); await db.close(); expect(db.isOpen()).toBe(false); await expect(db.tableNames()).rejects.toThrow("Connection is closed"); }); it("should be able to create a table from an object arg `createTable(options)`, or args `createTable(name, data, options)`", async () => { let tbl = await db.createTable("test", [{ id: 1 }, { id: 2 }]); await expect(tbl.countRows()).resolves.toBe(2); tbl = await db.createTable({ name: "test", data: [{ id: 3 }], mode: "overwrite", }); await expect(tbl.countRows()).resolves.toBe(1); }); it("should fail if creating table twice, unless overwrite is true", async () => { let tbl = await db.createTable("test", [{ id: 1 }, { id: 2 }]); await expect(tbl.countRows()).resolves.toBe(2); await expect( db.createTable("test", [{ id: 1 }, { id: 2 }]), ).rejects.toThrow(); tbl = await db.createTable("test", [{ id: 3 }], { mode: "overwrite" }); await expect(tbl.countRows()).resolves.toBe(1); }); it("should respect limit and page token when listing tables", async () => { const db = await connect(tmpDir.name); await db.createTable("b", [{ id: 1 }]); await db.createTable("a", [{ id: 1 }]); await db.createTable("c", [{ id: 1 }]); let tables = await db.tableNames(); expect(tables).toEqual(["a", "b", "c"]); tables = await db.tableNames({ limit: 1 }); expect(tables).toEqual(["a"]); tables = await db.tableNames({ limit: 1, startAfter: "a" }); expect(tables).toEqual(["b"]); tables = await db.tableNames({ startAfter: "a" }); expect(tables).toEqual(["b", "c"]); }); it("should create tables in v2 mode", async () => { const db = await connect(tmpDir.name); const data = [...Array(10000).keys()].map((i) => ({ id: i })); // Create in v1 mode let table = await db.createTable("test", data); const isV2 = async (table: Table) => { const data = await table.query().toArrow({ maxBatchLength: 100000 }); console.log(data.batches.length); return data.batches.length < 5; }; await expect(isV2(table)).resolves.toBe(false); // Create in v2 mode table = await db.createTable("test_v2", data, { useLegacyFormat: false }); await expect(isV2(table)).resolves.toBe(true); await table.add(data); await expect(isV2(table)).resolves.toBe(true); // Create empty in v2 mode const schema = new Schema([new Field("id", new Float64(), true)]); table = await db.createEmptyTable("test_v2_empty", schema, { useLegacyFormat: false, }); await table.add(data); await expect(isV2(table)).resolves.toBe(true); }); });