mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-09 05:12:58 +00:00
Node SDK Client middleware for HTTP Requests (#1130)
Adds client-side middleware to LanceDB Node SDK to instrument HTTP
Requests
Example - adding `x-request-id` request header:
```js
class HttpMiddleware {
constructor({ requestId }) {
this.requestId = requestId
}
onRemoteRequest(req, next) {
req.headers['x-request-id'] = this.requestId
return next(req)
}
}
const db = await lancedb.connect({
uri: 'db://remote-123',
apiKey: 'sk_...',
})
let tables = await db.withMiddleware(new HttpMiddleware({ requestId: '123' })).tableNames();
```
---------
Co-authored-by: Weston Pace <weston.pace@gmail.com>
This commit is contained in:
@@ -24,6 +24,7 @@ import { RemoteConnection } from './remote'
|
||||
import { Query } from './query'
|
||||
import { isEmbeddingFunction } from './embedding/embedding_function'
|
||||
import { type Literal, toSQL } from './util'
|
||||
import { type HttpMiddleware } from './middleware'
|
||||
|
||||
const {
|
||||
databaseNew,
|
||||
@@ -302,6 +303,18 @@ export interface Connection {
|
||||
* @param name The name of the table to drop.
|
||||
*/
|
||||
dropTable(name: string): Promise<void>
|
||||
|
||||
/**
|
||||
* Instrument the behavior of this Connection with middleware.
|
||||
*
|
||||
* The middleware will be called in the order they are added.
|
||||
*
|
||||
* Currently this functionality is only supported for remote Connections.
|
||||
*
|
||||
* @param {HttpMiddleware} - Middleware which will instrument the Connection.
|
||||
* @returns - this Connection instrumented by the passed middleware
|
||||
*/
|
||||
withMiddleware(middleware: HttpMiddleware): Connection
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -541,6 +554,18 @@ export interface Table<T = number[]> {
|
||||
* names (e.g. "a").
|
||||
*/
|
||||
dropColumns(columnNames: string[]): Promise<void>
|
||||
|
||||
/**
|
||||
* Instrument the behavior of this Table with middleware.
|
||||
*
|
||||
* The middleware will be called in the order they are added.
|
||||
*
|
||||
* Currently this functionality is only supported for remote tables.
|
||||
*
|
||||
* @param {HttpMiddleware} - Middleware which will instrument the Table.
|
||||
* @returns - this Table instrumented by the passed middleware
|
||||
*/
|
||||
withMiddleware(middleware: HttpMiddleware): Table<T>
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -795,6 +820,10 @@ export class LocalConnection implements Connection {
|
||||
async dropTable (name: string): Promise<void> {
|
||||
await databaseDropTable.call(this._db, name)
|
||||
}
|
||||
|
||||
withMiddleware (middleware: HttpMiddleware): Connection {
|
||||
return this
|
||||
}
|
||||
}
|
||||
|
||||
export class LocalTable<T = number[]> implements Table<T> {
|
||||
@@ -1105,6 +1134,10 @@ export class LocalTable<T = number[]> implements Table<T> {
|
||||
async dropColumns (columnNames: string[]): Promise<void> {
|
||||
return tableDropColumns.call(this._tbl, columnNames)
|
||||
}
|
||||
|
||||
withMiddleware (middleware: HttpMiddleware): Table<T> {
|
||||
return this
|
||||
}
|
||||
}
|
||||
|
||||
export interface CleanupStats {
|
||||
|
||||
Reference in New Issue
Block a user