https://github.com/lancedb/flight-sql-js-client
A JavaScript client for FlightSQL
https://github.com/lancedb/flight-sql-js-client
Last synced: 7 months ago
JSON representation
A JavaScript client for FlightSQL
- Host: GitHub
- URL: https://github.com/lancedb/flight-sql-js-client
- Owner: lancedb
- License: apache-2.0
- Created: 2024-12-08T14:57:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-07T15:30:18.000Z (about 1 year ago)
- Last Synced: 2025-06-13T13:49:57.047Z (7 months ago)
- Language: JavaScript
- Size: 445 KB
- Stars: 9
- Watchers: 8
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# JavaScript Client for FlightSQL
This is a JavaScript client for FlightSQL. It allows you to easily query FlightSQL servers from your JavaScript applications.
Warning: This client is still experimental and in heavy development. If you'd like to help contribute, please reach out to us
at the [LanceDB Discord server](https://discord.gg/G5DcmnZWKB).
Currently all testing is done on Node.
## Installation
You can install the client using npm:
```bash
npm install @lancedb/arrow-flight-sql-client
```
## Usage
To use the client, you first need to connect to your database:
```javascript
import { Client } from "@lancedb/arrow-flight-sql-client";
const client = await Client.connect({
host: "mydb.com:10025",
username: "lancedb",
password: "password",
});
```
Once you have connected to your database, you can run queries:
```javascript
const result = await client.query("SELECT * FROM flights WHERE origin = 'SFO'");
```
Query results can be returned in a variety of formats but the simplest thing to do is to return them as an array of objects:
```javascript
interface FlightRecord {
origin: string;
destination: string;
}
const flights = (await result.collectToObjects()) as FlightRecord[];
console.log(flights);
```