A package of Ts.ED framework. See website: https://tsed.dev/tutorials/objection.html

Feature

Currently, @tsed/objection allows you:

- Configure one database connection via the @Configuration decorator.
- Databases will be initialized when the server starts during the server's OnInit phase.
- Declare a Model from a class with annotation,

> Note: @tsed/objection use the JsonSchema and his decorators to generate the table.

Installation

Before using the @tsed/objection package, we need to install the Obection.js and Knex modules.

Install the dependencies:

``bash
npm install --save @tsed/objection objection knex
`

We also need to install one of the following depending on the database you want to use:

`bash
npm install pg
npm install sqlite3
npm install mysql
npm install mysql2
`

Configuration

Add a knex configuration to your Ts.ED configuration (see: http://knexjs.org/#Installation-client for options):

`typescript
import {Configuration} from "@tsed/platform-http";
import "@tsed/objection"; // don't forget to add this line!

@Configuration({
// ...
knex: {
client: "sqlite3",
connection: ":memory:"
}
})
class Server {}
``

Contributors

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

The MIT License (MIT)

Copyright (c) 2016 - 2022 Romain Lenzotti

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.