> For the complete documentation index, see [llms.txt](https://docs.neuron-ai.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.neuron-ai.dev/neuron-v3-zh/gong-zuo-liu/persistence.md).

# 持久化

在多次执行之间持久化工作流状态。

当我们在 Neuron 中谈论持久化时，我们指的是系统在任何时刻捕获并保留正在运行的工作流完整状态的能力。

可以把它看作一个复杂的“游戏存档”功能，不过是用于业务流程的。在任何时刻，当节点请求中断时，Neuron 会创建工作流状态的快照，并将其存储到持久化层中。之后，无论是几秒、几小时还是几周，工作流都可以恢复到它离开时的精确位置，并像什么都没发生过一样继续运行。

像 Neuron 中通常一样，工作流持久化层建立在一个通用接口之上，因此它是可扩展且可互换的。下面是支持的持久化层。

### InMemoryPersistence

它只在当前执行周期中将数据保存在内存里。

```php
use NeuronAI\Workflow\Persistence\InMemoryPersistence;
use NeuronAI\Workflow\Persistence\PersistenceInterface;

class MyWorkflow extends Workflow
{
    ...
    
    protected function persistence(): PersistenceInterface
    {
        return new InMemoryPersistence();
    }
}
```

### FilePersistence

它会将工作流数据和状态存储到本地文件中。

```php
use NeuronAI\Workflow\Persistence\FilePersistence;
use NeuronAI\Workflow\Persistence\PersistenceInterface;

class MyWorkflow extends Workflow
{
    ...
    
    protected function persistence(): PersistenceInterface
    {
        return new FilePersistence(__DIR__);
    }
}
```

### RedisPersistence（*推荐*)

使用 Redis，或兼容 Redis 的数据存储，来持久化临时的工作流执行数据。

{% hint style="warning" %}
该组件要求你安装 PHP Redis 扩展 [`phpredis`](https://github.com/phpredis/phpredis) 到你的系统中。
{% endhint %}

```php
use NeuronAI\Workflow\Persistence\RedisPersistence;
use NeuronAI\Workflow\Persistence\PersistenceInterface;

class MyWorkflow extends Workflow
{
    ...
    
    protected function persistence(): PersistenceInterface
    {
        return new RedisPersistence(
            client: new Redis(...)
        );
    }
}
```

### DatabasePersistence

要将数据库中的工作流中断持久化，你需要传入一个 `PDO` 实例。如果你在某个框架之上开发，你可以像获取 [SQLChatHistory](https://docs.neuron-ai.dev/neuron-v3-zh/dai-li/chat-history-and-memory.md#sqlchathistory) 用于聊天历史持久化时那样，从 ORM 中轻松获取它。

```php
use NeuronAI\Workflow\Persistence\DatabasePersistence;
use NeuronAI\Workflow\Persistence\PersistenceInterface;

class MyWorkflow extends Workflow
{
    ...
    
    protected function persistence(): PersistenceInterface
    {
        return new DatabasePersistence(
            pdo: new \PDO(...)
        );
    }
}
```

以下是创建该表的 SQL 脚本：

{% tabs %}
{% tab title="MySQL/MariaDB" %}

```sql
CREATE TABLE workflow_store (
    `partition` VARCHAR(255) NOT NULL,
    `key`       VARCHAR(255) NOT NULL,
    `value`     TEXT NOT NULL,
    created_at  TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    updated_at  TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`partition`, `key`)
);
```

{% endtab %}

{% tab title="PostgreSQL/SQLite" %}

```sql
CREATE TABLE workflow_store (
    "partition" VARCHAR(255) NOT NULL,
    "key"       VARCHAR(255) NOT NULL,
    "value"     TEXT NOT NULL,
    created_at  TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    updated_at  TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    PRIMARY KEY ("partition", "key")
);
```

{% endtab %}
{% endtabs %}

### EloquentPersistence

你应该创建自己的 Eloquent 模型，并将类字符串作为构造函数参数传入。该模型可以具有自定义关系、作用域、属性等，但基本结构必须基于此迁移脚本：

```bash
php artisan make:migration create_workflow_interrupts_table --create=workflow_interrupts
```

```php
Schema::create('workflow_store', function (Blueprint $table) {
    $table->id();
    $table->string('partition');
    $table->string('key');
    $table->longText('value');
    $table->timestamps();
    
    $table->unique(['partition', 'key']);
});
```

#### WorkflowInterrupt 模型

这是所需的最小结构：

```php
class WorkflowStep extends Model
{
    protected $fillable = ['partition', 'key', 'value'];
}
```

在工作流中使用它：

```php
use App\Models\WorkflowInterrupt;
use NeuronAI\Workflow\Persistence\EloquentPersistence;
use NeuronAI\Workflow\Persistence\PersistenceInterface;

class MyWorkflow extends Workflow
{
    ...
    
    protected function persistence(): PersistenceInterface
    {
        return new EloquentPersistence(WorkflowInterrupt::class);
    }
}
```
