ForgeTotal.js 5
sk

Total.js 5

QueryBuilder operácie, filtre a zmluvy s vodičom

Total.js 5 · total5@0.0.19 total5reference Spustené s Total.js 5

Táto stránka pokrýva natívny QueryBuilder z total5@0.0.19 (querybuilder.js). DB() vracia kontrolér fronty. Každá operácia naplánuje volanie drivera; filtre a callbacky pridávajte synchrónne pred jej vykonaním. NEWDB(name, driver) registruje spojenie. NEWDB(name) ho odregistruje. V tejto fronte nie je implicitný databázový engine ani transakcia.

Príkladový ovládač vráti prijaté možnosti. Ak chcete vykonať prevádzku databázy, implementujte túto prevádzku v ovládači. Pre skutočnú prevádzku SQL a rollback pozri Vyhľadávač-sqlite.

OperácieDriver dostane
find/all(table), read/one(table), list(table)exec, table; read nastaví first:true, take:1; list predvolene používa take:100, skip:0
check(table), count(table)check nastaví first:1, take:1; hodnotu výsledku určuje driver
insert/ins(table, data)payload
update/modify/mod/upd(table, data, upsert)payload, upsert; nulový výsledok spustí druhý insert, keď je upsert zapnutý
remove/rem(table), truncate/clear(table), drop(table)Zodpovedajúci exec; deštruktívne operácie potrebujú podporu drivera
scalar(table, type, key, key2)scalar:{type,key,key2}; vynechaný key sa stane *
command(table, name)command:name
query(sql, params) alebo query(connection, sql, params)Surový text v query, hodnoty v params, tabuľka je prázdna; viazanie SQL je zodpovednosťou drivera
Metódy dotazuMožnosti / správanie
where(name, [comparer], value), equal(object), id(value), userid(value)Skratka rovnosti; == sa stane =, != sa stane ; pole ID používa in
in/notin(name, values, [idField]), between(name,a,b), or(fn)Filtrujú záznamy; or zoskupuje záznamy pridané vnútri fn(builder)
array(name,[comparer],value)Predvolený komparátor &&; interpretácia patrí driveru
month/day/year/hour/minute(name,[comparer],value)Filtre podľa časti dátumu; predvolený komparátor =
search(name,value,[where]), contains(name), empty(name)Filtrujú záznamy; sémantika zhody patrí driveru
query(fragment), join(name,table,type,a,b), permit(name,type,values,userid,required)Filtre špecifické pre driver; surové fragmenty musia pochádzať z dôveryhodného kódu aplikácie
fields(csv), returning(csv)Polia orezaných názvov polí, nie SQL escapovanie ani autorizácia
sort(name, descending), gridsort(csv,[localized])Reťazce triedenia; true alebo desc zvolia zostupné
take/limit(n), skip(n), page(page,limit), paginate(page,limit,max)Posuny/limity; paginate obmedzí limit, page nie
first(), primarykey(name), schema(name), language(value,prefix,skip), debug()Metadáta pre driver; first tiež rozbalí výsledok v poli
gridfilter(name,query,type,[key]), autoquery(query,schema,sort,max)Prevedú parametre dotazu gridu na možnosti. autoquery obmedzí požadované polia a kľúče triedenia na deklarovanú schému
gridfields(fields,allowed)Použite fields() s vlastnou povolenou zoznamom: je to testovaný spôsob, ako vybrať stĺpce
callback/pipe(fn), promise(), done($,fn,param)Dokončenie; promise sa pri chybe drivera zamietne
data(fn), fail(fn), error/err(message,reverse)Hooky úspechu/zlyhania; error() zamietne prázdne výsledky, reverse:true zamietne pravdivé výsledky (vrátane prázdneho poľa)
set(name), nobind()Pomenujú výsledok vo fronte, alebo nenahradia výstup fronty
insert(fn,param) na update builderiUpraví payload pred záložným insertom upsertu
audit($,message,type)Po úspešnej odpovedi drivera zavolá variables() a audit() dodaného kontextu

Metódy kontroléra: callback/pipe, promise, done, debug, language, load(connection, options) a exec(options, callback). load skopíruje definovanú podmnožinu serializovaných možností; exec odošle podporované názvy operácií. next/free sú interné veci životného cyklu. Fronta sa po chybe drivera zastaví; skoršie zápisy nevráti späť.

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); }
}