Skip to content

Commit eff41e7

Browse files
authored
document state schema feature (#1236)
1 parent 234ffc6 commit eff41e7

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/reference/configuration.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,26 @@ gateways:
7474
database: <database>
7575
```
7676

77+
#### Configure State Schema Name
78+
79+
By default the schema name used to store state tables is `sqlmesh`. This can be configured by providing `state_schema` config property as
80+
part of the gateway configuration.
81+
82+
```yaml linenums="1"
83+
gateways:
84+
my_gateway:
85+
state_connection:
86+
type: postgres
87+
host: <host>
88+
port: <port>
89+
user: <username>
90+
password: <password>
91+
database: <database>
92+
state_schema: custom_name
93+
```
94+
95+
This would create all state tables in the schema name `custom_name`.
96+
7797
### Test connection
7898

7999
Configuration for a connection used when running unit tests. Default: a DuckDB connection that creates an in-memory database.

0 commit comments

Comments
 (0)