@maiyunnet/kebab 7.6.1 → 7.6.3

package/doc/sc/api/lib/db/conn/classes/Connection.md

@@ -1,315 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/db/conn](../index.md) / Connection
-
-# Class: Connection
-
-Defined in: [lib/db/conn.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L34)
-
-数据库连接对象
-
-## Constructors
-
-### Constructor
-
-> **new Connection**(`etc`, `link`): `Connection`
-
-Defined in: [lib/db/conn.ts:59](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L59)
-
-#### Parameters
-
-##### etc
-
-[`IConfigDb`](../../../../index/interfaces/IConfigDb.md)
-
-##### link
-
-`Connection` | `Client`
-
-#### Returns
-
-`Connection`
-
-## Methods
-
-### beginTransaction()
-
-> **beginTransaction**(): `Promise`\<`boolean`\>
-
-Defined in: [lib/db/conn.ts:317](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L317)
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-***
-
-### commit()
-
-> **commit**(): `Promise`\<`boolean`\>
-
-Defined in: [lib/db/conn.ts:338](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L338)
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-***
-
-### end()
-
-> **end**(): `Promise`\<`boolean`\>
-
-Defined in: [lib/db/conn.ts:306](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L306)
-
-关闭连接，一般情况下不使用
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-***
-
-### execute()
-
-> **execute**(`sql`, `values?`): `Promise`\<[`IPacket`](../../interfaces/IPacket.md)\>
-
-Defined in: [lib/db/conn.ts:233](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L233)
-
-执行一条 SQL 并获得影响行数对象 packet
-
-#### Parameters
-
-##### sql
-
-`string`
-
-执行的 SQL 字符串
-
-##### values?
-
-[`DbValue`](../../../../index/type-aliases/DbValue.md)[]
-
-要替换的 data 数据
-
-#### Returns
-
-`Promise`\<[`IPacket`](../../interfaces/IPacket.md)\>
-
-***
-
-### getEtc()
-
-> **getEtc**(): [`IConfigDb`](../../../../index/interfaces/IConfigDb.md)
-
-Defined in: [lib/db/conn.ts:68](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L68)
-
-获取连接 etc 信息
-
-#### Returns
-
-[`IConfigDb`](../../../../index/interfaces/IConfigDb.md)
-
-***
-
-### getLast()
-
-> **getLast**(): `number`
-
-Defined in: [lib/db/conn.ts:80](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L80)
-
-获取最后一次获取连接的时间
-
-#### Returns
-
-`number`
-
-***
-
-### getLastSql()
-
-> **getLastSql**(): `object`[]
-
-Defined in: [lib/db/conn.ts:87](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L87)
-
-获取最后两次执行的 sql 字符串
-
-#### Returns
-
-`object`[]
-
-***
-
-### getService()
-
-> **getService**(): [`ESERVICE`](../../enumerations/ESERVICE.md)
-
-Defined in: [lib/db/conn.ts:73](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L73)
-
-获取数据库服务类型
-
-#### Returns
-
-[`ESERVICE`](../../enumerations/ESERVICE.md)
-
-***
-
-### isAvailable()
-
-> **isAvailable**(`last`): `Promise`\<`boolean`\>
-
-Defined in: [lib/db/conn.ts:154](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L154)
-
-通过执行一条语句判断当前连接是否可用
-
-#### Parameters
-
-##### last
-
-`boolean` = `true`
-
-是否刷新最后使用时间（默认刷新）
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-***
-
-### isLost()
-
-> **isLost**(): `boolean`
-
-Defined in: [lib/db/conn.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L104)
-
-是否已经丢失
-
-#### Returns
-
-`boolean`
-
-***
-
-### isTransaction()
-
-> **isTransaction**(): `boolean`
-
-Defined in: [lib/db/conn.ts:111](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L111)
-
-是否是开启事务状态
-
-#### Returns
-
-`boolean`
-
-***
-
-### isUsing()
-
-> **isUsing**(): `boolean`
-
-Defined in: [lib/db/conn.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L118)
-
-获取当前状态是否正在被使用中
-
-#### Returns
-
-`boolean`
-
-***
-
-### query()
-
-> **query**(`sql`, `values?`): `Promise`\<[`IData`](../../interfaces/IData.md)\>
-
-Defined in: [lib/db/conn.ts:177](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L177)
-
-执行一条 SQL 并获得返回数据
-
-#### Parameters
-
-##### sql
-
-`string`
-
-执行的 SQL 字符串
-
-##### values?
-
-[`DbValue`](../../../../index/type-aliases/DbValue.md)[]
-
-要替换的 data 数据
-
-#### Returns
-
-`Promise`\<[`IData`](../../interfaces/IData.md)\>
-
-***
-
-### refreshLast()
-
-> **refreshLast**(): `void`
-
-Defined in: [lib/db/conn.ts:146](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L146)
-
-设定最后使用时间
-
-#### Returns
-
-`void`
-
-***
-
-### rollback()
-
-> **rollback**(): `Promise`\<`boolean`\>
-
-Defined in: [lib/db/conn.ts:356](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L356)
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-***
-
-### setLost()
-
-> **setLost**(): `void`
-
-Defined in: [lib/db/conn.ts:97](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L97)
-
-将本条连接设置为不可用
-
-#### Returns
-
-`void`
-
-***
-
-### used()
-
-> **used**(): `void`
-
-Defined in: [lib/db/conn.ts:139](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L139)
-
-取消占用
-
-#### Returns
-
-`void`
-
-***
-
-### using()
-
-> **using**(): `boolean`
-
-Defined in: [lib/db/conn.ts:125](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L125)
-
-判断是否可用（丢失的也算不可用），返回 true 代表获取成功并自动刷新最后时间
-
-#### Returns
-
-`boolean`

package/doc/sc/api/lib/db/conn/index.md

@@ -1,11 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / lib/db/conn
-
-# lib/db/conn
-
-## Classes
-
-- [Connection](classes/Connection.md)

package/doc/sc/api/lib/db/enumerations/ESERVICE.md

@@ -1,27 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/db](../index.md) / ESERVICE
-
-# Enumeration: ESERVICE
-
-Defined in: [lib/db.ts:17](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L17)
-
-服务商定义
-
-## Enumeration Members
-
-### MYSQL
-
-> **MYSQL**: `0`
-
-Defined in: [lib/db.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L18)
-
-***
-
-### PGSQL
-
-> **PGSQL**: `1`
-
-Defined in: [lib/db.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L19)

package/doc/sc/api/lib/db/functions/get.md

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/db](../index.md) / get
-
-# Function: get()
-
-> **get**(`ctrEtc`, `opt`): [`Pool`](../pool/classes/Pool.md)
-
-Defined in: [lib/db.ts:68](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L68)
-
-获取 Db Pool 对象
-
-## Parameters
-
-### ctrEtc
-
-控制器对象或数据库配置信息
-
-[`IConfigDb`](../../../index/interfaces/IConfigDb.md) | [`Ctr`](../../../sys/ctr/classes/Ctr.md)
-
-### opt
-
-选项
-
-#### service?
-
-[`ESERVICE`](../enumerations/ESERVICE.md)
-
-服务商，默认 PGSQL
-
-## Returns
-
-[`Pool`](../pool/classes/Pool.md)
-
-Db Pool 对象

package/doc/sc/api/lib/db/index.md

@@ -1,50 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../index.md) / lib/db
-
-# lib/db
-
-## Enumerations
-
-- [ESERVICE](enumerations/ESERVICE.md)
-
-## Interfaces
-
-- [IData](interfaces/IData.md)
-- [IPacket](interfaces/IPacket.md)
-
-## Functions
-
-- [get](functions/get.md)
-
-## References
-
-### Connection
-
-Re-exports [Connection](conn/classes/Connection.md)
-
-***
-
-### getConnectionList
-
-Re-exports [getConnectionList](pool/functions/getConnectionList.md)
-
-***
-
-### IConnectionInfo
-
-Re-exports [IConnectionInfo](pool/interfaces/IConnectionInfo.md)
-
-***
-
-### Pool
-
-Re-exports [Pool](pool/classes/Pool.md)
-
-***
-
-### Transaction
-
-Re-exports [Transaction](tran/classes/Transaction.md)

package/doc/sc/api/lib/db/interfaces/IData.md

@@ -1,57 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/db](../index.md) / IData
-
-# Interface: IData
-
-Defined in: [lib/db.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L23)
-
-query 返回的数据
-
-## Properties
-
-### error
-
-> **error**: \{ `errno`: `number`; `message`: `string`; \} \| `null`
-
-Defined in: [lib/db.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L31)
-
-***
-
-### fields
-
-> **fields**: `object`[]
-
-Defined in: [lib/db.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L25)
-
-#### length
-
-> **length**: `number`
-
-字段格式长度
-
-#### name
-
-> **name**: `string`
-
-字段名
-
-***
-
-### result
-
-> **result**: `number`
-
-Defined in: [lib/db.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L36)
-
-1-正常,-500-服务器错误
-
-***
-
-### rows
-
-> **rows**: `Record`\<`string`, `any`\>[] \| `null`
-
-Defined in: [lib/db.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L24)

package/doc/sc/api/lib/db/interfaces/IPacket.md

@@ -1,75 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/db](../index.md) / IPacket
-
-# Interface: IPacket
-
-Defined in: [lib/db.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L40)
-
-exec 返回对象
-
-## Properties
-
-### error
-
-> **error**: \{\[`key`: `string`\]: `any`; `errno`: `number`; `message`: `string`; \} \| `null`
-
-Defined in: [lib/db.ts:53](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L53)
-
-***
-
-### fields
-
-> **fields**: `object`[]
-
-Defined in: [lib/db.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L47)
-
-#### length
-
-> **length**: `number`
-
-字段格式长度
-
-#### name
-
-> **name**: `string`
-
-字段名
-
-***
-
-### packet
-
-> **packet**: \{ `affected`: `number`; `insert`: `number`; \} \| `null`
-
-Defined in: [lib/db.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L41)
-
-#### Type Declaration
-
-\{ `affected`: `number`; `insert`: `number`; \}
-
-#### affected
-
-> **affected**: `number`
-
-受影响的行数
-
-#### insert
-
-> **insert**: `number`
-
-插入的 id
-
-`null`
-
-***
-
-### result
-
-> **result**: `number`
-
-Defined in: [lib/db.ts:59](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L59)
-
-1-正常,-500-服务器错误

package/doc/sc/api/lib/db/pool/classes/Pool.md

@@ -1,143 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/db/pool](../index.md) / Pool
-
-# Class: Pool
-
-Defined in: [lib/db/pool.ts:115](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L115)
-
-数据库连接池对象
-
-## Constructors
-
-### Constructor
-
-> **new Pool**(`etc`, `opt`): `Pool`
-
-Defined in: [lib/db/pool.ts:126](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L126)
-
-#### Parameters
-
-##### etc
-
-[`IConfigDb`](../../../../index/interfaces/IConfigDb.md)
-
-##### opt
-
-###### service
-
-[`ESERVICE`](../../enumerations/ESERVICE.md)
-
-服务商
-
-#### Returns
-
-`Pool`
-
-## Methods
-
-### beginTransaction()
-
-> **beginTransaction**(`ctr`): `Promise`\<[`Transaction`](../../tran/classes/Transaction.md) \| `null`\>
-
-Defined in: [lib/db/pool.ts:189](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L189)
-
-开启事务，返回事务对象并锁定连接，别人任何人不可用，有 ctr 的话必传 this，独立执行时可传 null
-
-#### Parameters
-
-##### ctr
-
-[`Ctr`](../../../../sys/ctr/classes/Ctr.md) | `null`
-
-#### Returns
-
-`Promise`\<[`Transaction`](../../tran/classes/Transaction.md) \| `null`\>
-
-***
-
-### execute()
-
-> **execute**(`sql`, `values?`): `Promise`\<[`IPacket`](../../interfaces/IPacket.md)\>
-
-Defined in: [lib/db/pool.ts:169](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L169)
-
-执行一条 SQL 并获得影响行数对象 packet，连接失败抛出错误
-
-#### Parameters
-
-##### sql
-
-`string`
-
-执行的 SQL 字符串
-
-##### values?
-
-[`DbValue`](../../../../index/type-aliases/DbValue.md)[]
-
-要替换的 data 数据
-
-#### Returns
-
-`Promise`\<[`IPacket`](../../interfaces/IPacket.md)\>
-
-***
-
-### getQueries()
-
-> **getQueries**(): `number`
-
-Defined in: [lib/db/pool.ts:321](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L321)
-
-获取 SQL 执行次数
-
-#### Returns
-
-`number`
-
-***
-
-### getService()
-
-> **getService**(): [`ESERVICE`](../../enumerations/ESERVICE.md)
-
-Defined in: [lib/db/pool.ts:135](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L135)
-
-获取当前连接的服务商
-
-#### Returns
-
-[`ESERVICE`](../../enumerations/ESERVICE.md)
-
-***
-
-### query()
-
-> **query**(`sql`, `values?`): `Promise`\<[`IData`](../../interfaces/IData.md)\>
-
-Defined in: [lib/db/pool.ts:145](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L145)
-
-执行一条 SQL，无视顺序和相同连接，随用随取
-
-#### Parameters
-
-##### sql
-
-`string`
-
-执行的 SQL 字符串
-
-##### values?
-
-[`DbValue`](../../../../index/type-aliases/DbValue.md)[]
-
-要替换的 data 数据
-
-#### Returns
-
-`Promise`\<[`IData`](../../interfaces/IData.md)\>
-
-error.errno = -500 表示系统错误