fix: handle camelCase column names in select (#1460)

Fixes #1385
This commit is contained in:
Will Jones
2024-07-22 12:53:17 -07:00
committed by GitHub
parent 391fa26175
commit 4f601a2d4c
6 changed files with 73 additions and 17 deletions

View File

@@ -834,3 +834,25 @@ describe("when calling explainPlan", () => {
expect(plan).toMatch("KNN");
});
});
describe("column name options", () => {
let tmpDir: tmp.DirResult;
let table: Table;
beforeEach(async () => {
tmpDir = tmp.dirSync({ unsafeCleanup: true });
const con = await connect(tmpDir.name);
table = await con.createTable("vectors", [
{ camelCase: 1, vector: [0.1, 0.2] },
]);
});
test("can select columns with different names", async () => {
const results = await table.query().select(["camelCase"]).toArray();
expect(results[0].camelCase).toBe(1);
});
test("can filter on columns with different names", async () => {
const results = await table.query().where("`camelCase` = 1").toArray();
expect(results[0].camelCase).toBe(1);
});
});

View File

@@ -167,20 +167,27 @@ export class QueryBase<NativeQueryType extends NativeQuery | NativeVectorQuery>
select(
columns: string[] | Map<string, string> | Record<string, string> | string,
): this {
let columnTuples: [string, string][];
const selectColumns = (columnArray: string[]) => {
this.doCall((inner: NativeQueryType) => {
inner.selectColumns(columnArray);
});
};
const selectMapping = (columnTuples: [string, string][]) => {
this.doCall((inner: NativeQueryType) => {
inner.select(columnTuples);
});
};
if (typeof columns === "string") {
columns = [columns];
}
if (Array.isArray(columns)) {
columnTuples = columns.map((c) => [c, c]);
selectColumns([columns]);
} else if (Array.isArray(columns)) {
selectColumns(columns);
} else if (columns instanceof Map) {
columnTuples = Array.from(columns.entries());
selectMapping(Array.from(columns.entries()));
} else {
columnTuples = Object.entries(columns);
selectMapping(Object.entries(columns));
}
this.doCall((inner: NativeQueryType) => {
inner.select(columnTuples);
});
return this;
}

View File

@@ -47,6 +47,11 @@ impl Query {
self.inner = self.inner.clone().select(Select::dynamic(&columns));
}
#[napi]
pub fn select_columns(&mut self, columns: Vec<String>) {
self.inner = self.inner.clone().select(Select::columns(&columns));
}
#[napi]
pub fn limit(&mut self, limit: u32) {
self.inner = self.inner.clone().limit(limit as usize);
@@ -138,6 +143,11 @@ impl VectorQuery {
self.inner = self.inner.clone().select(Select::dynamic(&columns));
}
#[napi]
pub fn select_columns(&mut self, columns: Vec<String>) {
self.inner = self.inner.clone().select(Select::columns(&columns));
}
#[napi]
pub fn limit(&mut self, limit: u32) {
self.inner = self.inner.clone().limit(limit as usize);

View File

@@ -1127,14 +1127,14 @@ class AsyncQueryBase(object):
Columns will always be returned in the order given, even if that order is
different than the order used when adding the data.
"""
if isinstance(columns, dict):
column_tuples = list(columns.items())
if isinstance(columns, list) and all(isinstance(c, str) for c in columns):
self._inner.select_columns(columns)
elif isinstance(columns, dict) and all(
isinstance(k, str) and isinstance(v, str) for k, v in columns.items()
):
self._inner.select(list(columns.items()))
else:
try:
column_tuples = [(c, c) for c in columns]
except TypeError:
raise TypeError("columns must be a list of column names or a dict")
self._inner.select(column_tuples)
raise TypeError("columns must be a list of column names or a dict")
return self
def limit(self, limit: int) -> AsyncQuery:

View File

@@ -345,3 +345,12 @@ def test_explain_plan(table):
async def test_explain_plan_async(table_async: AsyncTable):
plan = await table_async.query().nearest_to(pa.array([1, 2])).explain_plan(True)
assert "KNN" in plan
@pytest.mark.asyncio
async def test_query_camelcase_async(tmp_path):
db = await lancedb.connect_async(tmp_path)
table = await db.create_table("test", pa.table({"camelCase": pa.array([1, 2])}))
result = await table.query().select(["camelCase"]).to_arrow()
assert result == pa.table({"camelCase": pa.array([1, 2])})

View File

@@ -52,6 +52,10 @@ impl Query {
self.inner = self.inner.clone().select(Select::dynamic(&columns));
}
pub fn select_columns(&mut self, columns: Vec<String>) {
self.inner = self.inner.clone().select(Select::columns(&columns));
}
pub fn limit(&mut self, limit: u32) {
self.inner = self.inner.clone().limit(limit as usize);
}
@@ -101,6 +105,10 @@ impl VectorQuery {
self.inner = self.inner.clone().select(Select::dynamic(&columns));
}
pub fn select_columns(&mut self, columns: Vec<String>) {
self.inner = self.inner.clone().select(Select::columns(&columns));
}
pub fn limit(&mut self, limit: u32) {
self.inner = self.inner.clone().limit(limit as usize);
}