@samet-it/be-db-common 1.1.5 → 1.1.8

package/dist/repo/index.types.d.ts

@@ -1,25 +1,26 @@
-import type { Entity, IdDocLike, Pair, UrnDocLike, UrnTuple } from "@samet-it/be-base-common";
-import type { DbConnectionBase, DbExecOpt } from "../connection";
-import type { DefDims, Portion, View } from "@samet-it/be-base-common";
+import type { DefDims, Entity, IdDocLike, Pair, Portion, UrnDef, UrnDocLike, UrnTuple, View } from "@samet-it/be-base-common";
+import type { DbConnectionLike, UserFetcherLambda } from "../connection";
 import type { QueryAny, QueryRegular } from "@leyyo/query";
-import type { CacheConnectionLike, CacheChannelLike } from "@samet-it/be-cache-common";
-import type { KeyValue, StrKey } from "@leyyo/common";
+import type { CacheChannelLike, CacheConnectionLike, CacheExecOpt } from "@samet-it/be-cache-common";
+import type { KeyValue, OmitError, Opt, StrKey } from "@leyyo/common";
+import type { DbLines } from "../line";
 /**
  * DB repository interface
  *
  * Generics:
- * - 0-`CONN`: db connection {@link DbConnectionBase}
+ * - 0-`CONN`: db connection {@link DbConnectionLike}
  * - 1-`OPT`: db execution options {@link DbExecOpt}
- * - 2-`ENT`: entity {@link Entity}
- * - 3-`ID`: id type {@link KeyValue}
- * - 4-`URN`: urn interface {@link UrnDocLike}
- * - 5-`VIEW`: view interface for presentation layer {@link View}
- * - 6-`PAIR`: pair interface for presentation layer {@link Pair}
- * - 7-`PORTION`: portion interface for presentation layer {@link Portion}
- * - 8-`KEYS`: keys to autocomplete, def: keys of {@link Entity}
- * - 9-`DIMS`: dimensions for presentation layer {@link DefDims}
+ * - 2-`META`: query result metadata {@link DbMeta}
+ * - 3-`ENT`: entity {@link Entity}
+ * - 4-`ID`: id type {@link KeyValue}
+ * - 5-`URN`: urn interface {@link UrnDocLike}
+ * - 6-`VIEW`: view interface for presentation layer {@link View}
+ * - 7-`PAIR`: pair interface for presentation layer {@link Pair}
+ * - 8-`PORTION`: portion interface for presentation layer {@link Portion}
+ * - 9-`KEYS`: keys to autocomplete, def: keys of {@link Entity}
+ * - 10-`DIMS`: dimensions for presentation layer {@link DefDims}
  * */
-export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt, ENT extends Entity<ID>, ID extends KeyValue, URN extends UrnDocLike, VIEW extends View<ID>, PAIR extends Pair<ID>, PORTION extends Portion<ID>, KEYS extends string, DIMS extends DefDims> {
+export interface DbRepoLike<CONN extends DbConnectionLike, OPT extends DbExecOpt, META extends DbMeta, ENT extends Entity<ID>, ID extends KeyValue, URN extends UrnDocLike, VIEW extends View<ID>, PAIR extends Pair<ID>, PORTION extends Portion<ID>, KEYS extends string, DIMS extends DefDims> {
     /**
      * Props on repository
      * */
@@ -28,6 +29,215 @@ export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt
      * Casts current instance to given type
      * */
     $cast<T>(): T;
+    /**
+     * Shortcut to {@link DbConnOpt#isEnabled}
+     * */
+    get isEnabled(): boolean;
+    /**
+     * Shortcut to {@link DbConnOpt#userFetcher}
+     * */
+    get userFetcher(): UserFetcherLambda;
+    /**
+     * Shortcut to {@link DbConnProps#conn}
+     * */
+    get conn(): CONN;
+    /**
+     * Shortcut to {@link DbConnProps#isConnected}
+     * */
+    get isConnected(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#cache}
+     * */
+    get cache(): CacheChannelLike<CacheConnectionLike, CacheExecOpt, ENT, ID>;
+    /**
+     * Shortcut to {@link DbRepoOpt#version}
+     * */
+    get modelVersion(): number;
+    /**
+     * Shortcut to {@link DbRepoOpt#urnDelimiter}
+     * */
+    get urnDelimiter(): UrnDelimiter;
+    /**
+     * Shortcut to {@link DbRepoOpt#urnPrefix}
+     * */
+    get urnPrefix(): string;
+    /**
+     * Shortcut to {@link DbRepoOpt#useNumericId}
+     * */
+    get hasNumericId(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#useIsoDate}
+     * */
+    get hasIsoDate(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#idSame}
+     * */
+    get isIdSame(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#useSoftDelete}
+     * */
+    get hasSoftDelete(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#useCreatedAt}
+     * */
+    get hasCreatedAt(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#useCreatedBy}
+     * */
+    get hasCreatedBy(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#useUpdatedAt}
+     * */
+    get hasUpdatedAt(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#useUpdatedBy}
+     * */
+    get hasUpdatedBy(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#useVersion}
+     * */
+    get hasVersion(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#useRevision}
+     * */
+    get hasRevision(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#noInsert}
+     * */
+    get isNoInsert(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#noUpdate}
+     * */
+    get isNoUpdate(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#noTrash}
+     * */
+    get isNoTrash(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#noRemove}
+     * */
+    get isNoRemove(): boolean;
+    /**
+     * Shortcut to {@link DbRepoOpt#alphaFn}
+     * */
+    get alphaFn(): DbRepoExtensionLambda<ENT, ID>;
+    /**
+     * Shortcut to {@link DbRepoOpt#searchFn}
+     * */
+    get searchFn(): DbRepoExtensionLambda<ENT, ID>;
+    /**
+     * Shortcut to {@link DbRepoOpt#irregularFn}
+     * */
+    get irregularFn(): DbRepoExtensionLambda<ENT, ID>;
+    /**
+     * Shortcut to {@link DbRepoOpt#forbiddenSet}
+     * */
+    get forbiddenSet(): Array<keyof ENT>;
+    /**
+     * Shortcut to {@link DbConnProps#path}
+     * */
+    get path(): string;
+    /**
+     * Shortcut to {@link DbConnProps#table}
+     * */
+    get table(): string;
+    /**
+     * Shortcut to {@link DbConnProps#urnLength}
+     * */
+    get urnLength(): number;
+    /**
+     * Check error
+     *
+     * @param {Error} err - error
+     * @param {DbExecOpt} opt - option
+     * */
+    checkError(err: Error, opt: OPT | Opt): void;
+    /**
+     * Field name
+     *
+     * @param {string} field - raw field name
+     * @return {string} - formatted field name
+     * */
+    field(field: string): string;
+    /**
+     * Field name
+     * @alias #field
+     *
+     * @param {string} field - raw field name
+     * @return {string} - formatted field name
+     * */
+    f(field: string): string;
+    /**
+     * Format value
+     *
+     * @param {string} value - raw value
+     * @return {string} - formatted value
+     * */
+    value(value: unknown): string;
+    /**
+     * Format value
+     * @alias #value
+     *
+     * @param {string} value - raw value
+     * @return {string} - formatted value
+     * */
+    v(value: unknown): string;
+    /**
+     * Check rows and discard trashed
+     *
+     * @param {Array<any>} rows - rows
+     * @return {Array<any>} - checked rows
+     * */
+    rows<T>(rows: Array<T>): Array<T>;
+    /**
+     * Check row and discard trashed
+     *
+     * @param {any} row - row
+     * @return {any} - checked row
+     * */
+    row<T>(row: T): T | undefined;
+    /**
+     * Return first row of rows
+     *
+     * @param {Array<any>} rows - rows
+     * @return {any} - first row if exists
+     * */
+    first<T>(rows: Array<T>): T | undefined;
+    /**
+     * Build option
+     *
+     * @param {(DbExecOpt|string)?} opt - option or query name
+     * @param {string?} name - query name, if first param is option
+     * @return {DbExecOpt} - formatted option
+     * */
+    buildOpt(opt?: Partial<OPT> | string, name?: string): OPT;
+    /**
+     * Execute a lambda
+     *
+     * @param {function} fn - promise callback
+     * @param {(DbExecOpt|string)?} opt - option or query name
+     * @return {Promise} - generic type
+     * @async
+     * */
+    exec<T>(fn: Promise<T>, opt?: string | Omit<OPT, 'printSql'>): Promise<T>;
+    /**
+     * Execute a sql and return rows
+     *
+     * @param {(string|DbLines)} sql - sql or sql lines
+     * @param {(DbExecOpt|string)?} opt - option or query name
+     * @return {Promise<DbQueryResultMore>} - rows
+     * @async
+     * */
+    more<T>(sql: string | DbLines, opt?: string | OPT): Promise<DbQueryResultMore<T, META>>;
+    /**
+     * Execute a sql and return a row
+     *
+     * @param {(string|DbLines)} sql - sql or sql lines
+     * @param {(DbExecOpt|string)?} opt - option or query name
+     * @return {Promise<DbQueryResultOne>} - row
+     * @async
+     * */
+    one<T>(sql: string | DbLines, opt?: string | OPT): Promise<DbQueryResultOne<T, META>>;
     /**
      * Build urn with prefix from urn object
      *
@@ -45,12 +255,12 @@ export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt
     /**
      * Get document by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @return {Promise<Entity?>} - document
      * @async
      * */
-    get(key: KeyValue, opt?: OPT | string): Promise<ENT | undefined>;
+    get(key: PORTION | KeyValue, opt?: OPT | string): Promise<ENT | undefined>;
     /**
      * Get document by primary key
      *
@@ -94,12 +304,12 @@ export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt
     /**
      * Document exists by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @return {Promise<boolean>} - exists or not
      * @async
      * */
-    exists(key: KeyValue, opt?: OPT | string): Promise<boolean>;
+    exists(key: PORTION | KeyValue, opt?: OPT | string): Promise<boolean>;
     /**
      * Document exists by primary key
      *
@@ -143,13 +353,13 @@ export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt
     /**
      * List documents by keys (primary or secondary)
      *
-     * @param {Array<KeyValue>} keys - primary or secondary keys
+     * @param {Array<Portion|KeyValue>} keys - primary or secondary keys
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<Array<Entity>>} - documents
      * @async
      * */
-    list(keys: Array<KeyValue>, opt?: OPT | string, ignoreCheck?: boolean): Promise<Array<ENT>>;
+    list(keys: Array<PORTION | KeyValue>, opt?: OPT | string, ignoreCheck?: boolean): Promise<Array<ENT>>;
     /**
      * List documents by primary keys
      *
@@ -254,14 +464,14 @@ export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt
     /**
      * Update document by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {Entity} doc - document
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<string>}
      * @async
      * */
-    update(key: KeyValue, doc: Partial<ENT>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    update(key: PORTION | KeyValue, doc: Partial<ENT>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /**
      * Update document by primary key
      *
@@ -309,33 +519,33 @@ export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt
     /**
      * Set document with partial data by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {Partial<Entity>} doc - partial entity will be set
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<string>}
      * @async
      * */
-    set(key: KeyValue, doc: Partial<ENT>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    set(key: PORTION | KeyValue, doc: Partial<ENT>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /**
      * Unset document for given fields
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {Array<string>} fields - fields will be unset
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<string>}
      * @async
      * */
-    unset(key: KeyValue, fields: Array<keyof ENT | KEYS | string>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    unset(key: PORTION | KeyValue, fields: Array<keyof ENT | KEYS | string>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /**
      * Remove document (hard delete) by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @async
      * */
-    remove(key: KeyValue, opt?: OPT | string): Promise<string>;
+    remove(key: PORTION | KeyValue, opt?: OPT | string): Promise<string>;
     /**
      * Remove document by primary key (hard delete)
      *
@@ -375,11 +585,11 @@ export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt
     /**
      * Trash document (soft delete) by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @async
      * */
-    trash(key: KeyValue, opt?: OPT | string): Promise<string>;
+    trash(key: PORTION | KeyValue, opt?: OPT | string): Promise<string>;
     /**
      * Trash document by primary key (soft delete)
      *
@@ -434,64 +644,48 @@ export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt
      * Generics
      * - 0-`R`: dim interface {@link IdDocLike}
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {string?} dim - dimension, default: `def`
      * @return {Promise<IdDocLike>} - dim object
      * @async
      * */
-    getDim<R extends IdDocLike<ID>>(key: KeyValue, dim?: DIMS): Promise<R>;
+    getDim<R extends IdDocLike<ID>>(key: PORTION | KeyValue, dim?: DIMS): Promise<R>;
     /**
      * List dims by keys (primary or secondary)
      *
      * Generics
      * - 0-`R`: dim interface {@link IdDocLike}
      *
-     * @param {Array<string>} keys - primary or secondary keys
+     * @param {Array<Portion|KeyValue>} keys - primary or secondary keys
      * @param {string?} dim - dimension, default: `def`
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<Array<IdDocLike>>} - dim objects
      * */
-    listDims<R extends IdDocLike<ID>>(keys: Array<KeyValue>, dim?: DIMS, ignoreCheck?: boolean): Promise<Array<R>>;
-    /**
-     * Set pair by document
-     *
-     * @param {Entity} doc - document
-     * @return {Promise<Pair>} - pair object
-     * @async
-     * */
-    $toPair(doc: ENT): Promise<PAIR>;
+    listDims<R extends IdDocLike<ID>>(keys: Array<PORTION | KeyValue>, dim?: DIMS, ignoreCheck?: boolean): Promise<Array<R>>;
     /**
      * Get pair by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @return {Promise<Pair>} - pair object
      * @async
      * */
-    getPair(key: KeyValue): Promise<PAIR>;
+    getPair(key: PORTION | KeyValue): Promise<PAIR>;
     /**
      * List pairs by keys (primary or secondary)
      *
-     * @param {Array<KeyValue>} keys - primary or secondary keys
+     * @param {Array<Portion|KeyValue>} keys - primary or secondary keys
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<Array<Pair>>} - pair objects
      * */
-    listPairs(keys: Array<KeyValue>, ignoreCheck?: boolean): Promise<Array<PAIR>>;
-    /**
-     * Set view by document
-     *
-     * @param {Entity} doc - document
-     * @return {Promise<View>} - view object
-     * @async
-     * */
-    $toView(doc: ENT): Promise<VIEW>;
+    listPairs(keys: Array<PORTION | KeyValue>, ignoreCheck?: boolean): Promise<Array<PAIR>>;
     /**
      * Get view by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @return {Promise<View>} - view object
      * @async
      * */
-    getView(key: KeyValue): Promise<VIEW>;
+    getView(key: PORTION | KeyValue): Promise<VIEW>;
     /**
      * List views by keys (primary or secondary)
      *
@@ -500,30 +694,22 @@ export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt
      * @return {Promise<Array<View>>} - view objects
      * */
     listViews(keys: Array<KeyValue>, ignoreCheck?: boolean): Promise<Array<VIEW>>;
-    /**
-     * Set portion by document
-     *
-     * @param {Entity} doc - document
-     * @return {Promise<Portion>} - portion object
-     * @async
-     * */
-    $toPortion(doc: ENT): Promise<PORTION>;
     /**
      * Get portion by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @return {Promise<Portion>} - portion object
      * @async
      * */
-    getPortion(key: KeyValue): Promise<PORTION>;
+    getPortion(key: PORTION | KeyValue): Promise<PORTION>;
     /**
      * List portions by key (primary or secondary)
      *
-     * @param {Array<KeyValue>} keys - primary or secondary keys
+     * @param {Array<Portion|KeyValue>} keys - primary or secondary keys
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<Array<Portion>>} - portion objects
      * */
-    listPortions(keys: Array<KeyValue>, ignoreCheck?: boolean): Promise<Array<PORTION>>;
+    listPortions(keys: Array<PORTION | KeyValue>, ignoreCheck?: boolean): Promise<Array<PORTION>>;
 }
 /**
  * DB repository option
@@ -538,7 +724,7 @@ export interface DbRepoOpt<ENT extends Entity<ID>, ID extends KeyValue> {
      *
      * @type {CacheChannelLike}
      * */
-    cache?: CacheChannelLike<CacheConnectionLike, ENT, ID>;
+    cache?: CacheChannelLike<CacheConnectionLike, CacheExecOpt, ENT, ID>;
     /**
      * Model version
      *
@@ -583,7 +769,7 @@ export interface DbRepoOpt<ENT extends Entity<ID>, ID extends KeyValue> {
      * - if yes, id is same with urn
      * - if no, id is not same with urn
      *
-     * @fields `_urn`, `id`
+     * @fields `urn`, `id`
      * @default false
      * */
     idSame?: boolean;
@@ -733,26 +919,21 @@ export interface DbRepoOpt<ENT extends Entity<ID>, ID extends KeyValue> {
      * @type {Array<string>}
      * */
     forbiddenSet?: Array<keyof ENT>;
-    /**
-     * Field list which can not be unset (clear,delete)
-     *
-     * @type {Array<string>}
-     * */
-    forbiddenUnset?: Array<keyof ENT>;
 }
 /**
  * DB repository props
  *
  * Generics:
- * - 0-`CONN`: db connection {@link DbConnectionBase}
- * - 1-`ENT`: entity {@link Entity}
- * - 2-`ID`: id type {@link KeyValue}
+ * - 0-`CONN`: db connection {@link DbConnectionLike}
+ * - 1-`OPT`: db execution options {@link DbExecOpt}
+ * - 2-`ENT`: entity {@link Entity}
+ * - 3-`ID`: id type {@link KeyValue}
  * */
-export interface DbRepoProps<CONN extends DbConnectionBase, ENT extends Entity<ID>, ID extends KeyValue> extends DbRepoOpt<ENT, ID> {
+export interface DbRepoProps<CONN extends DbConnectionLike, ENT extends Entity<ID>, ID extends KeyValue> extends DbRepoOpt<ENT, ID> {
     /**
      * DB connection
      *
-     * @type {DbConnectionBase}
+     * @type {DbConnectionLike}
      * */
     conn: CONN;
     /**
@@ -762,17 +943,17 @@ export interface DbRepoProps<CONN extends DbConnectionBase, ENT extends Entity<I
      * */
     path: string;
     /**
-     * Length of urn prefix
+     * Table path, generally it will be "{db}"."{schema}"."{table}"
      *
-     * @type {number}
+     * @type {string}
      * */
-    urnLength?: number;
+    table: string;
     /**
-     * Is connected
+     * Length of urn prefix
      *
-     * @type {boolean}
+     * @type {number}
      * */
-    isConnected?: boolean;
+    urnLength?: number;
 }
 /**
  * DB keys result
@@ -790,16 +971,16 @@ export interface DbCheckKeysResult<ID extends KeyValue> {
  *
  * Tuple
  * - 0: urn or id value
- * - 1: field name as _urn or id
+ * - 1: field name as urn or id
  *
  * Generics:
  * - 0-`ID`: id type {@link KeyValue}
  *
  * Options
- * - if primary(urn) => `[value (string), '_urn'];
+ * - if primary(urn) => `[value (string), 'urn'];
  * - if secondary(id) => `[value (string|number), 'id'];
  * */
-export type DbCheckKeysTuple<ID extends KeyValue> = [string, '_urn'] | [ID, 'id'];
+export type DbCheckKeysTuple<ID extends KeyValue> = [string, 'urn'] | [ID, 'id'];
 /**
  * DB `$toUrnTuple` lambda
  *
@@ -831,25 +1012,22 @@ export type DbRepoToUrnTuple<URN extends UrnDocLike = UrnDocLike> = (urnRec: URN
 export type DbRepoToDim<R, ENT extends Entity<ID>, ID extends KeyValue, DIMS extends DefDims = DefDims> = (doc: ENT, dim: DIMS | undefined) => Promise<R>;
 /**
  * Default model which contains keys
+ *
+ * Generics:
+ * - 0-`ID`: id type {@link KeyValue}
  * */
-export interface DbIdLike {
+export interface DbIdLike<ID extends KeyValue = KeyValue> {
     /**
      * Secondary key for an entity
      *
      * @type {KeyValue}
      */
-    id?: KeyValue;
+    id?: ID;
     /**
      * Primary key for an entity
      *
      * @type {string}
      */
-    _urn?: string;
-    /**
-     * Alternative usage for {@link #_urn}
-     *
-     * @type {string}
-     */
     urn?: string;
 }
 /**
@@ -867,3 +1045,115 @@ export type DbRepoExtensionLambda<ENT extends Entity<ID>, ID extends KeyValue> =
  * Urn delimiter literals (options)
  * */
 export type UrnDelimiter = ',' | '|' | ';' | '/';
+/**
+ * DB meta
+ * */
+export interface DbMeta {
+}
+/**
+ * DB query option
+ * */
+export interface DbExecOpt extends Opt {
+    /**
+     * Name of SQL
+     * */
+    name?: string;
+    /**
+     * do not use cache
+     * */
+    noCache?: boolean;
+    /**
+     * Ignore context cache
+     * */
+    ignoreContext?: string;
+    /**
+     * Ignored errors
+     * */
+    ignoredErrors?: Array<OmitError | string>;
+    /**
+     * Print sql?
+     * */
+    printSql?: boolean;
+    /**
+     * Ignore any error
+     * */
+    silent?: boolean;
+    /**
+     * Trash id for only trash case
+     * */
+    trashId?: string;
+}
+/**
+ * DB query result as a row
+ *
+ * Generics:
+ * - 0-`E`: result model, it will be row type
+ * - 1-`META`: query result metadata {@link DbMeta}
+ * */
+export interface DbQueryResultOne<E = any, META extends DbMeta = DbMeta> extends DbQueryResult<META> {
+    /**
+     * The rows which have been returned by the query.
+     */
+    row: E | undefined;
+}
+/**
+ * DB query result as rows
+ *
+ * Generics:
+ * - 0-`E`: result model, it will be rows item type, `rows: E[]`
+ * - 1-`META`: query result metadata {@link DbMeta}
+ * */
+export interface DbQueryResultMore<E = any, META extends DbMeta = DbMeta> extends DbQueryResult<META> {
+    /**
+     * The rows which have been returned by the query.
+     */
+    rows: E[];
+}
+/**
+ * DB query result
+ *
+ * Generics:
+ * - 0-`META`: query result metadata {@link DbMeta}
+ * */
+export interface DbQueryResult<META> {
+    /**
+     * Success or failure
+     */
+    success: boolean;
+    /**
+     * [when success=true] The meta-data which has been returned by the query.
+     */
+    meta?: META;
+    /**
+     * [when success=false] Couchbase error
+     */
+    error?: OmitError;
+}
+/**
+ * Couchbase direct repository (collection) option
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
+ * - 2-`URN`: urn interface {@link UrnDocLike}
+ * - 3-`DIMS`: dimensions for presentation layer {@link DefDims}
+ * - 4-`R`: ??
+ * */
+export interface DbRepoDirectOpt<ENT extends Entity<ID>, ID extends KeyValue = KeyValue, URN extends UrnDocLike = UrnDef<ID>, DIMS extends DefDims = DefDims, R = unknown> extends DbRepoOpt<ENT, ID> {
+    /**
+     * Name of logger class
+     * */
+    name?: string;
+    /**
+     * Overridable method to easy use
+     * */
+    $toUrnTuple?: DbRepoToUrnTuple<URN>;
+    /**
+     * Overridable method to easy use
+     * */
+    $toDim?: DbRepoToDim<R, ENT, ID, DIMS>;
+    /**
+     * Indexed fields
+     * */
+    $indexedFields?: Array<keyof ENT | string>;
+}