O documento apresenta uma comparação entre os pacotes Sequelize e Bookshelf, que são bibliotecas ORM para Node.js para bancos de dados relacionais. O Sequelize suporta mais bancos de dados e possui uma configuração e uso mais simples, enquanto o Bookshelf requer plugins adicionais e tem uma documentação mais avançada. Ambos permitem consultas, inclusão, atualização e exclusão de dados, bem como operações SQL nativas e procedimentos armazenados.

1. Globalcode – Open4education
Trilha Node.js
Não apenas NoSQL - Conheça os pacotes de ORM do
Node.js para os principais bancos de dados relacionais
São Paulo - 2017

2. Globalcode – Open4education
2
Agenda
Ainda bancos relacionais?
Pacotes escolhidos
Comparação

3. Globalcode – Open4education
3
José quem?
Desde1994

4. Globalcode – Open4education
4
Ainda bancos relacionais?
OBRIGADO POR SEREM
GRANDES VOCÊ NÃO BANCOS
DE DADOS RELACIONAIS

5. Globalcode – Open4education
5
Ainda bancos relacionais?
Fonte: db-engines.com

6. Globalcode – Open4education
6
Ainda bancos relacionais?
Fonte: db-engines.com
jan/2013 - jul/2017

7. Globalcode – Open4education
7
Ainda bancos relacionais?
Adoção de bancos por categoria (julho/2017)
Fonte: db-engines.com

8. Globalcode – Open4education
8
Pacotes escolhidos
'ORM' no NPM com + downloads:
1º 2º 3º 4º
Difícil usar
sem o SAILS
Muito menos
uso e "alpha"

9. Globalcode – Open4education
9
Pacotes escolhidos
Dados a seguir são de 17/07/2017

10. Globalcode – Open4education
10
Sequelize
Agosto/2010
~25k/dia, ~480k último mês
+3100 perguntas
565 devs / 204 releases (24 último ano)

11. Globalcode – Open4education
11
Bookshelf
Maio/2013
~2,8k/dia, ~75k último mês
+440 perguntas
115 devs / 67 releases (4 último ano)

12. Globalcode – Open4education
12
Mega super base p/ comparação

13. Globalcode – Open4education
13Sequelize
Configuração e instalação
npm install sequelize --save

14. Globalcode – Open4education
14Sequelize
Configuração e instalação
var Sequelize = require(’sequelize')
// conexão simples
var sequelize = new Sequelize(
'postgres://usuario:senha@127.0.0.1:5432/minha_base');

15. Globalcode – Open4education
15Sequelize
Configuração e instalação
// conexão detalhada
var sequelize = new Sequelize(‘minha_base’, 'usuario', 'senha', {
host: ‘127.0.0.1’,
dialect: 'mysql'|'sqlite'|'postgres'|'mssql',
pool: {
max: 5,
min: 0,
idle: 10000
}
});

16. Globalcode – Open4education
16Sequelize
ORM
27 tipos, incluindo
BLOB, GEOMETRY, GEOGRAPHY e RANGE
32 Validadores. É possível criar um customizado

17. Globalcode – Open4education
17Sequelize
ORM
var Clube = sequelize.define('clube',
{
nome: Sequelize.STRING
}
);

18. Globalcode – Open4education
18Sequelize
ORM
var Jogador = sequelize.define('jogador',
{
nome: Sequelize.STRING,
foto: Sequelize.BLOB
}
);

19. Globalcode – Open4education
19Sequelize
ORM
var Jogador = sequelize.define('jogador',
...
apelido: {
type: Sequelize.STRING,
get() { return // como quero o apelido },
set(val) { // como mudar o apelido }
}
);

20. Globalcode – Open4education
20Sequelize
ORM
var Jogador = sequelize.define('jogador',
...
getterMethods: { // atributos 'transientes'
dclube() {
if (this.id_clube ==null) { return 'Sem Clube'; }
return this.id_clube;
}
}
);

21. Globalcode – Open4education
21Sequelize
ORM
Relacionamentos
Clube.hasMany(Jogador, { as: ‘jogadores’ });
Jogador.belongsTo(Clube);

22. Globalcode – Open4education
22Sequelize
Consultas “JSON Style”
Clube.findById(2).then( clube => {
// faça algo com o “clube”
}
);
Clube.findOne( { where: {nome: 'Equipe Idô'} } ).then( clube => {
// faça algo com o “clube”
}
);

23. Globalcode – Open4education
23Sequelize
Consultas “JSON Style”
Jogador.findAll({
where: {
clubeId:1
}
}).then( jogadores => {
// faça algo com o array "jogadores"
}
);

24. Globalcode – Open4education
24Sequelize
Consultas “JSON Style”
Jogador.findAll({
where: {
clubeId:2,
nome: {
$like: 'JOAO%'
}
}
}).then( jogadores => {
// faça algo com o array "jogadores"
}
);

25. Globalcode – Open4education
25Sequelize
Incluir, atualizar e excluir
Incluir
Clube.create( {nome: 'Bola Craia' } );
var clube0 = Clube.build({
nome: 'Clube Nário'
});
clube0.save();

26. Globalcode – Open4education
26Sequelize
Incluir, atualizar e excluir
Atualizar
Clube.update(
{ nome: 'Time ia boca' },
{ where: { id : 1 } }
);
clube0.save();

27. Globalcode – Open4education
27Sequelize
Incluir, atualizar e excluir
Excluir
clube0.destroy();
clube0.destroy({ force: true })
// se usar o “deletedAt”, deve-se usar o “force:true”

28. Globalcode – Open4education
28Sequelize
Operações com SQL Nativo
sequelize.query(
'SELECT * FROM jogador where id_clube=2',
{ model: Jogador }
).then( jogadores => {
// faça algo com o array "jogadores"
}
);

29. Globalcode – Open4education
29Sequelize
Operações com SQL Nativo
sequelize.query(
'UPDATE jogador SET id_clube = 3 WHERE idclube is
null' ).spread( (resultados, linhas) => {
// “resultados” seria a lista de linhas num resultado
// “linhas” linhas afetadas
});

30. Globalcode – Open4education
30Sequelize
Stored Procedures e Functions
sequelize.query(
'CALL/Select minha_procedure_ou_funcao();'
).then( resposta => {
// resposta c/ o retorno da procedure ou function
}).error(function(err){
// faça algo com o “err”
}
);

31. Globalcode – Open4education
31Sequelize
Servidores compatíveis

32. Globalcode – Open4education
32Sequelize
Pontos fracos
Não é possível usar parâmetros de saída em
Stored Procedures
Sem suporte a Oracle

33. Globalcode – Open4education
33Sequelize
Pontos fracos
Convenção CamelCase ao invéis de snake_case
createdAt, updatedAt, deletedAt
obrigatórios por padrão
Nomes de tabelas no plural por padrão

34. Globalcode – Open4education
34Bookshelf
Configuração e instalação
npm install knex --save
npm install bookshelf --save

35. Globalcode – Open4education
35Bookshelf
Configuração e instalação
var knex = require('knex')({
client: 'mysql',
connection: {
host: '127.0.0.1',
user: 'login',
password: 'senha',
database: 'base'
}
});
var bookshelf = require('bookshelf')(knex);

36. Globalcode – Open4education
36Bookshelf
ORM
Por padrão, não define tipos de campos. Para isso,
precisamos do “bookshelf-schema” plugin
Com o “bookshelf-schema” existem 11 tipos
45 Validadores. É possível criar um customizado

37. Globalcode – Open4education
37Bookshelf
ORM
var Clube = bookshelf.Model.extend({
tableName: 'clube',
jogadores: function() {
return this.hasMany(Jogador);
}
});

38. Globalcode – Open4education
38Bookshelf
ORM
var Jogador = bookshelf.Model.extend({
tableName: 'jogador',
time: function() {
return this.belongsTo(Clube);
}
});

39. Globalcode – Open4education
39Bookshelf
ORM
Para recuperar atributos:
var nome = jogador.get(‘nome’);

40. Globalcode – Open4education
40Bookshelf
ORM
Para atribuir valores:
jogador.set('apelido', 'Zé Buduia');
jogador.set(
{nome: 'João Silva', apelido: 'Zé Ruela'}
);

41. Globalcode – Open4education
41Bookshelf
Consultas “JSON Style”
new Clube( { {nome: 'Equipe Lantra'} } ).fetch().then( function(clube) {
// faça algo com o “clube”
}
);
new Jogador( {‘apelido’:’pikachu’} ).fetch().then( function(jogador) {
// faça algo com o “jogador”
});

42. Globalcode – Open4education
42Bookshelf
Consultas “JSON Style”
new Jogador( {‘apelido’:’pikachu’} ).fetchAll()
.then( function(jogadores) {
// faça algo com o array "jogadores"
});

43. Globalcode – Open4education
43Bookshelf
Consultas “JSON Style”
new Jogador()
.where('nome', 'LIKE', 'JOAO%')
.andWhere('clube_id', '=', 2)
.fetchAll().then(function(jogadores) {
// faça algo com o array "jogadores"
}
);

44. Globalcode – Open4education
44Bookshelf
Incluir, atualizar e excluir
Incluir
Clube.forge( {nome: 'Time Díocre' } ).save();
new Clube( {nome: 'Time Drozo' } ).save();
var clube0 = new Clube(...);
clube0.save();

45. Globalcode – Open4education
45Bookshelf
Incluir, atualizar e excluir
Atualizar
clube0.save();

46. Globalcode – Open4education
46Bookshelf
Incluir, atualizar e excluir
Excluir
clube0.destroy();

47. Globalcode – Open4education
47Bookshelf
Operações com SQL Nativo
knex.raw('SELECT * FROM jogador where id_clube= 2')
).then( function(jogadores) {
// faça algo com o array “jogadores”
}
);

48. Globalcode – Open4education
48Bookshelf
Operações com SQL Nativo
knex.raw(
'UPDATE jogador SET id_clube = 3 WHERE id_clube is null')
.then( function(metadata){
// “metadata” linhas afetadas
}
);

49. Globalcode – Open4education
49Bookshelf
Stored Procedures e Functions
knex.raw(
'CALL/Select minha_procedure_ou_funcao();')
.then( function(metadata){
// “metadata” linhas afetadas ou resultado
}
);

50. Globalcode – Open4education
50Bookshelf
Servidores compatíveis

51. Globalcode – Open4education
51Bookshelf
Pontos fracos
Não é possível usar parâmetros de saída em
Stored Procedures
Sem suporte a Oracle nem SQL Server
Configuração padrão é muito básica. Necessidade
de vários “plugins” (outros pacotes)

52. Globalcode – Open4education
52Bookshelf
Pontos fracos
Convenções pobres
(ex: deve-se sempre informar o nome da tabela)
Documentação muito avançada para iniciantes
Não é claro que funcionalidades da Knex podem
ser usadas

53. Globalcode – Open4education
53
Comparação geral

54. Dúvidas?
jyoshiriro@gmail.com
jyoshiriro
jyoshiriro
TDC São Paulo 2017