MongoDB (noSQL)
Creating a new project
To generate a new project that uses MongoDB, run the command createapp
with the flag --mongodb
.
foal createapp my-app --mongodb
Configuration
npm install mongodb
- YAML
- JSON
- JS
database:
type: mongodb
url: mongodb://localhost:27017/test-foo-bar
{
"database": {
"type": "mongodb",
"url": "mongodb://localhost:27017/test-foo-bar"
}
}
module.exports = {
database: {
type: "mongodb",
url: "mongodb://localhost:27017/test-foo-bar"
}
}
Defining Entities and Columns
More documentation here: https://github.com/typeorm/typeorm/blob/master/docs/mongodb.md.
The definition of entities and columns is the same as in relational databases, except that the ID type must be an ObjectID
and the column decorator must be @ObjectIdColumn
.
import { BaseEntity, Entity, ObjectID, ObjectIdColumn, Column } from 'typeorm';
@Entity()
export class User extends BaseEntity {
@ObjectIdColumn()
_id: ObjectID;
@Column()
firstName: string;
@Column()
lastName: string;
}
Example
import { ObjectId } from 'mongodb';
const user = await User.findOneBy({ _id: new ObjectId('xxxx') });
Authentication
user.entity.ts
import { BaseEntity, Entity, ObjectID, ObjectIdColumn } from 'typeorm';
@Entity()
export class User extends BaseEntity {
@ObjectIdColumn()
_id: ObjectID;
}
Example with JSON Web Tokens:
import { JWTRequired } from '@foal/jwt';
import { ObjectId } from 'mongodb';
import { User } from '../entities';
@JWTRequired({
userIdType: 'string',
user: id => User.findOneBy({ _id: new ObjectId(id) })
})
class MyController {}
The MongoDBStore
npm install @foal/mongodb
If you use sessions with @UseSessions
, you must use the MongoDBStore
from @foal/mongodb
. The TypeORMStore
does not work with noSQL databases.
Limitations
When using MongoDB, there are some features that are not available:
- the
foal g rest-api <name>
command, - and the Groups & Permissions system.