Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@feathersjs/knex

feathersjs18.2kMIT5.0.33TypeScript support: included

Feathers SQL service adapter using KnexJS

feathers, feathers-plugin

readme

Feathers - The API and real-time application framework

CI Maintainability Test Coverage Download Status Discord

Feathers is a full-stack framework for creating web APIs and real-time applications with TypeScript or JavaScript.

Feathers can interact with any backend technology, supports many databases out of the box and works with any frontend like React, VueJS, Angular, React Native, Android or iOS.

Getting started

Get started with just three commands:

$ npm create feathers my-new-app
$ cd my-new-app
$ npm run dev

To learn more about Feathers visit the website at feathersjs.com or jump right into the Feathers guides.

Contributing

To start developing, clone this repository, then run:

cd feathers
npm install

To run all tests run

npm test

Individual tests can be run in the module you are working on:

cd packages/feathers
npm test

License

Copyright (c) 2024 Feathers contributors

Licensed under the MIT license.

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

5.0.33 (2025-02-24)

Bug Fixes

  • dependencies: Update dependencies (#3571) (ad611cb)
  • knex: Add tableOptions parameter for inheritance on knex adapter options to pass on knex builder (#3539) (ba5621b)

5.0.32 (2025-02-01)

Note: Version bump only for package @feathersjs/knex

5.0.31 (2024-10-31)

Bug Fixes

5.0.30 (2024-09-02)

Bug Fixes

  • knex: use driver name to identify client (#3527) (bb075ec)

5.0.29 (2024-07-10)

Note: Version bump only for package @feathersjs/knex

5.0.28 (2024-07-10)

Note: Version bump only for package @feathersjs/knex

5.0.27 (2024-06-18)

Note: Version bump only for package @feathersjs/knex

5.0.26 (2024-06-09)

Note: Version bump only for package @feathersjs/knex

5.0.25 (2024-05-03)

Bug Fixes

5.0.24 (2024-03-13)

Note: Version bump only for package @feathersjs/knex

5.0.23 (2024-02-25)

Bug Fixes

5.0.22 (2024-02-15)

Bug Fixes

  • knex: Fix Knex adapter date comparison queries (#3429) (23bafe1)

5.0.21 (2024-01-25)

Note: Version bump only for package @feathersjs/knex

5.0.20 (2024-01-24)

Note: Version bump only for package @feathersjs/knex

5.0.19 (2024-01-23)

Note: Version bump only for package @feathersjs/knex

5.0.18 (2024-01-22)

Note: Version bump only for package @feathersjs/knex

5.0.17 (2024-01-22)

Note: Version bump only for package @feathersjs/knex

5.0.16 (2024-01-22)

Note: Version bump only for package @feathersjs/knex

5.0.15 (2024-01-22)

Bug Fixes

  • generators: Move generators and CLI to featherscloud/pinion (#3386) (eb87c99)
  • knex: Add sqlite to returning clients (#3389) (59fb40b)

5.0.14 (2024-01-05)

Bug Fixes

  • knex: Add Error Handler to knex _update function (#3371) (210f103)

5.0.13 (2023-12-29)

Note: Version bump only for package @feathersjs/knex

5.0.12 (2023-11-28)

Bug Fixes

  • allow _patch to modify the entire base schema (#3300) (0f41622)
  • knex: Add includeTriggerModifications for MSSQL support (#3355) (cbe44b0)

5.0.11 (2023-10-11)

Bug Fixes

  • knex: Update all dependencies and Knex peer (#3308) (d2f9860)

5.0.10 (2023-10-03)

Note: Version bump only for package @feathersjs/knex

5.0.9 (2023-09-27)

Note: Version bump only for package @feathersjs/knex

5.0.8 (2023-07-19)

Note: Version bump only for package @feathersjs/knex

5.0.7 (2023-07-14)

Note: Version bump only for package @feathersjs/knex

5.0.6 (2023-06-15)

Note: Version bump only for package @feathersjs/knex

5.0.5 (2023-04-28)

Note: Version bump only for package @feathersjs/knex

5.0.4 (2023-04-12)

Bug Fixes

  • Make sure all Readme files are up to date (#3154) (a5f0b38)

5.0.3 (2023-04-05)

Bug Fixes

  • dependencies: Update all dependencies (#3139) (f24276e)
  • knex: Ensure that columns are selected unambigiously and avoid duplicate id selection (#3144) (3eb7428)
  • knex: Get by id and transactions should work with params.knex (#3146) (b172b5e)
  • knex: Only apply default order for MSSQL (#3145) (28c2627)

5.0.1 (2023-03-15)

Bug Fixes

  • core: Use Symbol.for to instantiate shared symbols (#3087) (7f3fc21)

5.0.0 (2023-02-24)

Note: Version bump only for package @feathersjs/knex

5.0.0-pre.38 (2023-02-17)

Note: Version bump only for package @feathersjs/knex

5.0.0-pre.37 (2023-02-09)

Bug Fixes

  • knex: The method getModel in the knex adapter (#3043) (77e14dd)

5.0.0-pre.36 (2023-01-29)

Bug Fixes

  • databases: Ensure that query sanitization is not necessary when using query schemas (#3022) (dbf514e)
  • databases: Improve documentation for adapters and allow dynamic Knex adapter options (#3019) (66c4b5e)
  • Update all dependencies (#3024) (283dc47)

Features

5.0.0-pre.35 (2023-01-12)

Bug Fixes

  • databases: Make sure adapter method signatures are exported properly (#2943) (458d668)
  • knex: Ensure custom ids are returned on create (#2934) (c4fa3cf)

Features

  • generators: Move core code generators to shared generators package (#2982) (0328d22)

5.0.0-pre.34 (2022-12-14)

Features

  • adapter: Add patch data type to adapters and refactor AdapterBase usage (#2906) (9ddc2e6)
  • cli: Use separate patch schema and types (#2916) (7088af6)

5.0.0-pre.33 (2022-11-08)

Note: Version bump only for package @feathersjs/knex

5.0.0-pre.32 (2022-10-26)

Note: Version bump only for package @feathersjs/knex

5.0.0-pre.31 (2022-10-12)

Features

  • cli: Generate full client test suite and improve typed client (#2788) (57119b6)
  • cli: Improve generated schema definitions (#2783) (474a9fd)

5.0.0-pre.30 (2022-10-07)

Features

  • core: Allow to unregister services at runtime (#2756) (d16601f)

5.0.0-pre.29 (2022-09-16)

Note: Version bump only for package @feathersjs/knex

5.0.0-pre.28 (2022-08-03)

Bug Fixes

  • cli: Improve generated application and client (#2701) (bd55ffb)
  • knex: Fix PostgreSQL integration issues and run CI tests against pg (#2698) (1f71d78)

5.0.0-pre.27 (2022-07-13)

Note: Version bump only for package @feathersjs/knex

5.0.0-pre.26 (2022-06-22)

Note: Version bump only for package @feathersjs/knex

5.0.0-pre.25 (2022-06-22)

Bug Fixes

  • cli: Generator fixes to work with the new guide (#2674) (b773fa5)

5.0.0-pre.24 (2022-06-21)

Features

  • knex: Add KnexJS SQL database adapter to core (#2671) (9380fff)