Skip to content

Commit 90aedbd

Browse files
SME feedback
1 parent 8d13679 commit 90aedbd

4 files changed

Lines changed: 26 additions & 6 deletions

File tree

content/develop/ai/featureform/define-and-deploy-features.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,18 +111,32 @@ Use this before large changes or whenever the file might be incomplete relative
111111

112112
### Standard apply
113113

114-
Apply the file:
114+
Apply the file and wait for it to finish:
115115

116116
```bash
117117
ff apply \
118118
--workspace <workspace-id> \
119-
--file examples/featureform/docs/resources.py
119+
--file examples/featureform/docs/resources.py \
120+
--wait \
121+
--wait-for finished
122+
```
123+
124+
Without `--wait`, `ff apply` returns as soon as the server accepts the request and runs the job asynchronously. `--wait` blocks until the job reaches a target state: `--wait-for finished` waits for terminal success; `--wait-for running` returns as soon as the job is actively running.
125+
126+
If you skip `--wait`, the response includes a job ID. Check the job's status and per-task progress with:
127+
128+
```bash
129+
ff scheduler job get <job-id>
120130
```
121131

122132
### Apply modes
123133

124134
- **Default apply** replaces the workspace's current resource graph with the file.
125-
- **`--merge`** is safer for intentionally partial definition sets; resources omitted from the file aren't treated as deletions.
135+
- **`--merge`** applies a partial definition file without treating omitted resources as deletions.
136+
- **`--update`** is an advanced scheduler-backed mode that re-runs supported resources' normal update or incremental path, even when the graph definition is unchanged.
137+
- **`--full-rematerialize`** is an advanced scheduler-backed mode that forces full-refresh behavior on supported materialized resources.
138+
139+
Use only one of `--merge`, `--update`, or `--full-rematerialize` at a time. Support for `--update` and `--full-rematerialize` is resource-family dependent — run `--plan` first to inspect the planned job, and pair them with `--wait` to see the outcome.
126140

127141
## Verify the apply
128142

@@ -144,3 +158,5 @@ Common reasons:
144158
- **Secret can't be resolved.** A provider config uses a reference such as `env:PG_PASSWORD`, but the Feature Form server's environment doesn't expose that variable. Check the secret provider with `ff secret-provider get env --workspace <workspace-id>`.
145159
- **No resources to apply.** The entrypoint produced no resources. Make sure your file exports a `resources = [...]` list, or that auto-registration finds the resources you declared.
146160
- **Validation error.** The CLI prints the specific resource and field that failed; fix the file and re-run with `--plan`.
161+
162+
For more detail, re-run with `--verbose` to enable debug logging to stderr. For most failures, though, the apply job itself surfaces clearer errors than the debug log — let `--wait` finish, or run `ff scheduler job get <job-id>`, before reaching for `--verbose`.

content/develop/ai/featureform/quickstart.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@ That file defines:
5353
```bash
5454
ff apply \
5555
--workspace <workspace-id> \
56-
--file examples/featureform/docs/resources.py
56+
--file examples/featureform/docs/resources.py \
57+
--wait \
58+
--wait-for finished
5759
```
5860

5961
For a dry run first:
@@ -84,4 +86,3 @@ client = ff.Client(host="127.0.0.1:9090", insecure=True, workspace="<workspace>"
8486
features = client.serve("demo_customer_feature_view", entity="C1001")
8587
print(features)
8688
```
87-

content/develop/ai/featureform/reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ CLI behavior:
111111
- `--output`, `-o`
112112
- `--config`
113113
- `--no-color`
114+
- `--verbose`, `-v`
114115
- `--skip-version-check`
115116

116117
### Top-level commands

content/develop/ai/featureform/update-features.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ Then apply:
2828
```bash
2929
ff apply \
3030
--workspace <workspace-id> \
31-
--file examples/featureform/docs/resources.py
31+
--file examples/featureform/docs/resources.py \
32+
--wait \
33+
--wait-for finished
3234
```
3335

3436
## When to use `--merge`

0 commit comments

Comments
 (0)