ForgeTotal.js 5
pt

Total.js 5

QueryBuilder operações, filtros e contrato de driver

Total.js 5 · total5@0.0.19 total5reference Executada com o Total.js 5

Esta página cobre o QueryBuilder nativo do total5@0.0.19 (querybuilder.js). DB() devolve um controlador de fila. Cada operação agenda uma chamada ao driver; acrescente filtros e callbacks de forma síncrona antes de ela ser executada. NEWDB(name, driver) regista uma ligação. NEWDB(name) remove o registo. Não há motor de base de dados nem transação implícitos nesta fila.

O driver de exemplo retorna as opções recebidas.Para executar uma operação de banco de dados, implementar essa operação no driver. Queri-construção Sqlite.

OperaçõesO driver recebe
find/all(table), read/one(table), list(table)exec, table; read define first:true, take:1; list por omissão usa take:100, skip:0
check(table), count(table)check define first:1, take:1; o driver define o valor do resultado
insert/ins(table, data)payload
update/modify/mod/upd(table, data, upsert)payload, upsert; um resultado zero aciona um segundo insert quando o upsert está ativo
remove/rem(table), truncate/clear(table), drop(table)O exec correspondente; as operações destrutivas precisam de suporte do driver
scalar(table, type, key, key2)scalar:{type,key,key2}; um key omitido passa a *
command(table, name)command:name
query(sql, params) ou query(connection, sql, params)Texto em bruto em query, valores em params, a tabela está vazia; a associação de parâmetros SQL é responsabilidade do driver
Métodos de consultaOpções / comportamento
where(name, [comparer], value), equal(object), id(value), userid(value)Atalho de igualdade; == passa a =, != passa a ; IDs em array usam in
in/notin(name, values, [idField]), between(name,a,b), or(fn)Filtram registos; or agrupa os registos adicionados dentro de fn(builder)
array(name,[comparer],value)Comparador por omissão &&; a interpretação cabe ao driver
month/day/year/hour/minute(name,[comparer],value)Filtros por parte da data; comparador por omissão =
search(name,value,[where]), contains(name), empty(name)Filtram registos; a semântica de correspondência cabe ao driver
query(fragment), join(name,table,type,a,b), permit(name,type,values,userid,required)Filtros específicos do driver; os fragmentos em bruto têm de vir de código de aplicação de confiança
fields(csv), returning(csv)Arrays de nomes de campos aparados, não escape SQL nem autorização
sort(name, descending), gridsort(csv,[localized])Strings de ordenação; true ou desc selecionam descendente
take/limit(n), skip(n), page(page,limit), paginate(page,limit,max)Deslocamentos/limites; paginate limita o teto, page não
first(), primarykey(name), schema(name), language(value,prefix,skip), debug()Metadados para o driver; first também desembrulha um resultado em array
gridfilter(name,query,type,[key]), autoquery(query,schema,sort,max)Convertem parâmetros de consulta de grelha em opções. autoquery restringe os campos pedidos e as chaves de ordenação ao seu esquema declarado
gridfields(fields,allowed)Use fields() com sua própria lista de permissões: é a maneira testada de escolher as colunas
callback/pipe(fn), promise(), done($,fn,param)Conclusão; as promessas são rejeitadas perante um erro do driver
data(fn), fail(fn), error/err(message,reverse)Hooks de sucesso/falha; error() rejeita resultados vazios, reverse:true rejeita resultados verdadeiros (incluindo um array vazio)
set(name), nobind()Dão nome ao resultado em fila, ou não substituem a saída da fila
insert(fn,param) num builder de updateModifica o payload antes do insert de recurso de um upsert
audit($,message,type)Chama variables() e audit() do contexto fornecido após uma resposta bem-sucedida do driver

Métodos do controlador: callback/pipe, promise, done, debug, language, load(connection, options) e exec(options, callback). load copia um subconjunto definido de opções serializadas; exec despacha os nomes de operação suportados. next/free são detalhes internos do ciclo de vida. Uma fila pára após um erro do driver; não desfaz escritas anteriores.

definitions/contract.js
NEWDB('contract', function(options, callback) {
	if (options.table === 'failure')
		return callback(new Error('driver failed'));
	if (options.table === 'empty')
		return callback(null, []);
	if (options.table === 'upsert') {
		MAIN.upsert.push(JSON.parse(JSON.stringify(options)));
		return callback(null, options.exec === 'update' ? 0 : options.payload);
	}
	if (options.exec === 'list')
		return callback(null, { items: [], count: 12 });
	callback(null, options.first ? [options] : options);
});
MAIN.upsert = [];
controllers/contract.js
exports.install = function() {
	ROUTE('GET /contract/', contract);
};

async function contract($) {
	try {
		var out = {};
		var methods = ['find', 'all', 'read', 'one', 'list', 'check', 'count', 'insert', 'ins', 'update', 'modify', 'mod', 'upd', 'remove', 'rem', 'truncate', 'clear', 'drop'];
		out.operations = {};
		for (var method of methods)
			out.operations[method] = await DB()[method]('contract/items', { name: 'Ann' }).promise();
		out.scalar = await DB().scalar('contract/items', 'sum', 'amount', 'group').promise();
		out.command = await DB().command('contract/items', 'vacuum').promise();
		out.raw = await DB().query('contract', 'SELECT ?', [7]).promise();
		out.filters = await DB().find('contract/items').id([1, 2]).userid({ id: 'u1' }).equal({ active: true }).where('age', '!=', 0).in('team', [{ id: 'a' }], 'id').notin('team', 'b').between('age', 18, 65).or(function(q) { q.where('role', 'a').where('role', 'b'); }).array('tags', ['x']).month('created', 1).day('created', 2).year('created', '>=', 2020).hour('created', 3).minute('created', 4).search('name', 'ann', 'beg').contains('email').empty('deleted').query('trusted_fragment').join('team', 'teams', 'left', 'a.id', 'b.id').permit('permissions', 'RW', ['team'], 'u1', false).promise();
		out.options = await DB().find('contract/items').fields('id, name').returning('id, name').sort('name', true).gridsort('id_asc').limit(5).skip(2).primarykey('uid').schema('public').language({ language: 'es' }, '_').debug().promise();
		out.page = await DB().list('contract/items').paginate('2', '500', 10).promise();
		out.grid = await DB().find('contract/items').autoquery({ fields: 'id,password', sort: 'password_desc,name_desc', page: '2', limit: '500', age: '>18' }, 'id:String,name:String,age:Number', 'id_asc', 10).promise();
		out.gridfields = await DB().find('contract/items').gridfields('id', 'id,name').promise();
		var queue = DB();
		queue.read('contract/items').set('one');
		queue.count('contract/items').set('count');
		queue.find('contract/items').nobind();
		out.queue = await queue.promise();
		var hooks = [];
		await DB().read('contract/empty').data(function(v) { hooks.push(v === null ? 'null' : 'value'); }).promise();
		try { await DB().read('contract/empty').error('missing').fail(function() { hooks.push('fail'); }).promise(); } catch (e) { out.missing = String(e); }
		try { await DB().find('contract/failure').promise(); } catch (e) { out.failure = String(e); }
		out.hooks = hooks;
		out.upsert = await DB().update('contract/upsert', { name: 'new' }, true).where('id', 7).insert(function(payload, role) { payload.role = role; }, 'member').promise();
		out.upsertCalls = MAIN.upsert;
		out.load = await DB().load('contract', { table: 'items', exec: 'find', take: 2, filter: [] }).promise();
		$.json(out);
	} catch (e) { $.invalid(e); }
}