Secure 5.2.1: alterStageFileFormat

alterStageFileFormat

Last updated: July 13, 2026

Modifies the file format configuration of an existing stage in Snowflake.

Note: This change type does not support automatic rollback.

Available attributes

Attribute	Type	Description	Required
`catalogName`	String	Name of the catalog (database) containing the stage	No
`schemaName`	String	Name of the schema containing the stage	No
`stageName`	String	Name of the stage to alter	Yes
`ifExists`	Boolean	Don't error if the stage doesn't exist	No
`fileFormat`	Nested	New file format configuration	Yes

fileFormat attributes

New file format configuration (nested element):

Attribute	Type	Description
`fileFormatName`	String	Reference to named file format
`fileFormatType`	String	Type: `CSV`, `JSON`, `AVRO`, `ORC`, `PARQUET`, `XML`, `CUSTOM`
`formatTypeOptions`	MapWrapper	Type-specific options (e.g., `SKIP_HEADER`, `COMPRESSION`)

<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
        xmlns:pro-snowflake="http://www.liquibase.org/xml/ns/pro-snowflake"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
        http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd
        http://www.liquibase.org/xml/ns/pro-snowflake
        http://www.liquibase.org/xml/ns/pro-snowflake/liquibase-pro-snowflake-latest.xsd">

    <!-- Change file format type options -->
    <changeSet id="alter-stage-file-format" author="examples">
        <pro-snowflake:alterStageFileFormat stageName="DATA_STAGE">
            <pro-snowflake:fileFormat fileFormatType="CSV">
                <pro-snowflake:formatTypeOptions>
                    <pro-snowflake:entry key="SKIP_HEADER" value="1"/>
                    <pro-snowflake:entry key="COMPRESSION" value="AUTO"/>
                </pro-snowflake:formatTypeOptions>
            </pro-snowflake:fileFormat>
        </pro-snowflake:alterStageFileFormat>
    </changeSet>

    <!-- Change to a named file format -->
    <changeSet id="alter-stage-named-format" author="examples">
        <pro-snowflake:alterStageFileFormat stageName="DATA_STAGE" ifExists="true">
            <pro-snowflake:fileFormat fileFormatName="MY_CSV_FORMAT"/>
        </pro-snowflake:alterStageFileFormat>
    </changeSet>

    <!-- Change to JSON format -->
    <changeSet id="alter-stage-json-format" author="examples">
        <pro-snowflake:alterStageFileFormat stageName="DATA_STAGE">
            <pro-snowflake:fileFormat fileFormatType="JSON">
                <pro-snowflake:formatTypeOptions>
                    <pro-snowflake:entry key="STRIP_OUTER_ARRAY" value="TRUE"/>
                </pro-snowflake:formatTypeOptions>
            </pro-snowflake:fileFormat>
        </pro-snowflake:alterStageFileFormat>
    </changeSet>

</databaseChangeLog>

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "alter-stage-file-format",
        "author": "examples",
        "changes": [
          {
            "alterStageFileFormat": {
              "stageName": "DATA_STAGE",
              "fileFormat": {
                "fileFormatType": "CSV",
                "formatTypeOptions": {
                  "entries": [
                    {
                      "entry": {
                        "key": "SKIP_HEADER",
                        "value": "1"
                      }
                    },
                    {
                      "entry": {
                        "key": "COMPRESSION",
                        "value": "AUTO"
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "alter-stage-named-format",
        "author": "examples",
        "changes": [
          {
            "alterStageFileFormat": {
              "stageName": "DATA_STAGE",
              "ifExists": true,
              "fileFormat": {
                "fileFormatName": "MY_CSV_FORMAT"
              }
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "alter-stage-json-format",
        "author": "examples",
        "changes": [
          {
            "alterStageFileFormat": {
              "stageName": "DATA_STAGE",
              "fileFormat": {
                "fileFormatType": "JSON",
                "formatTypeOptions": {
                  "entries": [
                    {
                      "entry": {
                        "key": "STRIP_OUTER_ARRAY",
                        "value": "TRUE"
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  ]
}

databaseChangeLog:
  # Change file format type options
  - changeSet:
      id: alter-stage-file-format
      author: examples
      changes:
        - alterStageFileFormat:
            stageName: DATA_STAGE
            fileFormat:
              fileFormatType: CSV
              formatTypeOptions:
                entries:
                  - entry:
                      key: SKIP_HEADER
                      value: "1"
                  - entry:
                      key: COMPRESSION
                      value: AUTO

  # Change to a named file format
  - changeSet:
      id: alter-stage-named-format
      author: examples
      changes:
        - alterStageFileFormat:
            stageName: DATA_STAGE
            ifExists: true
            fileFormat:
              fileFormatName: MY_CSV_FORMAT

  # Change to JSON format
  - changeSet:
      id: alter-stage-json-format
      author: examples
      changes:
        - alterStageFileFormat:
            stageName: DATA_STAGE
            fileFormat:
              fileFormatType: JSON
              formatTypeOptions:
                entries:
                  - entry:
                      key: STRIP_OUTER_ARRAY
                      value: "TRUE"

--liquibase formatted sql

--changeset examples:change-file-format-type-options
-- Change file format type options
ALTER STAGE PUBLIC.DATA_STAGE SET FILE_FORMAT = (TYPE = CSV SKIP_HEADER = 1 COMPRESSION = 'AUTO');

--changeset examples:change-to-a-named-file-format
-- Change to a named file format
ALTER STAGE IF EXISTS PUBLIC.DATA_STAGE SET FILE_FORMAT = (FORMAT_NAME = MY_CSV_FORMAT);

--changeset examples:change-to-json-format
-- Change to JSON format
ALTER STAGE PUBLIC.DATA_STAGE SET FILE_FORMAT = (TYPE = JSON STRIP_OUTER_ARRAY = TRUE);

<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
        xmlns:pro-snowflake="http://www.liquibase.org/xml/ns/pro-snowflake"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
        http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd
        http://www.liquibase.org/xml/ns/pro-snowflake
        http://www.liquibase.org/xml/ns/pro-snowflake/liquibase-pro-snowflake-latest.xsd">

    <!-- Change file format type options -->
    <changeSet id="alter-stage-file-format" author="examples">
        <pro-snowflake:alterStageFileFormat stageName="DATA_STAGE">
            <pro-snowflake:fileFormat fileFormatType="CSV">
                <pro-snowflake:formatTypeOptions>
                    <pro-snowflake:entry key="SKIP_HEADER" value="1"/>
                    <pro-snowflake:entry key="COMPRESSION" value="AUTO"/>
                </pro-snowflake:formatTypeOptions>
            </pro-snowflake:fileFormat>
        </pro-snowflake:alterStageFileFormat>
    </changeSet>

    <!-- Change to a named file format -->
    <changeSet id="alter-stage-named-format" author="examples">
        <pro-snowflake:alterStageFileFormat stageName="DATA_STAGE" ifExists="true">
            <pro-snowflake:fileFormat fileFormatName="MY_CSV_FORMAT"/>
        </pro-snowflake:alterStageFileFormat>
    </changeSet>

    <!-- Change to JSON format -->
    <changeSet id="alter-stage-json-format" author="examples">
        <pro-snowflake:alterStageFileFormat stageName="DATA_STAGE">
            <pro-snowflake:fileFormat fileFormatType="JSON">
                <pro-snowflake:formatTypeOptions>
                    <pro-snowflake:entry key="STRIP_OUTER_ARRAY" value="TRUE"/>
                </pro-snowflake:formatTypeOptions>
            </pro-snowflake:fileFormat>
        </pro-snowflake:alterStageFileFormat>
    </changeSet>

</databaseChangeLog>

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "alter-stage-file-format",
        "author": "examples",
        "changes": [
          {
            "alterStageFileFormat": {
              "stageName": "DATA_STAGE",
              "fileFormat": {
                "fileFormatType": "CSV",
                "formatTypeOptions": {
                  "entries": [
                    {
                      "entry": {
                        "key": "SKIP_HEADER",
                        "value": "1"
                      }
                    },
                    {
                      "entry": {
                        "key": "COMPRESSION",
                        "value": "AUTO"
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "alter-stage-named-format",
        "author": "examples",
        "changes": [
          {
            "alterStageFileFormat": {
              "stageName": "DATA_STAGE",
              "ifExists": true,
              "fileFormat": {
                "fileFormatName": "MY_CSV_FORMAT"
              }
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "alter-stage-json-format",
        "author": "examples",
        "changes": [
          {
            "alterStageFileFormat": {
              "stageName": "DATA_STAGE",
              "fileFormat": {
                "fileFormatType": "JSON",
                "formatTypeOptions": {
                  "entries": [
                    {
                      "entry": {
                        "key": "STRIP_OUTER_ARRAY",
                        "value": "TRUE"
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  ]
}

databaseChangeLog:
  # Change file format type options
  - changeSet:
      id: alter-stage-file-format
      author: examples
      changes:
        - alterStageFileFormat:
            stageName: DATA_STAGE
            fileFormat:
              fileFormatType: CSV
              formatTypeOptions:
                entries:
                  - entry:
                      key: SKIP_HEADER
                      value: "1"
                  - entry:
                      key: COMPRESSION
                      value: AUTO

  # Change to a named file format
  - changeSet:
      id: alter-stage-named-format
      author: examples
      changes:
        - alterStageFileFormat:
            stageName: DATA_STAGE
            ifExists: true
            fileFormat:
              fileFormatName: MY_CSV_FORMAT

  # Change to JSON format
  - changeSet:
      id: alter-stage-json-format
      author: examples
      changes:
        - alterStageFileFormat:
            stageName: DATA_STAGE
            fileFormat:
              fileFormatType: JSON
              formatTypeOptions:
                entries:
                  - entry:
                      key: STRIP_OUTER_ARRAY
                      value: "TRUE"

--liquibase formatted sql

--changeset examples:change-file-format-type-options
-- Change file format type options
ALTER STAGE PUBLIC.DATA_STAGE SET FILE_FORMAT = (TYPE = CSV SKIP_HEADER = 1 COMPRESSION = 'AUTO');

--changeset examples:change-to-a-named-file-format
-- Change to a named file format
ALTER STAGE IF EXISTS PUBLIC.DATA_STAGE SET FILE_FORMAT = (FORMAT_NAME = MY_CSV_FORMAT);

--changeset examples:change-to-json-format
-- Change to JSON format
ALTER STAGE PUBLIC.DATA_STAGE SET FILE_FORMAT = (TYPE = JSON STRIP_OUTER_ARRAY = TRUE);

alterStageFileFormat

Available attributes

fileFormat attributes

XML

JSON

YAML

SQL

More like this