From e0906fbcca02660515757d45c3e489880464c003 Mon Sep 17 00:00:00 2001 From: alban bertolini Date: Wed, 29 Jul 2026 10:53:40 +0200 Subject: [PATCH] docs(forest-runtime): schema CREATE privilege + pin the agent version in npm info MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Review feedback: creating the dedicated schema needs database-level CREATE, so document the pre-created-schema fallback (the executor probes pg_namespace before creating, so schema-level privileges suffice then). Also query peerDependencies for the installed agent version — bare 'npm info' answers for latest, whose executor pin may differ. Co-Authored-By: Claude Fable 5 --- product/process/workflows/forest-runtime.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/product/process/workflows/forest-runtime.mdx b/product/process/workflows/forest-runtime.mdx index da7702e..c13a69b 100644 --- a/product/process/workflows/forest-runtime.mdx +++ b/product/process/workflows/forest-runtime.mdx @@ -52,7 +52,7 @@ Requirements: - **`@forestadmin/agent`** — embedded mode arrived in **1.84.0**, but the options shown below (`schema`, `ai`, `encryptionKey`, the tuning knobs) landed in later releases, so use a **recent** version. - **Node.js ≥ 22.12.0** — required by the executor package. -- **The executor package**, installed at the **exact version your agent pins**. It's an *optional peer dependency* the agent loads dynamically at runtime, so `tsc` won't flag it when it's missing — but `agent.start()` throws _"The embedded workflow executor requires the `@forestadmin/workflow-executor` package"_. The pin is exact (a `^` range conflicts), so install that specific version — find it in your lockfile or with `npm info @forestadmin/agent peerDependencies`: +- **The executor package**, installed at the **exact version your agent pins**. It's an *optional peer dependency* the agent loads dynamically at runtime, so `tsc` won't flag it when it's missing — but `agent.start()` throws _"The embedded workflow executor requires the `@forestadmin/workflow-executor` package"_. The pin is exact (a `^` range conflicts), so install that specific version — find it in your lockfile or with `npm info @forestadmin/agent@ peerDependencies` (pin the version you actually run — without it, npm answers for `latest`, whose pin may differ): ```bash npm install @forestadmin/workflow-executor@ ``` @@ -68,7 +68,9 @@ createAgent(options) ``` - Safe to reuse the database your agent already reads: the executor keeps its tables in a dedicated **`forest`** Postgres schema (it creates it if needed), so they stay out of the `public` schema your datasource introspects and never show up as collections in your panel. Pass a `schema` if you'd rather name it differently. + Safe to reuse the database your agent already reads: the executor keeps its tables in a dedicated **`forest`** Postgres schema, so they stay out of the `public` schema your datasource introspects and never show up as collections in your panel. Pass a `schema` if you'd rather name it differently. + + Creating that schema needs the `CREATE` privilege on the database. If your role doesn't have it, have an administrator create the schema and grant the role access to it — the executor checks whether the schema already exists before trying to create one, so a pre-created schema boots fine with schema-level privileges only. It inherits your agent's secrets and Forest connection, so you only configure: