inthepocket / fastify-typeorm-plugin

Fastify plugin for TypeORM

fastify-typeorm

Fastify plugin for TypeORM for sharing the same TypeORM connection in every part of your server. Under the hood the official TypeORM module is used.

Install

npm install fastify-typeorm-plugin

Usage

Add it to your project with register and you are done! The plugin accepts the same connection options as the TypeORM client.

const fastify = require('fastify')();

const user = require('./entity/user');

fastify.register(require('fastify-typeorm-plugin'), {
  type: 'sqlite',
  database: './mydb.sql',
});

fastify.get('/users', async function(req, reply) {
  const users = await this.orm
    .getRepository(User)
    .createQueryBuilder('user')
    .getMany();

  return users;
});

fastify.listen(3000, err => {
  if (err) throw err;
});

If you won't pass config, it will use typeorm default createConnection mechanism:

const fastify = require('fastify')();

const user = require('./entity/user');

fastify.register(require('fastify-typeorm-plugin'));

fastify.get('/users', async function(req, reply) {
  const users = await this.orm
    .getRepository(User)
    .createQueryBuilder('user')
    .getMany();

  return users;
});

fastify.listen(3000, err => {
  if (err) throw err;
});

You can also pass in an existing connection:

const { createConnection } = require('typeorm');

const fastify = require('fastify')();
const connection = await createConnection({
  type: 'sqlite',
  database: './mydb.sql',
});
fastify.register(require('fastify-typeorm-plugin'), {
  connection,
});

Team

• Glenn Bostoen https://github.com/gboston https://twitter.com/gbostoen
• Jonas Goderis https://github.com/jonasgoderis https://twitter.com/JonasGoderis

License

Licensed under MIT.

fastify-typeorm-plugin's Issues

ConnectionNotFoundError: Connection "default" was not found.

Hi,

Hope whoever reads this is safe, healthy and earning a lot of money !!

I am trying to use your library for the typescript, fastify, typeorm for basic setup.
Below is my code, I took from your example and trying to run.

File: app.ts

import fastify, { FastifyInstance } from 'fastify';
import fastifyTypeorm, {  } from 'fastify-typeorm';
import typeorm, { getManager } from 'typeorm'

import { User } from './entity/user'



const app: FastifyInstance = fastify()

app.register(fastifyTypeorm, {
	type: 'sqlite',
	database: './db.sqlite',
})

const entityManager = getManager()



app.get('/users', async (req, res) => {
  const users = await entityManager.find(User)
  return users;
});

app.post('/users', async (req, res) => {
	const user = new User()
	console.log(req)
	user.name = "John Grow up"
	user.isActive = false
	const result = await entityManager.save(user)
	console.log(result)
})



app.get('/', (req, res) => {
	res.send('Hello')
})

app.listen(8000, () => console.log('Server running'))

The error I recieve is written below.

/src/error/ConnectionNotFoundError.ts:8
        super();
        ^
ConnectionNotFoundError: Connection "default" was not found.
    at new ConnectionNotFoundError (src/error/ConnectionNotFoundError.ts:8:9)
    at ConnectionManager.get (src/connection/ConnectionManager.ts:40:19)
    at Object.getManager (src/index.ts:262:35)
    at Object.<anonymous> (src/app.ts:16:23)
    at Module._compile (internal/modules/cjs/loader.js:1251:30)
    at Module.m._compile (/node_modules/ts-node/src/index.ts:1043:23)
    at Module._extensions..js (internal/modules/cjs/loader.js:1272:10)
    at Object.require.extensions.<computed> [as .ts] (node_modules/ts-node/src/index.ts:1046:12)
    at Module.load (internal/modules/cjs/loader.js:1100:32)
    at Function.Module._load (internal/modules/cjs/loader.js:962:14)

Think I have not defined the connection to database correctly. Also, I have not configured an ormconfig.json file.
thanks in advance

Publish plugin to fastify-typeorm instead of fastify-typeorm-plugin

I've gotten access to fastify-typeorm Maybe it's best to deprecate the current plugin (fastify-typeorm-plugin) and publish everything to fastify-typeorm?

Update package.json so that typeorm is a peer dependency

After updating a patch version of typeorm, our application started breaking due to a mismatch in typeorm versions.

~/Documents/repos/audit-service - (renovate/patch-npm-deps) > yarn why typeorm
yarn why v1.22.17
[1/4] 🤔  Why do we have the module "typeorm"...?
[2/4] 🚚  Initialising dependency graph...
[3/4] 🔍  Finding dependency...
[4/4] 🚡  Calculating file sizes...
=> Found "[email protected]"
info Has been hoisted to "typeorm"
info This module exists because it's specified in "dependencies".
info Disk size without dependencies: "26.7MB"
info Disk size with unique dependencies: "29.73MB"
info Disk size with transitive dependencies: "34.9MB"
info Number of shared dependencies: 44
=> Found "fastify-typeorm#[email protected]"
info This module exists because "fastify-typeorm" depends on it.
info Disk size without dependencies: "25.98MB"
info Disk size with unique dependencies: "29.01MB"
info Disk size with transitive dependencies: "34.18MB"
info Number of shared dependencies: 44
✨  Done in 0.75s.

This is a known issue with Query Operators (typeorm/typeorm#8579) and having more than one version of typeorm installed in node_modules.

To fix this issue, the typeorm dependency in your package should be listed as a peer dependency instead of a direct dependency.

I can confirm this fixes the issue as running yarn upgrade typeorm fastify-typeorm syncs the version and fixes the issue in our application.

Outdated peer dependency with Typeorm

TypeORM is now on version 0.3.11. Due to this library's peer dependency, this means that the package is no longer compatible with the latest version of TypeORM.

We should upgrade the TypeORM dependency and make any fixes if necessary.

How to use the connection from arrow function?

this is the code:

app.get('/list', scheme, async (request) => {
// access typeorm connection
});

can it be done with this? or it cant?

Thank you