OData V4 Service modules - TYPEORM Connector

Service OData v4 requests from a TYPEORM.

Synopsis

The OData V4 TYPEORM Connector provides functionality to convert the various types of OData segments into SQL query statements, that you can execute over a TYPEORM.

Potential usage scenarios

• Create high speed, standard compliant data sharing APIs

Usage as server - TypeScript

//example request: GET /api/users?$filter=id eq 42&$select=id,name

odataQuery

1import express from 'express';
2import { odataQuery } from 'odata-v4-typeorm';
3import { getRepository } from 'typeorm';
4import { User } from '../entities/user';
5
6const app = express();
7const usersRepository = getRepository(User);
8
9app.get('/api/users', odataQuery(usersRepository));
10
11const port = 3001;
12app.listen(port, () => console.log(`Example app listening on port ${port}!`));

executeQuery by repository

1import express from 'express';
2import { executeQuery } from 'odata-v4-typeorm';
3import { getRepository } from 'typeorm';
4import { User } from '../entities/user';
5
6const app = express();
7
8app.get('/api/users', async (req, res) => {
9  try {
10    const usersRepository = getRepository(User);
11    const data = await executeQuery(usersRepository, req.query);
12    return res.status(200).json(data);
13  } catch (e) {
14    return res.status(500).json({message: 'Internal server error.'});
15  }
16});
17
18const port = 3001;
19app.listen(port, () => console.log(`Example app listening on port ${port}!`));

executeQuery by queryBuilder

1import express from 'express';
2import { executeQuery } from 'odata-v4-typeorm';
3import { getRepository } from 'typeorm';
4import { User } from '../entities/user';
5
6const app = express();
7
8app.get('/api/users', async (req, res) => {
9  try {
10    const queryBuilder = getRepository(User)
11      .createQueryBuilder("user")
12      .where("user.roleName = :roleName", { roleName: 'admin' });
13    const data = await executeQuery(queryBuilder, req.query);
14    return res.status(200).json(data);
15  } catch (e) {
16    return res.status(500).json({message: 'Internal server error.'});
17  }
18});
19
20const port = 3001;
21app.listen(port, () => console.log(`Example app listening on port ${port}!`));

createFilter

1import { createFilter } from 'odata-v4-typeorm'
2
3//example request:  GET /api/Users?$filter=Id eq 42
4app.get("/api/Users", (req: Request, res: Response) => {
5    const filter = createFilter(req.query.$filter);
6    // connection instance from pg module
7    connection.query(`SELECT * FROM Users WHERE ${filter.where}`, filter.parameters, function(err, result){
8        res.json({
9        	'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#Users',
10        	value: result.rows
11        });
12    });
13});

Advanced TypeScript example available here.

Usage ES5

1var createFilter = require('odata-v4-typeorm').createFilter;
2
3app.get("/api/Users", function(req, res) {
4    var filter = createFilter(req.query.$filter);
5    // connection instance from pg module
6    connection.query(filter.from("Users"), filter.parameters, function(err, result){
7        res.json({
8        	'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#Users',
9        	value: result.rows
10        });
11    });
12})

Supported OData segments

• $filter
• $select
• $skip
• $top
• $orderby
• $expand
• $count

If you have any questions, please don’t hesitate to contact me.

• skype: andryuha49.
• https://www.linkedin.com/in/andriy-zherdiy/