ForgeTotal.js 5
es

Total.js 5

Query Builder: DB() y NEWDB() con su propio driver de datos

Total.js 5 · total5@0.0.19 databasequerybuilder Ejecutada con Total.js 5

DB() construye una consulta sin saber qué base de datos la ejecutará, y NEWDB() registra el driver que la ejecuta. total5 no tiene un driver SQL: el query builder reúne lo que pides en un objeto options y llama a tu driver con él, y el driver (el tuyo, o uno que venga en un módulo) traduce options a SQL, a una llamada NoSQL o a cualquier otra cosa.

  • NEWDB(driver) registra el driver por defecto y NEWDB('name', driver) uno con nombre. El driver es function(options, callback): responde con callback(error, response). Una tabla escrita como name/table (DB().find('audit/log')) usa el driver name y la tabla log; sin prefijo el driver es default.
  • Las operaciones comienzan la consulta: find(table) (en el caso de los read(table) un objeto, o null Cuando no hay nada, list(table) (Una página de un array: response.page, limit y pages se añaden a lo que el conductor vuelve, así que el condutor debe establecer county insert(table, data)El constructor también tiene count, update, remove y queryEl conductor funciona de la misma manera (el conductor options.exec con ese nombre).
  • Realizar la consulta con: where(name, [comparer], value) (= Cuando no hay comparación, fields('a,b'), sort(name, [true]) (true para descender, take(n) y page(page, limit)Otras modificaciones incluyen id, in, skip, between y search.
  • Termina con .callback($): el resultado va a la respuesta de la acción $, o a una función (err, response) que pases en su lugar.

Para el catálogo de operaciones nativas completo, el comportamiento de error y las formas de filtro, vea Contrato de constructorPara SQL CRUD, Compromise y Rollback, ver Query-constructor-sqliteLas opciones que recibe el conductor son datos claros.El ejemplo del conductor almacena los registros en la memoria y exhibe el último objeto de options recibido.

definitions/db.js
const users = [
	{ id: 1, name: 'Ann', age: 31 },
	{ id: 2, name: 'Bob', age: 17 },
	{ id: 3, name: 'Cy', age: 45 }
];

F.seen = [];

// The default driver: it understands only "age >= value" and "id = value", which is all this example asks
NEWDB(function(options, callback) {

	F.seen.push(JSON.parse(JSON.stringify(options)));

	let rows = users.slice();

	for (let f of options.filter) {
		if (f.type === 'where' && f.name === 'age' && f.comparer === '>=')
			rows = rows.filter(n => n.age >= f.value);
		else if (f.type === 'where' && f.name === 'id')
			rows = rows.filter(n => n.id === f.value);
	}

	switch (options.exec) {
		case 'find':
		case 'read':
			if (options.sort && options.sort[0] === 'name_desc')
				rows.sort((a, b) => a.name < b.name ? 1 : -1);
			if (options.take)
				rows = rows.slice(0, options.take);
			return callback(null, rows);
		case 'list':
			rows.count = rows.length;
			return callback(null, rows);
		case 'insert':
			users.push(Object.assign({ id: users.length + 1 }, options.payload));
			return callback(null, users[users.length - 1]);
		default:
			return callback('The driver does not know ' + options.exec);
	}
});

// A second driver, used by the tables that start with "audit/"
NEWDB('audit', function(options, callback) {
	F.seen.push({ driver: 'audit', table: options.table });
	callback(null, [{ event: 'login' }]);
});
controllers/users.js
exports.install = function() {
	ROUTE('GET /adults/', adults);
	ROUTE('GET /user/{id}/', user);
	ROUTE('POST /users/', create);
	ROUTE('GET /page/', page);
	ROUTE('GET /audit/', audit);
	ROUTE('GET /seen/', seen);
};

function adults($) {
	DB().find('users').where('age', '>=', 18).fields('id,name').sort('name', true).take(5).callback($);
}

function user($) {
	DB().read('users').where('id', +$.params.id).callback($);
}

function create($) {
	DB().insert('users', { name: $.body.name, age: $.body.age }).callback($);
}

function page($) {
	DB().list('users').page(1, 2).callback(function(err, response) {
		$.json({ err: err, count: response.count, page: response.page, limit: response.limit, pages: response.pages });
	});
}

function audit($) {
	DB().find('audit/log').callback($);
}

function seen($) {
	$.json(F.seen);
}