160 lines
3.3 KiB
Markdown
160 lines
3.3 KiB
Markdown
---
|
|
title: danog\MadelineProto\Db\RedisArray: Redis database backend.
|
|
description:
|
|
|
|
---
|
|
# `danog\MadelineProto\Db\RedisArray`
|
|
[Back to index](../../../index.md)
|
|
|
|
> Author: Daniil Gentili <daniil@daniil.it>
|
|
|
|
|
|
Redis database backend.
|
|
|
|
|
|
|
|
|
|
## Method list:
|
|
* `initStartup(): \Generator`
|
|
* `initConnection(\danog\MadelineProto\Settings\Database\Redis $settings): \Generator`
|
|
* `offsetSet(string $index, $value)`
|
|
* `isset( $key): \Promise<bool> true if the offset exists, otherwise false`
|
|
* `offsetUnset(string $index): \Amp\Promise`
|
|
* `getArrayCopy(): \Amp\Promise<array>`
|
|
* `count(): \Promise<int> The number of elements or public properties in the associated
|
|
array or object, respectively.`
|
|
* `getInstance(string $table, \danog\MadelineProto\Db\DbArray|array|null $value, \danog\MadelineProto\Settings\Database\DatabaseAbstract $settings): \Amp\Promise`
|
|
|
|
## Methods:
|
|
### `initStartup(): \Generator`
|
|
|
|
Initialize on startup.
|
|
|
|
|
|
#### See also:
|
|
* `\Generator`
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `initConnection(\danog\MadelineProto\Settings\Database\Redis $settings): \Generator`
|
|
|
|
Initialize connection.
|
|
|
|
|
|
Parameters:
|
|
* `$settings`: `\danog\MadelineProto\Settings\Database\Redis`
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Database\Redis`: Redis backend settings.](../Settings/Database/Redis.md)
|
|
* `\Generator`
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `offsetSet(string $index, $value)`
|
|
|
|
Set value for an offset.
|
|
|
|
|
|
Parameters:
|
|
* `$index`: `string` <p>
|
|
The index to set for.
|
|
</p>
|
|
* `$value`: ``
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `isset( $key): \Promise<bool> true if the offset exists, otherwise false`
|
|
|
|
Check if key isset.
|
|
|
|
|
|
Parameters:
|
|
* `$key`: ``
|
|
|
|
|
|
Return value: true if the offset exists, otherwise false
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `offsetUnset(string $index): \Amp\Promise`
|
|
|
|
Unset value for an offset.
|
|
|
|
|
|
Parameters:
|
|
* `$index`: `string` <p>
|
|
The offset to unset.
|
|
</p>
|
|
|
|
|
|
#### See also:
|
|
* `\Amp\Promise`
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getArrayCopy(): \Amp\Promise<array>`
|
|
|
|
Get array copy.
|
|
|
|
|
|
#### See also:
|
|
* `\Amp\Promise`
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `count(): \Promise<int> The number of elements or public properties in the associated
|
|
array or object, respectively.`
|
|
|
|
Count elements.
|
|
|
|
|
|
Return value: The number of elements or public properties in the associated
|
|
array or object, respectively.
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getInstance(string $table, \danog\MadelineProto\Db\DbArray|array|null $value, \danog\MadelineProto\Settings\Database\DatabaseAbstract $settings): \Amp\Promise`
|
|
|
|
|
|
|
|
|
|
Parameters:
|
|
* `$table`: `string`
|
|
* `$value`: `\danog\MadelineProto\Db\DbArray|array|null`
|
|
* `$settings`: `\danog\MadelineProto\Settings\Database\DatabaseAbstract`
|
|
|
|
|
|
Fully typed return value:
|
|
```
|
|
\Amp\Promise<static>
|
|
```
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Db\DbArray`: DB array interface.](./DbArray.md)
|
|
* [`\danog\MadelineProto\Settings\Database\DatabaseAbstract`: Base class for database backends.](../Settings/Database/DatabaseAbstract.md)
|
|
* `\Amp\Promise`
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|