{"id":17061334,"url":"https://github.com/roeap/flight-sql-client-node","last_synced_at":"2025-04-12T18:10:35.626Z","repository":{"id":195769912,"uuid":"693618343","full_name":"roeap/flight-sql-client-node","owner":"roeap","description":"A Flight SQL client for Node.js","archived":false,"fork":false,"pushed_at":"2023-11-26T10:15:21.000Z","size":1163,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-15T09:08:02.996Z","etag":null,"topics":["apache-arrow","arrow-flight","nodejs"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/roeap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-19T11:37:07.000Z","updated_at":"2024-08-07T21:03:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"2be0f458-0a09-47b5-9c58-6b055bdd3863","html_url":"https://github.com/roeap/flight-sql-client-node","commit_stats":null,"previous_names":["roeap/flight-sql-client-node"],"tags_count":7,"template":false,"template_full_name":"napi-rs/package-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roeap%2Fflight-sql-client-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roeap%2Fflight-sql-client-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roeap%2Fflight-sql-client-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roeap%2Fflight-sql-client-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roeap","download_url":"https://codeload.github.com/roeap/flight-sql-client-node/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248610338,"owners_count":21132919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apache-arrow","arrow-flight","nodejs"],"created_at":"2024-10-14T10:46:48.287Z","updated_at":"2025-04-12T18:10:35.605Z","avatar_url":"https://github.com/roeap.png","language":"Rust","readme":"# `@lakehouse-rs/flight-sql-client`\n\n![https://github.com/napi-rs/package-template/actions](https://github.com/roeap/flight-sql-client-node/workflows/CI/badge.svg)\n[![npm version](https://img.shields.io/npm/v/@lakehouse-rs/flight-sql-client.svg)](https://www.npmjs.com/package/@lakehouse-rs/flight-sql-client)\n\nA client library for interacting with [Arrow Flight SQL] enabled databases from Node.js.\n\nThis library provides a thin wrapper around the flight-sql client implementation in\nthe [arrow-flight] crate. Node bindings are created with the help of [napi-rs].\n\n## Usage\n\nInstall library\n\n```sh\nyarn add @lakehouse-rs/flight-sql-client\n# or\nnpm install @lakehouse-rs/flight-sql-client\n# or\npnpm add @lakehouse-rs/flight-sql-client\n```\n\nCreate a new client instance\n\n```ts\nimport { ClientOptions, createFlightSqlClient } from '@lakehouse-rs/flight-sql-client';\nimport { tableFromIPC } from 'apache-arrow';\n\nconst options: ClientOptions = {\n  username: 'flight_username',\n  password: 'testing123',\n  tls: false,\n  host: '127.0.0.1',\n  port: 50051,\n  headers: [],\n};\n\nconst client = await createFlightSqlClient(options);\n```\n\nExecute a query against the service\n\n```ts\nconst buffer = await client.query('SELECT * FROM my_tyble');\nconst table = tableFromIPC(buffer);\n```\n\nOr inspect some server metadata\n\n```ts\nconst buffer = await client.getTables({ includeSchema: true });\nconst table = tableFromIPC(buffer);\n```\n\n## Development\n\nRequirements:\n\n- Rust\n- node.js \u003e= 12\n- Yarn\n\nInstall dependencies via\n\n```sh\nyarn install\n```\n\nBuild native module\n\n```sh\nyarn build\n```\n\nRun tests\n\n```sh\nyarn test\n```\n\n## Release\n\nReleases are automated via github actions.\n\nTo create a release, first increment the version. (note the use of npm)\n\n```sh\nnpm version \u003cpatch | minor | major | ...\u003e\n```\n\nthis will bump all version fields, and create a new commit with the version number.\n\nThen trigger the release.\n\n```sh\ngit push --follow-tags\n```\n\n[Arrow Flight SQL]: https://arrow.apache.org/docs/format/FlightSql.html\n[arrow-flight]: https://crates.io/crates/arrow-flight\n[napi-rs]: https://napi.rs/\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froeap%2Fflight-sql-client-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froeap%2Fflight-sql-client-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froeap%2Fflight-sql-client-node/lists"}