gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2026-01-15 11:04:30 +01:00
Code Issues Actions 14 Packages Projects Releases Wiki Activity

chore(core): add documentation for SQL

Browse Source
This commit is contained in:
Elian Doran 2026-01-05 16:07:17 +02:00
parent f79af7b045
commit 6f04738629
No known key found for this signature in database
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
packages/trilium-core/src/services/sql/sql.ts
View File

@ -96,6 +96,13 @@ export class SqlService {
return this.statementCache[key];
}
/**
* Get first returned row.
*
* @param query - SQL query with ? used as parameter placeholder
* @param params - array of params if needed
* @returns - map of column name to column value
*/
getRow<T>(query: string, params: Params = []): T {
return this.wrap(query, (s) => s.get(params)) as T;
}
@ -109,6 +116,13 @@ export class SqlService {
return (all.length > 0 ? all[0] : null) as T | null;
}
/**
* Get single value from the given query - first column from first returned row.
*
* @param query - SQL query with ? used as parameter placeholder
* @param params - array of params if needed
* @returns single value
*/
getValue<T>(query: string, params: Params = []): T {
return this.wrap(query, (s) => s.pluck().get(params)) as T;
}
@ -140,6 +154,13 @@ export class SqlService {
return (results as T[] | null) || [];
}
/**
* Get all returned rows.
*
* @param query - SQL query with ? used as parameter placeholder
* @param params - array of params if needed
* @returns - array of all rows, each row is a map of column name to column value
*/
getRows<T>(query: string, params: Params = []): T[] {
return this.wrap(query, (s) => s.all(params)) as T[];
}
@ -156,6 +177,13 @@ export class SqlService {
return this.stmt(query).iterate(params) as IterableIterator<T>;
}
/**
* Get a map of first column mapping to second column.
*
* @param query - SQL query with ? used as parameter placeholder
* @param params - array of params if needed
* @returns - map of first column to second column
*/
getMap<K extends string | number | symbol, V>(query: string, params: Params = []) {
const map: Record<K, V> = {} as Record<K, V>;
const results = this.getRawRows<[K, V]>(query, params);
@ -167,10 +195,23 @@ export class SqlService {
return map;
}
/**
* Get a first column in an array.
*
* @param query - SQL query with ? used as parameter placeholder
* @param params - array of params if needed
* @returns array of first column of all returned rows
*/
getColumn<T>(query: string, params: Params = []): T[] {
return this.wrap(query, (s) => s.pluck().all(params)) as T[];
}
/**
* Execute SQL
*
* @param query - SQL query with ? used as parameter placeholder
* @param params - array of params if needed
*/
execute(query: string, params: Params = []): RunResult {
if (this.params.isReadOnly && (query.startsWith("UPDATE") || query.startsWith("INSERT") || query.startsWith("DELETE"))) {
this.log.error(`read-only DB ignored: ${query} with parameters ${JSON.stringify(params)}`);