@maiyunnet/kebab 7.6.0 → 7.6.1

package/doc/sc/api/lib/sql/enumerations/EJSON.md

@@ -0,0 +1,61 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/sql](../index.md) / EJSON
+
+# Enumeration: EJSON
+
+Defined in: [lib/sql.ts:21](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L21)
+
+JSON 查询操作符
+
+## Enumeration Members
+
+### CONTAINED\_BY
+
+> **CONTAINED\_BY**: `"json_in"`
+
+Defined in: [lib/sql.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L25)
+
+被包含 (MySQL: JSON_CONTAINS, PG: <@)
+
+***
+
+### CONTAINS
+
+> **CONTAINS**: `"json"`
+
+Defined in: [lib/sql.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L23)
+
+包含 (MySQL: JSON_CONTAINS, PG: @>)
+
+***
+
+### HAS\_ALL\_KEYS
+
+> **HAS\_ALL\_KEYS**: `"json_all"`
+
+Defined in: [lib/sql.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L31)
+
+存在所有 Key (MySQL: JSON_CONTAINS_PATH all, PG: ?&)
+
+***
+
+### HAS\_ANY\_KEYS
+
+> **HAS\_ANY\_KEYS**: `"json_any"`
+
+Defined in: [lib/sql.ts:29](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L29)
+
+存在任意 Key (MySQL: JSON_CONTAINS_PATH one, PG: ?|)
+
+***
+
+### HAS\_KEY
+
+> **HAS\_KEY**: `"json_key"`
+
+Defined in: [lib/sql.ts:27](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L27)
+
+存在 Key (MySQL: JSON_CONTAINS_PATH one, PG: ?)

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

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

package/doc/sc/api/lib/sql/functions/aoMix.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/sql](../index.md) / aoMix
+
+# Function: aoMix()
+
+> **aoMix**(`arr`): `Record`\<`string`, `string` \| `number` \| [`Json`](../../../index/type-aliases/Json.md)\>
+
+Defined in: [lib/sql.ts:1180](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1180)
+
+将数组兑换为组合的对象（Array/Object mix）
+
+## Parameters
+
+### arr
+
+`any`
+
+要转换的数组
+
+## Returns
+
+`Record`\<`string`, `string` \| `number` \| [`Json`](../../../index/type-aliases/Json.md)\>

package/doc/sc/api/lib/sql/functions/column.md

@@ -0,0 +1,35 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/sql](../index.md) / column
+
+# Function: column()
+
+> **column**(`field`): `object`
+
+Defined in: [lib/sql.ts:1201](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1201)
+
+创建字段对象
+
+## Parameters
+
+### field
+
+`string`
+
+## Returns
+
+`object`
+
+### token
+
+> **token**: `string`
+
+### type
+
+> **type**: `"column"`
+
+### value
+
+> **value**: `string`

package/doc/sc/api/lib/sql/functions/format.md

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/sql](../index.md) / format
+
+# Function: format()
+
+> **format**(`sql`, `data`, `service`): `string`
+
+Defined in: [lib/sql.ts:1142](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1142)
+
+返回代入后的完整 SQL 字符串，这并不安全不能直接执行，只是用来调试打印 sql 语句
+
+## Parameters
+
+### sql
+
+`string`
+
+SQL 字符串
+
+### data
+
+[`DbValue`](../../../index/type-aliases/DbValue.md)[]
+
+DATA 数据
+
+### service
+
+[`ESERVICE`](../enumerations/ESERVICE.md) = `ESERVICE.MYSQL`
+
+服务商，默认 MySQL
+
+## Returns
+
+`string`

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

@@ -0,0 +1,43 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/sql](../index.md) / get
+
+# Function: get()
+
+> **get**(`opt`): [`Sql`](../classes/Sql.md)
+
+Defined in: [lib/sql.ts:1115](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1115)
+
+创建 sql 对象
+
+## Parameters
+
+### opt
+
+参数
+
+#### ctr?
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+#### data?
+
+[`DbValue`](../../../index/type-aliases/DbValue.md)[]
+
+#### pre?
+
+`string`
+
+#### service
+
+[`ESERVICE`](../enumerations/ESERVICE.md)
+
+#### sql?
+
+`string`[]
+
+## Returns
+
+[`Sql`](../classes/Sql.md)

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

@@ -0,0 +1,23 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/sql
+
+# lib/sql
+
+## Enumerations
+
+- [EJSON](enumerations/EJSON.md)
+- [ESERVICE](enumerations/ESERVICE.md)
+
+## Classes
+
+- [Sql](classes/Sql.md)
+
+## Functions
+
+- [aoMix](functions/aoMix.md)
+- [column](functions/column.md)
+- [format](functions/format.md)
+- [get](functions/get.md)

package/doc/sc/api/lib/ssh/classes/Connection.md

@@ -0,0 +1,123 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ssh](../index.md) / Connection
+
+# Class: Connection
+
+Defined in: [lib/ssh.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L23)
+
+主连接对象
+
+## Constructors
+
+### Constructor
+
+> **new Connection**(): `Connection`
+
+Defined in: [lib/ssh.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L31)
+
+#### Returns
+
+`Connection`
+
+## Methods
+
+### connect()
+
+> **connect**(`opt`): `Promise`\<`boolean`\>
+
+Defined in: [lib/ssh.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L39)
+
+发起连接
+
+#### Parameters
+
+##### opt
+
+`ConnectConfig` & [`IExtOptions`](../interfaces/IExtOptions.md)
+
+选项
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### disconnect()
+
+> **disconnect**(): `void`
+
+Defined in: [lib/ssh.ts:98](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L98)
+
+断开此连接 socket
+
+#### Returns
+
+`void`
+
+***
+
+### exec()
+
+> **exec**(`command`): `Promise`\<`false` \| `Buffer`\<`ArrayBufferLike`\>\>
+
+Defined in: [lib/ssh.ts:106](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L106)
+
+执行一个命令并获取返回值，请不要在此执行无尽命令，否则获取不到返回值
+
+#### Parameters
+
+##### command
+
+`string`
+
+命令内容
+
+#### Returns
+
+`Promise`\<`false` \| `Buffer`\<`ArrayBufferLike`\>\>
+
+***
+
+### getSftp()
+
+> **getSftp**(): `Promise`\<[`Connection`](../sftp/classes/Connection.md) \| `null`\>
+
+Defined in: [lib/ssh.ts:143](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L143)
+
+获取 Sftp 执行对象
+
+#### Returns
+
+`Promise`\<[`Connection`](../sftp/classes/Connection.md) \| `null`\>
+
+***
+
+### getShell()
+
+> **getShell**(): `Promise`\<[`Connection`](../shell/classes/Connection.md) \| `null`\>
+
+Defined in: [lib/ssh.ts:128](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L128)
+
+获取 Shell 执行对象
+
+#### Returns
+
+`Promise`\<[`Connection`](../shell/classes/Connection.md) \| `null`\>
+
+***
+
+### getStream()
+
+> **getStream**(): `Promise`\<`ClientChannel` \| `null`\>
+
+Defined in: [lib/ssh.ts:170](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L170)
+
+直接获取原生 shell stream 对象
+
+#### Returns
+
+`Promise`\<`ClientChannel` \| `null`\>

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

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ssh](../index.md) / get
+
+# Function: get()
+
+> **get**(`opt`): `Promise`\<[`Connection`](../classes/Connection.md) \| `null`\>
+
+Defined in: [lib/ssh.ts:187](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L187)
+
+创建一个 SSH 连接
+
+## Parameters
+
+### opt
+
+`ConnectConfig` & [`IExtOptions`](../interfaces/IExtOptions.md)
+
+选项
+
+## Returns
+
+`Promise`\<[`Connection`](../classes/Connection.md) \| `null`\>

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

@@ -0,0 +1,19 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/ssh
+
+# lib/ssh
+
+## Classes
+
+- [Connection](classes/Connection.md)
+
+## Interfaces
+
+- [IExtOptions](interfaces/IExtOptions.md)
+
+## Functions
+
+- [get](functions/get.md)

package/doc/sc/api/lib/ssh/interfaces/IExtOptions.md

@@ -0,0 +1,33 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ssh](../index.md) / IExtOptions
+
+# Interface: IExtOptions
+
+Defined in: [lib/ssh.ts:13](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L13)
+
+## Properties
+
+### mproxy?
+
+> `optional` **mproxy**: `object`
+
+Defined in: [lib/ssh.ts:14](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L14)
+
+#### host
+
+> **host**: `string`
+
+#### password
+
+> **password**: `string`
+
+#### port
+
+> **port**: `number`
+
+#### username
+
+> **username**: `string`