# QueryBuilder-verksamhet, filter och föraravtal

> Inspektera inhemska DB- och NEWDB-alternativ, resultat, uppbrott, fel och filterformer utan att förväxla en byggare med en databasdrivare.

Framework: total5
Product: Total.js 5 (total5@0.0.19)
Language: sv
Content-SHA256: 2e025dfe332759a5b13d62b47e5b7cae4c037d11522849a5b74f5373cd0fcfa3
Snapshot: c0700e321579725c5cf4f5ace1ad7d2866d1b4f93c24a63c0b41b6b7998e976c
Sources: total5-installed@total5@0.0.19
Review: not-recorded

Den här sidan behandlar den inbyggda QueryBuilder i `total5@0.0.19` (`querybuilder.js`). `DB()` returnerar en kökontroller. Varje operation schemalägger ett drivrutinsanrop; lägg till filter och callbacks synkront innan det körs. `NEWDB(name, driver)` registrerar en anslutning. `NEWDB(name)` avregistrerar den. Det finns ingen implicit databasmotor eller transaktion i den här kön.

Exempeldrivaren returnerar de mottagna alternativen. För att utföra en databasoperation, implementera den operationen i drivrutinen. [Fråga-byggare-sqlite](/en/total5/query-builder-sqlite/).

| Operationer | Drivrutinen tar emot |
|---|---|
| `find/all(table)`, `read/one(table)`, `list(table)` | `exec`, `table`; `read` sätter `first:true`, `take:1`; `list` har som standard `take:100`, `skip:0` |
| `check(table)`, `count(table)` | `check` sätter `first:1`, `take:1`; drivrutinen definierar resultatvärdet |
| `insert/ins(table, data)` | `payload` |
| `update/modify/mod/upd(table, data, upsert)` | `payload`, `upsert`; ett nollresultat utlöser en andra `insert` när upsert är aktiverat |
| `remove/rem(table)`, `truncate/clear(table)`, `drop(table)` | Motsvarande `exec`; destruktiva operationer kräver drivrutinsstöd |
| `scalar(table, type, key, key2)` | `scalar:{type,key,key2}`; en utelämnad `key` blir `*` |
| `command(table, name)` | `command:name` |
| `query(sql, params)` eller `query(connection, sql, params)` | Rå text i `query`, värden i `params`, tabellen är tom; SQL-bindning är drivrutinens ansvar |

| Frågemetoder | Alternativ / beteende |
|---|---|
| `where(name, [comparer], value)`, `equal(object)`, `id(value)`, `userid(value)` | Likhetsgenväg; `==` blir `=`, `!=` blir `<>`; array-ID:n använder `in` |
| `in/notin(name, values, [idField])`, `between(name,a,b)`, `or(fn)` | Filtrerar poster; `or` grupperar posterna som lagts till inuti `fn(builder)` |
| `array(name,[comparer],value)` | Standardjämförare `&&`; tolkningen tillhör drivrutinen |
| `month/day/year/hour/minute(name,[comparer],value)` | Filter på datumdel; standardjämförare `=` |
| `search(name,value,[where])`, `contains(name)`, `empty(name)` | Filtrerar poster; matchningssemantiken tillhör drivrutinen |
| `query(fragment)`, `join(name,table,type,a,b)`, `permit(name,type,values,userid,required)` | Drivrutinsspecifika filter; råa fragment måste komma från betrodd applikationskod |
| `fields(csv)`, `returning(csv)` | Arrayer av trimmade fältnamn, inte SQL-escaping eller auktorisering |
| `sort(name, descending)`, `gridsort(csv,[localized])` | Sorteringssträngar; `true` eller `desc` väljer fallande |
| `take/limit(n)`, `skip(n)`, `page(page,limit)`, `paginate(page,limit,max)` | Förskjutningar/gränser; `paginate` begränsar taket, `page` gör det inte |
| `first()`, `primarykey(name)`, `schema(name)`, `language(value,prefix,skip)`, `debug()` | Metadata för drivrutinen; `first` packar också upp ett arrayresultat |
| `gridfilter(name,query,type,[key])`, `autoquery(query,schema,sort,max)` | Omvandlar gridens frågeparametrar till alternativ. `autoquery` begränsar begärda fält och sorteringsnycklar till sitt deklarerade schema |
| `gridfields(fields,allowed)` | Använd `fields()` med din egen tillåtelselista: det är det testade sättet att välja kolumnerna |
| `callback/pipe(fn)`, `promise()`, `done($,fn,param)` | Slutförande; promises avvisas vid drivrutinsfel |
| `data(fn)`, `fail(fn)`, `error/err(message,reverse)` | Framgångs-/felkrokar; `error()` avvisar tomma resultat, `reverse:true` avvisar sanna resultat (inklusive en tom array) |
| `set(name)`, `nobind()` | Namnger det köade resultatet, eller ersätter inte köns utdata |
| `insert(fn,param)` på en update-builder | Ändrar payloaden före reserv-insert för en upsert |
| `audit($,message,type)` | Anropar den angivna kontextens `variables()` och `audit()` efter ett lyckat drivrutinssvar |

Kontrollermetoder: `callback/pipe`, `promise`, `done`, `debug`, `language`, `load(connection, options)` och `exec(options, callback)`. `load` kopierar en definierad delmängd av serialiserade alternativ; `exec` skickar vidare stödda operationsnamn. `next/free` är interna delar av livscykeln. En kö stannar efter ett drivrutinsfel; den ångrar inte tidigare skrivningar.

```js 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 = [];
```

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