@lancedb/lancedb 0.11.0-beta.0 → 0.11.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -13,11 +13,13 @@
13
13
  // See the License for the specific language governing permissions and
14
14
  // limitations under the License.
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.embedding = exports.Table = exports.Index = exports.RecordBatchIterator = exports.VectorQuery = exports.QueryBase = exports.Query = exports.Connection = exports.VectorColumnOptions = exports.MakeArrowTableOptions = exports.makeArrowTable = void 0;
16
+ exports.embedding = exports.Table = exports.Index = exports.RecordBatchIterator = exports.VectorQuery = exports.QueryBase = exports.Query = exports.Connection = exports.VectorColumnOptions = exports.MakeArrowTableOptions = exports.makeArrowTable = exports.WriteMode = void 0;
17
17
  exports.connect = connect;
18
18
  const connection_1 = require("./connection");
19
19
  const native_js_1 = require("./native.js");
20
20
  const remote_1 = require("./remote");
21
+ var native_js_2 = require("./native.js");
22
+ Object.defineProperty(exports, "WriteMode", { enumerable: true, get: function () { return native_js_2.WriteMode; } });
21
23
  var arrow_1 = require("./arrow");
22
24
  Object.defineProperty(exports, "makeArrowTable", { enumerable: true, get: function () { return arrow_1.makeArrowTable; } });
23
25
  Object.defineProperty(exports, "MakeArrowTableOptions", { enumerable: true, get: function () { return arrow_1.MakeArrowTableOptions; } });
package/dist/native.d.ts CHANGED
@@ -109,7 +109,7 @@ export interface ConnectionOptions {
109
109
  storageOptions?: Record<string, string>
110
110
  }
111
111
  /** Write mode for writing a table. */
112
- export const enum WriteMode {
112
+ export enum WriteMode {
113
113
  Create = 'Create',
114
114
  Append = 'Append',
115
115
  Overwrite = 'Overwrite'
package/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "vector database",
11
11
  "ann"
12
12
  ],
13
- "version": "0.11.0-beta.0",
13
+ "version": "0.11.0-beta.1",
14
14
  "main": "dist/index.js",
15
15
  "exports": {
16
16
  ".": "./dist/index.js",
@@ -73,8 +73,8 @@
73
73
  ],
74
74
  "scripts": {
75
75
  "artifacts": "napi artifacts",
76
- "build:debug": "napi build --platform --dts ../lancedb/native.d.ts --js ../lancedb/native.js lancedb",
77
- "build:release": "napi build --platform --release --dts ../lancedb/native.d.ts --js ../lancedb/native.js dist/",
76
+ "build:debug": "napi build --platform --no-const-enum --dts ../lancedb/native.d.ts --js ../lancedb/native.js lancedb",
77
+ "build:release": "napi build --platform --no-const-enum --release --dts ../lancedb/native.d.ts --js ../lancedb/native.js dist/",
78
78
  "build": "npm run build:debug && tsc -b && shx cp lancedb/native.d.ts dist/native.d.ts && shx cp lancedb/*.node dist/",
79
79
  "build-release": "npm run build:release && tsc -b && shx cp lancedb/native.d.ts dist/native.d.ts",
80
80
  "lint-ci": "biome ci .",
@@ -92,11 +92,11 @@
92
92
  "reflect-metadata": "^0.2.2"
93
93
  },
94
94
  "optionalDependencies": {
95
- "@lancedb/lancedb-darwin-arm64": "0.11.0-beta.0",
96
- "@lancedb/lancedb-linux-arm64-gnu": "0.11.0-beta.0",
97
- "@lancedb/lancedb-darwin-x64": "0.11.0-beta.0",
98
- "@lancedb/lancedb-linux-x64-gnu": "0.11.0-beta.0",
99
- "@lancedb/lancedb-win32-x64-msvc": "0.11.0-beta.0"
95
+ "@lancedb/lancedb-darwin-arm64": "0.11.0-beta.1",
96
+ "@lancedb/lancedb-linux-arm64-gnu": "0.11.0-beta.1",
97
+ "@lancedb/lancedb-darwin-x64": "0.11.0-beta.1",
98
+ "@lancedb/lancedb-linux-x64-gnu": "0.11.0-beta.1",
99
+ "@lancedb/lancedb-win32-x64-msvc": "0.11.0-beta.1"
100
100
  },
101
101
  "peerDependencies": {
102
102
  "apache-arrow": ">=13.0.0 <=17.0.0"
package/native.d.ts DELETED
@@ -1,208 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
-
4
- /* auto-generated by NAPI-RS */
5
-
6
- /** A description of an index currently configured on a column */
7
- export interface IndexConfig {
8
- /** The name of the index */
9
- name: string
10
- /** The type of the index */
11
- indexType: string
12
- /**
13
- * The columns in the index
14
- *
15
- * Currently this is always an array of size 1. In the future there may
16
- * be more columns to represent composite indices.
17
- */
18
- columns: Array<string>
19
- }
20
- /** Statistics about a compaction operation. */
21
- export interface CompactionStats {
22
- /** The number of fragments removed */
23
- fragmentsRemoved: number
24
- /** The number of new, compacted fragments added */
25
- fragmentsAdded: number
26
- /** The number of data files removed */
27
- filesRemoved: number
28
- /** The number of new, compacted data files added */
29
- filesAdded: number
30
- }
31
- /** Statistics about a cleanup operation */
32
- export interface RemovalStats {
33
- /** The number of bytes removed */
34
- bytesRemoved: number
35
- /** The number of old versions removed */
36
- oldVersionsRemoved: number
37
- }
38
- /** Statistics about an optimize operation */
39
- export interface OptimizeStats {
40
- /** Statistics about the compaction operation */
41
- compaction: CompactionStats
42
- /** Statistics about the removal operation */
43
- prune: RemovalStats
44
- }
45
- /**
46
- * A definition of a column alteration. The alteration changes the column at
47
- * `path` to have the new name `name`, to be nullable if `nullable` is true,
48
- * and to have the data type `data_type`. At least one of `rename` or `nullable`
49
- * must be provided.
50
- */
51
- export interface ColumnAlteration {
52
- /**
53
- * The path to the column to alter. This is a dot-separated path to the column.
54
- * If it is a top-level column then it is just the name of the column. If it is
55
- * a nested column then it is the path to the column, e.g. "a.b.c" for a column
56
- * `c` nested inside a column `b` nested inside a column `a`.
57
- */
58
- path: string
59
- /**
60
- * The new name of the column. If not provided then the name will not be changed.
61
- * This must be distinct from the names of all other columns in the table.
62
- */
63
- rename?: string
64
- /** Set the new nullability. Note that a nullable column cannot be made non-nullable. */
65
- nullable?: boolean
66
- }
67
- /** A definition of a new column to add to a table. */
68
- export interface AddColumnsSql {
69
- /** The name of the new column. */
70
- name: string
71
- /**
72
- * The values to populate the new column with, as a SQL expression.
73
- * The expression can reference other columns in the table.
74
- */
75
- valueSql: string
76
- }
77
- export interface IndexStatistics {
78
- /** The number of rows indexed by the index */
79
- numIndexedRows: number
80
- /** The number of rows not indexed */
81
- numUnindexedRows: number
82
- /** The type of the index */
83
- indexType?: string
84
- /** The metadata for each index */
85
- indices: Array<IndexMetadata>
86
- }
87
- export interface IndexMetadata {
88
- metricType?: string
89
- indexType?: string
90
- }
91
- export interface ConnectionOptions {
92
- /**
93
- * (For LanceDB OSS only): The interval, in seconds, at which to check for
94
- * updates to the table from other processes. If None, then consistency is not
95
- * checked. For performance reasons, this is the default. For strong
96
- * consistency, set this to zero seconds. Then every read will check for
97
- * updates from other processes. As a compromise, you can set this to a
98
- * non-zero value for eventual consistency. If more than that interval
99
- * has passed since the last check, then the table will be checked for updates.
100
- * Note: this consistency only applies to read operations. Write operations are
101
- * always consistent.
102
- */
103
- readConsistencyInterval?: number
104
- /**
105
- * (For LanceDB OSS only): configuration for object storage.
106
- *
107
- * The available options are described at https://lancedb.github.io/lancedb/guides/storage/
108
- */
109
- storageOptions?: Record<string, string>
110
- }
111
- /** Write mode for writing a table. */
112
- export const enum WriteMode {
113
- Create = 'Create',
114
- Append = 'Append',
115
- Overwrite = 'Overwrite'
116
- }
117
- /** Write options when creating a Table. */
118
- export interface WriteOptions {
119
- /** Write mode for writing to a table. */
120
- mode?: WriteMode
121
- }
122
- export interface OpenTableOptions {
123
- storageOptions?: Record<string, string>
124
- }
125
- export class Connection {
126
- /** Create a new Connection instance from the given URI. */
127
- static new(uri: string, options: ConnectionOptions): Promise<Connection>
128
- display(): string
129
- isOpen(): boolean
130
- close(): void
131
- /** List all tables in the dataset. */
132
- tableNames(startAfter?: string | undefined | null, limit?: number | undefined | null): Promise<Array<string>>
133
- /**
134
- * Create table from a Apache Arrow IPC (file) buffer.
135
- *
136
- * Parameters:
137
- * - name: The name of the table.
138
- * - buf: The buffer containing the IPC file.
139
- *
140
- */
141
- createTable(name: string, buf: Buffer, mode: string, storageOptions?: Record<string, string> | undefined | null, useLegacyFormat?: boolean | undefined | null): Promise<Table>
142
- createEmptyTable(name: string, schemaBuf: Buffer, mode: string, storageOptions?: Record<string, string> | undefined | null, useLegacyFormat?: boolean | undefined | null): Promise<Table>
143
- openTable(name: string, storageOptions?: Record<string, string> | undefined | null, indexCacheSize?: number | undefined | null): Promise<Table>
144
- /** Drop table with the name. Or raise an error if the table does not exist. */
145
- dropTable(name: string): Promise<void>
146
- }
147
- export class Index {
148
- static ivfPq(distanceType?: string | undefined | null, numPartitions?: number | undefined | null, numSubVectors?: number | undefined | null, maxIterations?: number | undefined | null, sampleRate?: number | undefined | null): Index
149
- static btree(): Index
150
- }
151
- /** Typescript-style Async Iterator over RecordBatches */
152
- export class RecordBatchIterator {
153
- next(): Promise<Buffer | null>
154
- }
155
- /** A builder used to create and run a merge insert operation */
156
- export class NativeMergeInsertBuilder {
157
- whenMatchedUpdateAll(condition?: string | undefined | null): NativeMergeInsertBuilder
158
- whenNotMatchedInsertAll(): NativeMergeInsertBuilder
159
- whenNotMatchedBySourceDelete(filter?: string | undefined | null): NativeMergeInsertBuilder
160
- execute(buf: Buffer): Promise<void>
161
- }
162
- export class Query {
163
- onlyIf(predicate: string): void
164
- select(columns: Array<[string, string]>): void
165
- limit(limit: number): void
166
- nearestTo(vector: Float32Array): VectorQuery
167
- execute(maxBatchLength?: number | undefined | null): Promise<RecordBatchIterator>
168
- explainPlan(verbose: boolean): Promise<string>
169
- }
170
- export class VectorQuery {
171
- column(column: string): void
172
- distanceType(distanceType: string): void
173
- postfilter(): void
174
- refineFactor(refineFactor: number): void
175
- nprobes(nprobe: number): void
176
- bypassVectorIndex(): void
177
- onlyIf(predicate: string): void
178
- select(columns: Array<[string, string]>): void
179
- limit(limit: number): void
180
- execute(maxBatchLength?: number | undefined | null): Promise<RecordBatchIterator>
181
- explainPlan(verbose: boolean): Promise<string>
182
- }
183
- export class Table {
184
- name: string
185
- display(): string
186
- isOpen(): boolean
187
- close(): void
188
- /** Return Schema as empty Arrow IPC file. */
189
- schema(): Promise<Buffer>
190
- add(buf: Buffer, mode: string): Promise<void>
191
- countRows(filter?: string | undefined | null): Promise<number>
192
- delete(predicate: string): Promise<void>
193
- createIndex(index: Index | undefined | null, column: string, replace?: boolean | undefined | null): Promise<void>
194
- update(onlyIf: string | undefined | null, columns: Array<[string, string]>): Promise<void>
195
- query(): Query
196
- vectorSearch(vector: Float32Array): VectorQuery
197
- addColumns(transforms: Array<AddColumnsSql>): Promise<void>
198
- alterColumns(alterations: Array<ColumnAlteration>): Promise<void>
199
- dropColumns(columns: Array<string>): Promise<void>
200
- version(): Promise<number>
201
- checkout(version: number): Promise<void>
202
- checkoutLatest(): Promise<void>
203
- restore(): Promise<void>
204
- optimize(olderThanMs?: number | undefined | null): Promise<OptimizeStats>
205
- listIndices(): Promise<Array<IndexConfig>>
206
- indexStats(indexName: string): Promise<IndexStatistics | null>
207
- mergeInsert(on: Array<string>): NativeMergeInsertBuilder
208
- }