rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-01-05 19:32:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(node): update indexStats signature and regenerate docs (#1742)

Browse Source 
`indexStats` still referenced UUID even though in
https://github.com/lancedb/lancedb/pull/1702 we changed it to take name
instead.
This commit is contained in:
Will Jones
2024-10-18 10:53:28 -07:00
committed by GitHub
parent 437316cbbc
commit 48f46d4751
30 changed files with 1220 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
node/src/index.ts
View File

@@ -564,7 +564,7 @@ export interface Table<T = number[]> {
/**
* Get statistics about an index.
*/
indexStats: (indexUuid: string) => Promise<IndexStats>
indexStats: (indexName: string) => Promise<IndexStats>
filter(value: string): Query<T>
@@ -1164,8 +1164,8 @@ export class LocalTable<T = number[]> implements Table<T> {
return tableListIndices.call(this._tbl);
}
async indexStats(indexUuid: string): Promise<IndexStats> {
return tableIndexStats.call(this._tbl, indexUuid);
async indexStats(indexName: string): Promise<IndexStats> {
return tableIndexStats.call(this._tbl, indexName);
}
get schema(): Promise<Schema> {

4
node/src/remote/index.ts
View File

@@ -517,9 +517,9 @@ export class RemoteTable<T = number[]> implements Table<T> {
}))
}
async indexStats (indexUuid: string): Promise<IndexStats> {
async indexStats (indexName: string): Promise<IndexStats> {
const results = await this._client.post(
`/v1/table/${encodeURIComponent(this._name)}/index/${indexUuid}/stats/`
`/v1/table/${encodeURIComponent(this._name)}/index/${indexName}/stats/`
)
const body = await results.body()
return {