dataform icon indicating copy to clipboard operation
dataform copied to clipboard

Feature Request: Support onSchemaChange in Dataform CLI

Open BenJackGill opened this issue 2 months ago • 3 comments

As noted in your documentation, the onSchemaChange option isn’t currently supported in the Dataform CLI.

We rely almost entirely on the CLI for development and rarely use the BigQuery UI, so it’s disappointing that this feature isn’t available there yet.

Adding support would greatly improve workflow parity and automation.

BenJackGill avatar Nov 04 '25 06:11 BenJackGill

I have noticed that it does not throw a runtime error when using the cli with this option. I personally am using the Dataform api to execute the current file from local development environment to make use of this feature.

ashish10alex avatar Nov 04 '25 09:11 ashish10alex

It may not throw a runtime error but it ignores the onSchemaChange setting in config.

I just tested with onSchemaChange: "SYNCHRONIZE" and I get errors like bigquery error: Query error: Name test_col not found inside S at [93:345]. During that test the SYNCHRONIZE setting was supposed to remove the test_col column, but instead I got the error.

BenJackGill avatar Nov 08 '25 04:11 BenJackGill

Yes, this is only supported for the GCP Dataform and we don't have ETA for the Dataform CLI support.

@Tuseeq1, it makes sense to throw an error that this is not supported in the CLI to avoid confusion.

kolina avatar Nov 09 '25 19:11 kolina