ForgeTotal.js 5
de

Total.js 5

QueryBuilder-Betrieb, Filter und Fahrervertrag

Total.js 5 · total5@0.0.19 total5reference Mit Total.js 5 ausgeführt

Diese Seite behandelt den nativen QueryBuilder von total5@0.0.19 (querybuilder.js). DB() gibt einen Warteschlangen-Controller zurück. Jede Operation plant einen Treiberaufruf; füge Filter und Callbacks synchron hinzu, bevor er ausgeführt wird. NEWDB(name, driver) registriert eine Verbindung. NEWDB(name) hebt die Registrierung auf. In dieser Warteschlange gibt es weder eine implizite Datenbank-Engine noch eine Transaktion.

Der Beispiel-Driver kehrt die erhaltenen Optionen zurück.Um eine Datenbank-Operation ausführen, implementieren Sie diese Operation im Driver. Query-Builder-Sqlite.

OperationenDer Treiber erhält
find/all(table), read/one(table), list(table)exec, table; read setzt first:true, take:1; list verwendet standardmäßig take:100, skip:0
check(table), count(table)check setzt first:1, take:1; der Treiber definiert den Ergebniswert
insert/ins(table, data)payload
update/modify/mod/upd(table, data, upsert)payload, upsert; ein Ergebnis von null löst ein zweites insert aus, wenn Upsert aktiviert ist
remove/rem(table), truncate/clear(table), drop(table)Das entsprechende exec; destruktive Operationen brauchen Treiberunterstützung
scalar(table, type, key, key2)scalar:{type,key,key2}; ein ausgelassenes key wird zu *
command(table, name)command:name
query(sql, params) oder query(connection, sql, params)Rohtext in query, Werte in params, die Tabelle ist leer; die SQL-Bindung ist Sache des Treibers
AbfragemethodenOptionen / Verhalten
where(name, [comparer], value), equal(object), id(value), userid(value)Gleichheits-Kurzform; == wird zu =, != wird zu ; Array-IDs verwenden in
in/notin(name, values, [idField]), between(name,a,b), or(fn)Filtern Datensätze; or gruppiert die innerhalb von fn(builder) hinzugefügten Datensätze
array(name,[comparer],value)Standardvergleich &&; die Interpretation obliegt dem Treiber
month/day/year/hour/minute(name,[comparer],value)Filter nach Datumsteil; Standardvergleich =
search(name,value,[where]), contains(name), empty(name)Filtern Datensätze; die Treffersemantik obliegt dem Treiber
query(fragment), join(name,table,type,a,b), permit(name,type,values,userid,required)Treiberspezifische Filter; Rohfragmente müssen aus vertrauenswürdigem Anwendungscode stammen
fields(csv), returning(csv)Arrays getrimmter Feldnamen, kein SQL-Escaping und keine Autorisierung
sort(name, descending), gridsort(csv,[localized])Sortierstrings; true oder desc wählen absteigend
take/limit(n), skip(n), page(page,limit), paginate(page,limit,max)Offsets/Limits; paginate begrenzt das Limit, page nicht
first(), primarykey(name), schema(name), language(value,prefix,skip), debug()Metadaten für den Treiber; first entpackt außerdem ein Array-Ergebnis
gridfilter(name,query,type,[key]), autoquery(query,schema,sort,max)Wandeln Grid-Abfrageparameter in Optionen um. autoquery beschränkt angeforderte Felder und Sortierschlüssel auf das deklarierte Schema
gridfields(fields,allowed)Verwenden Sie fields() mit Ihrer eigenen Erlaubnisliste: Es ist der getestete Weg, um die Spalten zu wählen
callback/pipe(fn), promise(), done($,fn,param)Abschluss; Promises werden bei einem Treiberfehler abgelehnt
data(fn), fail(fn), error/err(message,reverse)Erfolgs-/Fehler-Hooks; error() lehnt leere Ergebnisse ab, reverse:true lehnt wahre Ergebnisse ab (einschließlich eines leeren Arrays)
set(name), nobind()Benennen das Warteschlangenergebnis oder ersetzen die Ausgabe der Warteschlange nicht
insert(fn,param) auf einem Update-BuilderVerändert die Payload vor dem Ersatz-Insert eines Upserts
audit($,message,type)Ruft nach einer erfolgreichen Treiberantwort variables() und audit() des übergebenen Kontexts auf

Controller-Methoden: callback/pipe, promise, done, debug, language, load(connection, options) und exec(options, callback). load kopiert eine definierte Teilmenge serialisierter Optionen; exec leitet unterstützte Operationsnamen weiter. next/free sind Interna des Lebenszyklus. Eine Warteschlange stoppt nach einem Treiberfehler; frühere Schreibvorgänge macht sie nicht rückgängig.

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