@isdk/kvsqlite
Version:
SQlite(>=3.45.0) key/value Document store
300 lines (150 loc) • 6.41 kB
Markdown
[**/kvsqlite**](../README.md)
***
[/kvsqlite](../globals.md) / KVSqliteAttachments
# Class: KVSqliteAttachments
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2081](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2081)
## Constructors
### new KVSqliteAttachments()
> **new KVSqliteAttachments**(`name`, `db`): [`KVSqliteAttachments`](KVSqliteAttachments.md)
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2096](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2096)
#### Parameters
##### name
`string`
##### db
[`KVSqlite`](KVSqlite.md)
#### Returns
[`KVSqliteAttachments`](KVSqliteAttachments.md)
## Properties
### db
> `protected` **db**: [`KVSqlite`](KVSqlite.md)
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2096](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2096)
***
### name
> **name**: `string`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2096](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2096)
***
### preAdd
> **preAdd**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2082](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2082)
***
### preAll
> **preAll**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2092](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2092)
***
### preAllLimit
> **preAllLimit**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2093](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2093)
***
### preCalcSize
> **preCalcSize**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2094](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2094)
***
### preCount
> **preCount**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2088](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2088)
***
### preCountW
> **preCountW**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2089](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2089)
***
### preDel
> **preDel**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2086](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2086)
***
### preDelAll
> **preDelAll**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2087](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2087)
***
### preExists
> **preExists**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2084](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2084)
***
### preGet
> **preGet**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2085](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2085)
***
### preSearchKey
> **preSearchKey**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2090](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2090)
***
### preSearchKeyAll
> **preSearchKeyAll**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2091](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2091)
***
### preUpdate
> **preUpdate**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2083](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2083)
## Methods
### add()
> **add**(`docId`, `filename`, `content`, `options`): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2143](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2143)
#### Parameters
##### docId
[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)
##### filename
`string`
##### content
`Buffer`
##### options
###### isText?
`boolean`
###### mime?
`string`
#### Returns
[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)
***
### del()
> **del**(`docId`, `filename`?): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md) \| [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2186](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2186)
#### Parameters
##### docId
[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)
##### filename?
`string` | `string`[]
#### Returns
[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md) \| [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]
***
### get()
> **get**(`docId`, `filename`): `object`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2134](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2134)
Get file content
#### Parameters
##### docId
[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)
##### filename
`string`
#### Returns
`object`
##### content
> **content**: `Buffer`
##### filename
> **filename**: `string`
***
### list()
> **list**(`docId`, `filename`): `unknown`[]
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2139](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2139)
#### Parameters
##### docId
[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)
##### filename
`string` = `''`
#### Returns
`unknown`[]
***
### update()
> **update**(`docId`, `filename`, `content`, `options`): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2160](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L2160)
#### Parameters
##### docId
[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)
##### filename
`string`
##### content
`Buffer`
##### options
###### isText?
`boolean`
###### mime?
`string`
#### Returns
[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)