Using the Snowpark XML RowTag Reader¶

You can activate the Snowpark XML RowTag Reader by specifying .option("rowTag", "<rowtag>") in session.read.option("rowTag", "<rowtag>").xml(). Instead of loading the entire document as a single object, this mode splits the file based on the specified rowTag, loads each matching element as a separate row, and splits each row into multiple columns in a Snowpark DataFrame. The Reader is especially useful for processing only selective elements in XML files or ingesting large XML files in a scalable, Snowpark-native way.

例¶

This sample XML is an example:

<library>
    <book id="1">
        <title>The Art of Snowflake</title>
        <author>Jane Doe</author>
        <price>29.99</price>
        <reviews>
            <review>
                <user>tech_guru_87</user>
                <rating>5</rating>
                <comment>Very insightful and practical.</comment>
            </review>
            <review>
                <user>datawizard</user>
                <rating>4</rating>
                <comment>Great read for data engineers.</comment>
            </review>
        </reviews>
        <editions>
            <edition year="2023" format="Hardcover"/>
            <edition year="2024" format="eBook"/>
        </editions>
    </book>

    <book id="2">
        <title>XML for Data Engineers</title>
        <author>John Smith</author>
        <price>35.50</price>
        <reviews>
            <review>
                <user>xml_master</user>
                <rating>5</rating>
                <comment>Perfect for mastering XML parsing.</comment>
            </review>
        </reviews>
        <editions>
            <edition year="2022" format="Paperback"/>
        </editions>
    </book>
</library>

Snowparkスクリプト¶

df = session.read.option("rowTag", "book").xml("@mystage/books.xml")

これにより、XML ファイルの各 <book> 要素が独自の行にロードされ、子要素（例: <title> および <author>）が VARIANT タイプの列として自動的に抽出されます。

出力¶


`_id`	`author`	`editions`	`price`	`reviews`	`title`
"2"	"John Smith"	`{ "edition": { "_format": "Paperback", "_year": "2022" } }`	"35.50"	`{ "review": { "comment": "Perfect for mastering XML parsing.", "rating": "5", "user": "xml_master" } }`	"XML for Data Engineers"
"1"	"Jane Doe"	`{ "edition": [ { "_format": "Hardcover", "_year": "2023" }, { "_format": "eBook", "_year": "2024" } ] }`	"29.99"	`{ "review": [ { "comment": "Very insightful and practical.", "rating": "5", "user": "tech_guru_87" }, { "comment": "Great read for data engineers.", "rating": "4", "user": "datawizard" } ] }`	"The Art of Snowflake"

rowTag によって識別される各 XML 要素が1行になります。
そのタグ内の各サブ要素は列になり、VARIANT として保存されます。ネストされた要素はネストされた VARIANT データとしてキャプチャされます。
The resulting DataFrame is flattened and columnized and behaves like any other Snowpark DataFrame.

はじめるにあたり¶

Snowpark Pythonパッケージをインストールします。
```
pip install snowflake-snowpark-python
```
Snowflakeステージに XML ファイルをアップロードします。
```
PUT file:///path/to/books.xml @mystage;
```
Snowparkを使用して XML ファイルを読み取ります。
```
df = session.read.option("rowTag", "book").xml("@mystage/books.xml")
```
DataFrame メソッドを使用して変換または保存します。
```
df.select(col("`title`"), col("`author`")).show()
df.write.save_as_table("books_table")
```

サポート対象のオプション¶

rowTag （必須）:行として抽出する XML 要素の名前。
:code:`rowValidationXSDPath`（オプション）:ロード中にrowTagフラグメントを検証するために使用される XSD へのステージパス。
mode`（オプション）:検証なしのデフォルトの動作ロード。:code:`rowValidationXSDPath が次に設定されている場合:
- PERMISSIVE: Quarantines invalid rows in _corrupt_record; loads the rest.
- FAILFAST: Stops at the first invalid row and raises an error.

XML オプションの詳細については、snowflake.snowpark.DataFrameReader.xml をご参照ください。

Validate XML using XSD¶

To validate each rowTag fragment against an XSD during load, set the XSD path and choose a validation mode:

df = (
session.read
    .option("rowTag", "book")
    .option("rowValidationXSDPath", "@mystage/schema.xsd")  # validates each row element
    .option("mode", "PERMISSIVE")                         # or "FAILFAST"
    .xml("@mystage/books.xml")
)

PERMISSIVE: Invalid rows are quarantined in a special _corrupt_record column; valid rows load normally.

To persist the result, write the DataFrame to a table with df.write.save_as_table("<table_name>"). The table will include all parsed columns plus an extra _corrupt_record column: it is NULL for valid rows and contains the full XML records for invalid rows (with the other columns showing NULL).
+-------------------+ | _corrupt_record | | <book id="1"> ... | | <book id="2"> ... | +-------------------+

FAILFAST:読み取りは最初の行で停止し、エラーを返します。

制限事項¶

Snowpark XMLRowTag リーダーには次の制限があります:

スキーマを推測せず、出力列はすべて VARIANT の型です。
Only supports files stored in Snowflake stages; local files are not supported.
Snowpark Pythonライブラリでのみ利用可能です。